react-native-scanbot-sdk
Version:
Scanbot Document and Barcode Scanner SDK React Native Plugin for Android and iOS
1,225 lines (1,075 loc) • 62.5 kB
TypeScript
import { BarcodeFormat, Gs1Handling, UpcEanExtensionBehavior } from '../barcode/BarcodeTypes';
import { DeepPartial, PartiallyConstructible } from '../utils/utils';
/**
Base class for all barcode configurations.
*/
export type BarcodeFormatConfigurationBase = BarcodeFormatCodabarConfiguration | BarcodeFormatCode11Configuration | BarcodeFormatCode39Configuration | BarcodeFormatCode93Configuration | BarcodeFormatCode128Configuration | BarcodeFormatCode2Of5Configuration | BarcodeFormatDataBarConfiguration | BarcodeFormatDataBarExpandedConfiguration | BarcodeFormatDataBarLimitedConfiguration | BarcodeFormatItfConfiguration | BarcodeFormatMsiPlesseyConfiguration | BarcodeFormatUpcEanConfiguration | BarcodeFormatPharmaCodeConfiguration | BarcodeFormatAztecConfiguration | BarcodeFormatQrCodeConfiguration | BarcodeFormatPdf417Configuration | BarcodeFormatMicroPdf417Configuration | BarcodeFormatDataMatrixConfiguration | BarcodeFormatMaxiCodeConfiguration | BarcodeFormatAustraliaPostConfiguration | BarcodeFormatJapanPostConfiguration | BarcodeFormatRoyalMailConfiguration | BarcodeFormatRoyalTntPostConfiguration | BarcodeFormatUspsIntelligentMailConfiguration | BarcodeFormatPharmaCodeTwoTrackConfiguration | BarcodeFormatGs1CompositeConfiguration | BarcodeFormatCommonOneDConfiguration | BarcodeFormatCommonTwoDConfiguration | BarcodeFormatCommonFourStateConfiguration | BarcodeFormatCommonConfiguration;
/**
Base class for all linear (1D) barcode configurations.
*/
export type BarcodeFormatOneDConfigurationBase = BarcodeFormatCodabarConfiguration | BarcodeFormatCode11Configuration | BarcodeFormatCode39Configuration | BarcodeFormatCode93Configuration | BarcodeFormatCode128Configuration | BarcodeFormatCode2Of5Configuration | BarcodeFormatDataBarConfiguration | BarcodeFormatDataBarExpandedConfiguration | BarcodeFormatDataBarLimitedConfiguration | BarcodeFormatItfConfiguration | BarcodeFormatMsiPlesseyConfiguration | BarcodeFormatUpcEanConfiguration | BarcodeFormatPharmaCodeConfiguration;
/**
Codabar barcode configuration. Add to scanner configuration to scan Codabar barcodes.
*/
export declare class BarcodeFormatCodabarConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatCodabarConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
*/
minimumTextLength: number;
/**
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
*/
maximumTextLength: number;
/**
If true, return the start and end characters.
Default is false
*/
returnStartEnd: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatCodabarConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatCodabarConfiguration>);
}
/**
Code 11 barcode configuration. Add to scanner configuration to scan Code 11 barcodes.
*/
export declare class BarcodeFormatCode11Configuration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatCode11Configuration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
If true, the check digits are stripped from the result.
Default is false
*/
stripCheckDigits: boolean;
/**
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
*/
minimumTextLength: number;
/**
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
*/
maximumTextLength: number;
/**
If true, return CODE_11 barcodes only if they have a valid checksum.
Default is true
*/
checksum: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatCode11Configuration>`} */
constructor(source?: DeepPartial<BarcodeFormatCode11Configuration>);
}
/**
Code 39 barcode and derivatives configuration. Add to scanner configuration to scan Code 39, Code 32 (Italian Pharmacode), PZN7 and PZN8 (Pharmazentralnummer) barcodes.
*/
export declare class BarcodeFormatCode39Configuration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatCode39Configuration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
If true, the check digits are stripped from the result.
Default is false
*/
stripCheckDigits: boolean;
/**
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
*/
minimumTextLength: number;
/**
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
*/
maximumTextLength: number;
/**
If true, scan and return valid CODE_32 (Italian Pharmacode) barcodes. If false, CODE_32 barcodes are not decoded and are returned as CODE_39 instead.
Default is false
*/
code32: boolean;
/**
If true, scan CODE_39 barcodes.
Default is true
*/
code39: boolean;
/**
If true, scan PZN7 (legacy Pharmazentralnummer) barcodes. If false, PZN7 barcodes are not decoded and are returned as CODE_39 instead.
Default is true
*/
pzn7: boolean;
/**
If true, scan PZN8 (Pharmazentralnummer) barcodes. If false, PZN8 barcodes are not decoded and are returned as CODE_39 instead.
Default is true
*/
pzn8: boolean;
/**
If true, try to scan CODE_39 in extended mode.
Default is false
*/
tryCode39ExtendedMode: boolean;
/**
If true, return CODE_39 barcodes only if they have a valid check digit.
Default is false
*/
useCode39CheckDigit: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatCode39Configuration>`} */
constructor(source?: DeepPartial<BarcodeFormatCode39Configuration>);
}
/**
Code 93 barcode configuration. Add to scanner configuration to scan Code 93 barcodes.
*/
export declare class BarcodeFormatCode93Configuration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatCode93Configuration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
If true, the check digits are stripped from the result.
Default is false
*/
stripCheckDigits: boolean;
/**
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
*/
minimumTextLength: number;
/**
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
*/
maximumTextLength: number;
/** @param source {@displayType `DeepPartial<BarcodeFormatCode93Configuration>`} */
constructor(source?: DeepPartial<BarcodeFormatCode93Configuration>);
}
/**
Code 128 barcode configuration. Add to scanner configuration to scan Code 128 barcodes.
*/
export declare class BarcodeFormatCode128Configuration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatCode128Configuration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
GS1 message handling options.
Default is PARSE
*/
gs1Handling: Gs1Handling;
/**
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
*/
minimumTextLength: number;
/**
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
*/
maximumTextLength: number;
/** @param source {@displayType `DeepPartial<BarcodeFormatCode128Configuration>`} */
constructor(source?: DeepPartial<BarcodeFormatCode128Configuration>);
}
/**
Configuration for all 2-of-5 barcode types (except Interleaved 2-of-5, which is handled by ItfConfig).
Add to scanner configuration to scan Code 25, IATA 2-of-5 and Industrial 2-of-5 barcodes.
Industrial 2-of-5 barcodes are a subset of Code 25 barcodes.
Any valid Industrial 2-of-5 barcode is also a valid Code 25 barcode.
*/
export declare class BarcodeFormatCode2Of5Configuration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatCode2Of5Configuration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
If true, the check digits are stripped from the result.
Default is false
*/
stripCheckDigits: boolean;
/**
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
*/
minimumTextLength: number;
/**
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
*/
maximumTextLength: number;
/**
If true, scan IATA 2-of-5 barcodes. If useIATA2OF5Checksum is true, only barcodes with a valid checksum are returned.
Default is true
*/
iata2of5: boolean;
/**
If true, scan and return Code 25 (Code 2-of-5) barcodes. If industrial2of5 is also true, then valid Industrial 2-of-5 barcodes will preferentially be returned as such, instead of Code 25.
Default is false
*/
code25: boolean;
/**
If true, scan and return valid Industrial 2-of-5 barcodes. If false, but code25 is true, Industrial 2-of-5 barcodes will be returned as Code 25 barcodes.
Default is true
*/
industrial2of5: boolean;
/**
If true, return IATA_2_OF_5 barcodes only if they have a valid check digit.
Default is true
*/
useIATA2OF5Checksum: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatCode2Of5Configuration>`} */
constructor(source?: DeepPartial<BarcodeFormatCode2Of5Configuration>);
}
/**
GS1 DataBar barcode configuration. Add to scanner configuration to scan GS1 DataBar-14, GS1 DataBar-14 Truncated, GS1 DataBar-14 Stacked and GS1 DataBar-14 Stacked Omnidirectional barcodes.
*/
export declare class BarcodeFormatDataBarConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatDataBarConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
GS1 message handling options.
Default is PARSE
*/
gs1Handling: Gs1Handling;
/** @param source {@displayType `DeepPartial<BarcodeFormatDataBarConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatDataBarConfiguration>);
}
/**
GS1 DataBar Expanded barcode configuration. Add to scanner configuration to scan GS1 DataBar Expanded and GS1 DataBar Expanded Stacked barcodes.
*/
export declare class BarcodeFormatDataBarExpandedConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatDataBarExpandedConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
GS1 message handling options.
Default is PARSE
*/
gs1Handling: Gs1Handling;
/** @param source {@displayType `DeepPartial<BarcodeFormatDataBarExpandedConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatDataBarExpandedConfiguration>);
}
/**
GS1 DataBar Limited barcode configuration. Add to scanner configuration to scan GS1 DataBar Limited barcodes.
*/
export declare class BarcodeFormatDataBarLimitedConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatDataBarLimitedConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
GS1 message handling options.
Default is PARSE
*/
gs1Handling: Gs1Handling;
/** @param source {@displayType `DeepPartial<BarcodeFormatDataBarLimitedConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatDataBarLimitedConfiguration>);
}
/**
ITF (Interleaved 2-of-5) barcode configuration. Add to scanner configuration to scan Interleaved 2-of-5 (ITF) barcodes.
*/
export declare class BarcodeFormatItfConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatITFConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
*/
minimumTextLength: number;
/**
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
*/
maximumTextLength: number;
/** @param source {@displayType `DeepPartial<BarcodeFormatItfConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatItfConfiguration>);
}
/**
Checksum algorithm for MSI_PLESSEY.
- `MOD_10`:
Modulo 10.
- `MOD_11_IBM`:
Modulo 11 IBM.
- `MOD_11_NCR`:
Modulo 11 NCR.
- `MOD_10_10`:
Modulo 1010.
- `MOD_11_10_IBM`:
Modulo 1110 IBM.
- `MOD_11_10_NCR`:
Modulo 1110 NCR.
*/
export type MsiPlesseyChecksumAlgorithm = 'MOD_10' | 'MOD_11_IBM' | 'MOD_11_NCR' | 'MOD_10_10' | 'MOD_11_10_IBM' | 'MOD_11_10_NCR';
export declare const MsiPlesseyChecksumAlgorithmValues: MsiPlesseyChecksumAlgorithm[];
/**
MSI Plessey barcode configuration. Add to scanner configuration to scan MSI Plessey barcodes.
*/
export declare class BarcodeFormatMsiPlesseyConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatMSIPlesseyConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
If true, the check digits are stripped from the result.
Default is false
*/
stripCheckDigits: boolean;
/**
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
*/
minimumTextLength: number;
/**
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
*/
maximumTextLength: number;
/**
List of MSI Plessey checksum algorithms to apply during scanning.
A barcode is considered valid if it passes any of the checksum algorithms in the list.
If the list is empty, no checksum validation is performed.
*/
checksumAlgorithms: MsiPlesseyChecksumAlgorithm[];
/** @param source {@displayType `DeepPartial<BarcodeFormatMsiPlesseyConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatMsiPlesseyConfiguration>);
}
/**
UPC/EAN barcode configuration. Add to scanner configuration to scan EAN-8, EAN-13, UPC-E and UPC-A barcodes.
*/
export declare class BarcodeFormatUpcEanConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatUpcEanConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
If true, the check digits are stripped from the result.
Default is false
*/
stripCheckDigits: boolean;
/**
If true, scan and return valid EAN-8 barcodes.
Default is true
*/
ean8: boolean;
/**
If true, scan and return valid EAN-13 barcodes.
Default is true
*/
ean13: boolean;
/**
If true, scan and return valid UPC-A barcodes. If false, but ean13 is true, then UPC-A barcodes will be returned as EAN-13 barcodes.
Default is true
*/
upca: boolean;
/**
If true, scan and return valid UPC-E barcodes.
Default is true
*/
upce: boolean;
/**
Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
Default is ALLOW_ANY
*/
extensions: UpcEanExtensionBehavior;
/** @param source {@displayType `DeepPartial<BarcodeFormatUpcEanConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatUpcEanConfiguration>);
}
/**
PharmaCode barcode configuration. Add to scanner configuration to scan linear (1D) Laetus Pharmacode barcodes. Two-track PharmaCode scanning is configured separately through the PharmaCodeTwoTrackConfig class.
*/
export declare class BarcodeFormatPharmaCodeConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatPharmaCodeConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
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
*/
minimum1DQuietZoneSize: number;
/**
Minimum value for PharmaCode. Very low values are likely to produce more false positives.
Default is 16
*/
minimumValue: number;
/**
If true, a result consisting of only narrow bars is accepted as valid. The specification does not recommend such barcodes. Default is false.
Default is false
*/
allowNarrowBarsOnly: boolean;
/**
If true, a result consisting of only wide bars is accepted as valid. The specification does not recommend such barcodes. Default is false.
Default is false
*/
allowWideBarsOnly: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatPharmaCodeConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatPharmaCodeConfiguration>);
}
/**
Base class for all 2D barcode configurations.
*/
export type BarcodeFormatTwoDConfigurationBase = BarcodeFormatAztecConfiguration | BarcodeFormatQrCodeConfiguration | BarcodeFormatPdf417Configuration | BarcodeFormatMicroPdf417Configuration | BarcodeFormatDataMatrixConfiguration | BarcodeFormatMaxiCodeConfiguration;
/**
Aztec configuration. Add to scanner configuration to scan Aztec codes.
*/
export declare class BarcodeFormatAztecConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatAztecConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
GS1 message handling options.
Default is PARSE
*/
gs1Handling: Gs1Handling;
/** @param source {@displayType `DeepPartial<BarcodeFormatAztecConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatAztecConfiguration>);
}
/**
QR Code configuration. Add to scanner configuration to scan QR codes, Micro QR codes and rectangular Micro QR (rMQR) codes.
*/
export declare class BarcodeFormatQrCodeConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatQRCodeConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
GS1 message handling options.
Default is PARSE
*/
gs1Handling: Gs1Handling;
/**
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
*/
strictMode: boolean;
/**
If true, scan and return QR codes.
Default is true
*/
qr: boolean;
/**
If true, scan and return Micro QR codes.
Default is false
*/
microQr: boolean;
/**
If true, scan and return rectangular Micro QR (rMQR) codes.
Default is false
*/
rmqr: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatQrCodeConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatQrCodeConfiguration>);
}
/**
PDF417 configuration. Add to scanner configuration to scan PDF417 codes.
*/
export declare class BarcodeFormatPdf417Configuration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatPDF417Configuration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
GS1 message handling options.
Default is PARSE
*/
gs1Handling: Gs1Handling;
/**
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
*/
strictMode: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatPdf417Configuration>`} */
constructor(source?: DeepPartial<BarcodeFormatPdf417Configuration>);
}
/**
MicroPDF417 configuration. Add to scanner configuration to scan MicroPDF417 codes.
*/
export declare class BarcodeFormatMicroPdf417Configuration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatMicroPDF417Configuration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
GS1 message handling options.
Default is PARSE
*/
gs1Handling: Gs1Handling;
/**
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
*/
strictMode: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatMicroPdf417Configuration>`} */
constructor(source?: DeepPartial<BarcodeFormatMicroPdf417Configuration>);
}
/**
DataMatrix configuration. Add to scanner configuration to scan DataMatrix and DataMatrix rectangular extensions (DMRE) codes.
*/
export declare class BarcodeFormatDataMatrixConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatDataMatrixConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
GS1 message handling options.
Default is PARSE
*/
gs1Handling: Gs1Handling;
/** @param source {@displayType `DeepPartial<BarcodeFormatDataMatrixConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatDataMatrixConfiguration>);
}
/**
MaxiCode configuration. Add to scanner configuration to scan MaxiCode codes.
*/
export declare class BarcodeFormatMaxiCodeConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatMaxiCodeConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatMaxiCodeConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatMaxiCodeConfiguration>);
}
/**
Base class for all four-state barcode configurations.
*/
export type BarcodeFormatFourStateConfigurationBase = BarcodeFormatAustraliaPostConfiguration | BarcodeFormatJapanPostConfiguration | BarcodeFormatRoyalMailConfiguration | BarcodeFormatRoyalTntPostConfiguration | BarcodeFormatUspsIntelligentMailConfiguration | BarcodeFormatPharmaCodeTwoTrackConfiguration;
/**
Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
- `NUMERIC`:
Numeric.
- `ALPHA_NUMERIC`:
AlphaNumeric.
*/
export type AustraliaPostCustomerFormat = 'NUMERIC' | 'ALPHA_NUMERIC';
export declare const AustraliaPostCustomerFormatValues: AustraliaPostCustomerFormat[];
/**
Australia Post barcode configuration. Add to scanner configuration to scan Australia Post barcodes.
*/
export declare class BarcodeFormatAustraliaPostConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatAustraliaPostConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
Default is ALPHA_NUMERIC
*/
australiaPostCustomerFormat: AustraliaPostCustomerFormat;
/** @param source {@displayType `DeepPartial<BarcodeFormatAustraliaPostConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatAustraliaPostConfiguration>);
}
/**
Japan Post barcode configuration. Add to scanner configuration to scan Japan Post barcodes.
*/
export declare class BarcodeFormatJapanPostConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatJapanPostConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatJapanPostConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatJapanPostConfiguration>);
}
/**
Royal Mail barcode configuration. Add to scanner configuration to scan Royal Mail (a.k.a. RM4SCC, CBC, BPO 4-State) barcodes.
*/
export declare class BarcodeFormatRoyalMailConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatRoyalMailConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
If true, the check digits are stripped from the result.
Default is false
*/
stripCheckDigits: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatRoyalMailConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatRoyalMailConfiguration>);
}
/**
Royal TNT Post barcode configuration. Add to scanner configuration to scan Royal TNT Post (a.k.a. KIX, Klant IndeX) barcodes.
*/
export declare class BarcodeFormatRoyalTntPostConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatRoyalTNTPostConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatRoyalTntPostConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatRoyalTntPostConfiguration>);
}
/**
USPS Intelligent Mail barcode configuration. Add to scanner configuration to scan USPS Intelligent Mail (a.k.a. USPS OneCode, USPS-STD-11) barcodes.
*/
export declare class BarcodeFormatUspsIntelligentMailConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatUSPSIntelligentMailConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/** @param source {@displayType `DeepPartial<BarcodeFormatUspsIntelligentMailConfiguration>`} */
constructor(source?: DeepPartial<BarcodeFormatUspsIntelligentMailConfiguration>);
}
/**
PHARMA_CODE_TWO_TRACK barcode configuration. Add to scanner configuration to scan Laetus two-track PharmaCode barcodes. Linear (i.e. one-track) PharmaCode scanning is configured separately through the PharmaCodeConfig class.
*/
export declare class BarcodeFormatPharmaCodeTwoTrackConfiguration extends PartiallyConstructible {
readonly _type: 'BarcodeFormatPharmaCodeTwoTrackConfiguration';
/**
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 ""
*/
regexFilter: string;
/**
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
*/
minimumSizeScore: number;
/**
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
*/
addAdditionalQuietZone: boolean;
/**
Minimum value for PHARMA_CODE_TWO_TRACK. Ver