Configuration of the scanning behavior.

Hierarchy

  • PartiallyConstructible
    • BarcodeScannerConfiguration

Constructors

Properties

australiaPostCustomerFormat: AustraliaPostCustomerFormat

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

Default Value

"ALPHA_NUMERIC";
barcodeFormats: BarcodeFormat[]

List of accepted barcode symbologies.

Defaults to common types.

Default Value

["AZTEC", "CODABAR", "CODE_39", "CODE_93", "CODE_128", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "ITF", "MICRO_QR_CODE", "PDF_417", "QR_CODE", "UPC_A", "UPC_E"];
barcodesExtensionFilter: BarcodesExtensionFilter

Filter for extended EAN and UPC barcodes.

Default Value

"NO_FILTER";
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 Value

"";

The engine mode to use for barcode scanning.

Default Value

"NEXT_GEN_LOW_POWER";
extractedDocumentFormats: BarcodeDocumentFormat[]

List of document formats to be extracted.

Defaults to all document formats.

Default Value

["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC"];
gs1Handling: Gs1Handling

The expected way of handling GS1_COMPOSITE barcodes.

Default Value

"PARSE";
maximumRecognizerResolution: number

Maximum resolution of the image processed by the barcode recognizer. Smaller values mean faster processing but lower recognition quality. The value is limited by the resolution of the preview.

Default Value

600;
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 Value

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 Value

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 Value

0.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 Value

0;
msiPlesseyChecksumAlgorithm: MsiPlesseyChecksumAlgorithm

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

Default Value

"MOD_10";
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 Value

false;
useCode11Checksum: boolean

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

Default Value

true;
useIATA2OF5Checksum: boolean

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

Default Value

true;

Generated using TypeDoc