@schie/fluent-zpl - v0.11.2
    Preparing search index...

    Interface BarcodeOpts

    Options for barcode fields on the label.

    This interface defines the configuration options for adding a barcode to a label:

    • at: Specifies the x and y coordinates for the barcode position.
    • type: The type of barcode to print.
    • data: The data string to encode in the barcode.
    • height: Optional height of the barcode.
    • module: Optional module width for the barcode.
    • ratio: Optional module width ratio for the ^BY command.
    • rotate: Optional orientation of the barcode (N, R, I, B).
    • code128Mode: Optional Code 128 mode (N, U, A, D) to control GS1/auto behavior.

    QR Code specific options (only used when type is QRCode):

    • qrErrorCorrection: Error correction level for QR codes.
    • qrMask: Mask pattern for QR codes (0-7).
    • qrModel: QR model (1 or 2).
    interface BarcodeOpts {
        at: Position;
        checkDigit?: boolean;
        code128Mode?: Code128Mode;
        data: string;
        dataMatrixQuality?: number;
        height?: number;
        hexIndicator?: string;
        line?: boolean;
        lineAbove?: boolean;
        module?: number;
        pdf417Columns?: number;
        pdf417Rows?: number;
        pdf417SecurityLevel?: number;
        pdf417Truncate?: boolean;
        qrErrorCorrection?: QRErrorCorrection;
        qrMask?: number;
        qrModel?: 1 | 2;
        ratio?: number;
        rotate?: Orientation;
        type: Barcode;
    }
    Index

    Properties

    at checkDigit? code128Mode? data dataMatrixQuality? height? hexIndicator? line? lineAbove? module? pdf417Columns? pdf417Rows? pdf417SecurityLevel? pdf417Truncate? qrErrorCorrection? qrMask? qrModel? ratio? rotate? type

    Properties

    at: Position
    checkDigit?: boolean

    Whether to print or calculate a check digit when supported (defaults to false).

    code128Mode?: Code128Mode

    Code 128 mode flag for ^BC (only for Code128 type)

    data: string
    dataMatrixQuality?: number

    DataMatrix: quality setting (1-99999, default 200).

    height?: number
    hexIndicator?: string

    Optional ^FH hex indicator for embedding hex escapes inside the field data.

    line?: boolean

    Whether to print the human-readable interpretation line (defaults to true for linear barcodes).

    lineAbove?: boolean

    Whether to print the interpretation line above the barcode (defaults to false; Code128 mode U defaults to true).

    module?: number
    pdf417Columns?: number

    PDF417: number of columns (1-30, default 3).

    pdf417Rows?: number

    PDF417: number of rows (3-90, default 3).

    pdf417SecurityLevel?: number

    PDF417: security level (0-8, default 0 = auto).

    pdf417Truncate?: boolean

    PDF417: truncate right row indicator to reduce width (default false).

    qrErrorCorrection?: QRErrorCorrection

    QR Code error correction level (only for QRCode type)

    qrMask?: number

    QR Code mask pattern 0-7 (only for QRCode type)

    qrModel?: 1 | 2

    QR Code model 1 or 2 (only for QRCode type)

    ratio?: number
    rotate?: Orientation
    type: Barcode

    Settings

    Member Visibility

    On This Page

    Properties