Configuration of the scanning behavior.

Hierarchy (view full)

Constructors

Properties

australiaPostCustomerFormat: AustraliaPostCustomerFormat

The customer format used in AUSTRALIA_POST codes. The default value is ALPHA_NUMERIC.

Default is ALPHA_NUMERIC

barcodeFormats: BarcodeFormat[]

List of accepted barcode symbologies.

Defaults to common types.

barcodesRegexFilter: 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). This option overrides barcodesExtensionFilter option.

Default is ""

Filter for extended EAN and UPC barcodes.

Default is ALLOW_ANY

extractedDocumentFormats: BarcodeDocumentFormat[]

List of document formats to be extracted.

Defaults to all document formats.

gs1Handling: Gs1Handling

The expected way of handling GS1_COMPOSITE barcodes.

Default is PARSE

lowPowerMode: boolean

If true, enables a mode that slightly decreases scanning quality and energy consumption. Increases scanning speed. If false, the mode is disabled. The default is false. Android only.

Default is false

maximumTextLength: number

Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.

Default is 0

minimum1DBarcodesQuietZone: number

Optional minimum required quiet zone on the barcode. Measured in modules (the smallest bar size on a barcode). The default is 10. NOTE - This feature works on ITF barcodes only.

Default is 10

minimumSizeScore: number

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

Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.

Default is 0

msiPlesseyChecksumAlgorithm: MsiPlesseyChecksumAlgorithm

Checksum algorithm used for MSI Plessey barcodes. The default value is MOD_10.

Default is MOD_10

onlyAcceptDocuments: boolean

If true and extractedDocumentFormats is not empty, then barcodes that do not decode to one of the accepted document formats will be ignored.

Default is false

returnBarcodeImage: boolean

If true, the barcode image is returned in the result.

Default is false

stripCheckDigits: boolean

If true, check digits for UPC, EAN and MSI Plessey codes are removed from the result. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is false.

Default is false

useCode11Checksum: boolean

If true, the optional check digit for CODE_11 codes is used in validation. The default is true.

Default is true

useIATA2OF5Checksum: boolean

If true, the optional check digit for IATA_2_OF_5 codes is used in validation. The default is true.

Default is true