Interface WriterOptions

Writer options for writing barcodes.

interface WriterOptions {
    ecLevel?: EcLevel;
    forceSquareDataMatrix?: boolean;
    format?: WriteInputBarcodeFormat;
    readerInit?: boolean;
    rotate?: number;
    scale?: number;
    sizeHint?: number;
    withHRT?: boolean;
    withQuietZones?: boolean;
}

Hierarchy

  • Partial<Omit<ZXingWriterOptions, "format">>
    • WriterOptions

Properties

ecLevel? forceSquareDataMatrix? format? readerInit? rotate? scale? sizeHint? withHRT? withQuietZones?

Properties

OptionalecLevel

ecLevel?: EcLevel

The error correction level of the symbol (empty string if not applicable)

See

ReadResult.ecLevel

Default Value

""

OptionalforceSquareDataMatrix

forceSquareDataMatrix?: boolean

Force the Data Matrix to be square.

Default Value

false

Optionalformat

format?: WriteInputBarcodeFormat

The format of the barcode to write.

Supported values are: "Aztec", "Codabar", "Code39", "Code93", "Code128", "DataBar", "DataBarExpanded", "DataBarLimited", "DataMatrix", "DXFilmEdge", "EAN-8", "EAN-13", "ITF", "MaxiCode", "MicroQRCode", "PDF417", "QRCode", "rMQRCode", "UPC-A", "UPC-E"

Default Value

"QRCode"

OptionalreaderInit

readerInit?: boolean

Set if this is the reader initialisation / programming symbol.

See

ReadResult.readerInit

Default Value

false

Optionalrotate

rotate?: number

The rotation of the barcode in degrees. Valid values are 0, 90, 180 and 270.

Default Value

0

Optionalscale

scale?: number

The scale of the barcode. 0 means unset.

Default Value

0

OptionalsizeHint

sizeHint?: number

A size hint to determine the scale of the barcode. 0 means unset.

This only takes effect if scale is unset.

Default Value

0

OptionalwithHRT

withHRT?: boolean

Include human readable text (HRT) in the barcode.

Default Value

false

OptionalwithQuietZones

withQuietZones?: boolean

Add compliant quiet zones to the barcode.

EAN-13, ITF, UPC-A and UPC-E have compliant quiet zones added by default.

Default Value

true

Settings

Member Visibility

On This Page

Properties