Interface WriterOptions

Writer options for writing barcodes.

interface WriterOptions {
    characterSet?: "Unknown" | "ASCII" | "ISO8859_1" | "ISO8859_2" | "ISO8859_3" | "ISO8859_4" | "ISO8859_5" | "ISO8859_6" | "ISO8859_7" | "ISO8859_8" | "ISO8859_9" | "ISO8859_10" | "ISO8859_11" | "ISO8859_13" | "ISO8859_14" | "ISO8859_15" | "ISO8859_16" | "Cp437" | "Cp1250" | "Cp1251" | "Cp1252" | "Cp1256" | "Shift_JIS" | "Big5" | "GB2312" | "GB18030" | "EUC_JP" | "EUC_KR" | "UTF16BE" | "UTF8" | "UTF16LE" | "UTF32BE" | "UTF32LE" | "BINARY";
    eccLevel?: 0 | 1 | 2 | 4 | 6 | 3 | -1 | 5 | 7 | 8;
    format?: WriteInputBarcodeFormat;
    height?: number;
    margin?: number;
    width?: number;
}

Hierarchy

  • Partial<Omit<ZXingWriterOptions, "format" | "characterSet" | "eccLevel">>
    • WriterOptions

Properties

characterSet? eccLevel? format? height? margin? width?

Properties

Optional characterSet

characterSet?: "Unknown" | "ASCII" | "ISO8859_1" | "ISO8859_2" | "ISO8859_3" | "ISO8859_4" | "ISO8859_5" | "ISO8859_6" | "ISO8859_7" | "ISO8859_8" | "ISO8859_9" | "ISO8859_10" | "ISO8859_11" | "ISO8859_13" | "ISO8859_14" | "ISO8859_15" | "ISO8859_16" | "Cp437" | "Cp1250" | "Cp1251" | "Cp1252" | "Cp1256" | "Shift_JIS" | "Big5" | "GB2312" | "GB18030" | "EUC_JP" | "EUC_KR" | "UTF16BE" | "UTF8" | "UTF16LE" | "UTF32BE" | "UTF32LE" | "BINARY"

Character set to use for encoding the text. Used for Aztec, PDF417, and QRCode only.

Default Value

"UTF8"

Optional eccLevel

eccLevel?: 0 | 1 | 2 | 4 | 6 | 3 | -1 | 5 | 7 | 8

Error correction level of the symbol. Used for Aztec, PDF417, and QRCode only. -1 means auto.

Default Value

-1

Optional format

format?: WriteInputBarcodeFormat

The format of the barcode to write.

Supported values are: "Aztec", "Codabar", "Code128", "Code39", "Code93", "DataMatrix", "EAN-13", "EAN-8", "ITF", "PDF417", "QRCode", "UPC-A", "UPC-E"

Default Value

"QRCode"

Optional height

height?: number

Height of the barcode.

Default Value

200

Optional margin

margin?: number

The minimum number of quiet zone pixels.

Default Value

10

Optional width

width?: number

Width of the barcode.

Default Value

200

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc