scanbotsdk
    Preparing search index...

    Class BarcodeFormatCommonOneDConfiguration

    Convenience configuration for enabling the scanning of multiple linear (1D) barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple linear (1D) barcode formats.

    The given configuration will be applied to all enabled barcode formats, if they support it. You can override the common configuration for individual barcode formats by additionally adding their specific configuration to the scanner's configuration.

    Index

    Constructors

    Properties

    _type: "BarcodeFormatCommonOneDConfiguration"
    addAdditionalQuietZone: boolean = false

    If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.

    Default is false.

    barcodeDefectProfile: BarcodeDefectProfile = "GENERIC_AND_THERMAL"

    Specifies which kind of barcode defects are tried to fix.

    Default is GENERIC_AND_THERMAL.

    blurryOneDScanner: ConfigState = "ENABLE"

    If ENABLE, the scanner will try extra-hard to scan linear barcodes that are heavily blurred or otherwise damaged.

    Default is ENABLE.

    damagedBarcodeReconstruction: ConfigState = "ENABLE"

    If ENABLE, the scanner will try extra-hard to scan linear barcodes that are damaged in a way that every single scanline is corrupted, e.g. due to scratches, ink smudges, glare, or other damage or obstruction. Only affects the following barcode formats: Code39, Code128, Ean8, Ean13, and UpcA. Not used in low power or legacy mode.

    Default is ENABLE.

    formats: BarcodeFormat[] = ...

    List of linear (1D) barcode formats to scan.

    gs1Handling: Gs1Handling = "PARSE"

    GS1 message handling options.

    Default is PARSE.

    maximumTextLength: number = 0

    Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.

    Default is 0.

    minimum1DQuietZoneSize: number = 6

    Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.

    Default is 6.

    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number = 1

    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only). Linear barcodes are more prone to false positives. Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.

    Default is 1.

    minimumSizeScore: number = 0.0

    Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.

    Default is 0.

    minimumTextLength: number = 1

    Minimum text length. Applied only to linear barcode formats that allow variable length.

    Default is 1.

    oneDConfirmationMode: OneDConfirmationMode = "THOROUGH"

    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.

    Default is THOROUGH.

    regexFilter: string = ""

    Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).

    Default is ""

    stripCheckDigits: boolean = false

    If true, the check digits are stripped from the result.

    Default is false.