Type alias SymbologySpec

SymbologySpec: {
    checksumMode?: number;
    maxLen?: number;
    minLen?: number;
    name: "ean13" | "ean8" | "upca" | "upce" | "databar" | "databar-exp" | "code39" | "code93" | "code128" | "i25" | "codabar";
    qz?: number;
} | {
    curved: boolean;
    name: "qr";
    roundedFPs: boolean;
} | {
    name: "aztec" | "datamatrix" | "pdf417";
}

For variable-length symbologies, min/max length can be specified in addition to the symbology.

Type declaration

  • Optional checksumMode?: number

    The mode to use for symbologies which support an optional checksum mechanism.

    Setting the mode to 0 or leaving it unset disables processing of the checksum. 1 will expect the check digit to be present, validate the barcode data against it, and strip it from the transmitted data. 2 will validate and also transmit the check digit along with the data portion.

    Remarks

    Setting this option to 1 or 2 requires that all barcodes of this symbology include a check digit. Barcodes that lack the check digit will not be readable anymore.

    Default Value

    0
  • Optional maxLen?: number

    The maximum length of the barcode, only has an effect for variable-length symbologies.

  • Optional minLen?: number

    The minimum length of the barcode, only has an effect for variable-length symbologies.

  • name: "ean13" | "ean8" | "upca" | "upce" | "databar" | "databar-exp" | "code39" | "code93" | "code128" | "i25" | "codabar"

    The name of the 1D barcode symbology.

  • Optional qz?: number

    The minimum length of the leading and trailing quiet zone for this symbology, expressed as multiples of X.

    Remarks

    There is rarely a need to change the default.

Type declaration

  • curved: boolean

    Enable detection of QR Codes on curved/bent surfaces.

    Remarks

    More advanced algorithms will be used to read QR Codes from curved or bent surfaces. This option incurs extra processing time and only makes sense if your QR Codes are printed on curved surfaces such as bottles, barrels and other cylindrical or spherical items.

    Default Value

    false
  • name: "qr"

    The name of the QR Code symbology

  • roundedFPs: boolean

    Enable detection of QR Codes with rounded finder patterns.

    Remarks

    The finder patterns of a QR Code are nominally square with straight edges. The straight edges are useful in optimizing the detection of finder pattern triplets and mapping of the QR Code. The ISO specification mandates square finder patterns, but rounded finder patterns are used in practice, especially outside of industrial use cases.

    Default Value

    false

Type declaration

  • name: "aztec" | "datamatrix" | "pdf417"

    The name of the 2D symbology

Settings

Member Visibility

Theme

Generated using TypeDoc