JSDoc: Namespace: decoders

CipherLab Barcode Decoders

Source:

CipherLab.js, line 87

Type Definitions

AustralianPostal

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 89

Aztec

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 95

Chinese2Of5

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 101

Codabar

Properties:

Name	Type	Default	Description
`length1`	number	4	Length qualification *4 (0 ~ 55) Valid values are [0, 55].
`length2`	number	55	Length qualification *55 (0 ~ 55) Valid values are [0, 55].
`clsiEditing`	boolean	false	A value specifying whether to edit CLSI.
`notisEditingType`	number	0	A value specifying whether to transform it to NOTIS editing format (Start/Stop characters) and the way it is transformed. Valid values are 0 (None), 1 (ABCDUpper), 2 (AbcdLower).
`notisEditing`	boolean	true	Reserved.
`transmitCheckDigit`	boolean	true	A value specifying whether to transmit check digit.
`verifyCheckDigit`	number	0	A value specifying whether and how to verify check digit. *None Modulo_16 Modulo_7DR Modulo_Both Note: For Modulo_7DR, the total number of digits in a codabar cannot be greater than '19'; and the first digit in a codabar must be equal to or less than '8'. Valid values are 0 (None), 1 (Modulo16), 2 (Modulo7DR), 3 (ModuloBoth).
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 107

Code11

Properties:

Name	Type	Default	Description
`length1`	number	4	Length qualification *4 (0 ~ 55) Valid values are [0, 55].
`length2`	number	55	Length qualification *55 (0 ~ 55) Valid values are [0, 55].
`numberOfCheckDigits`	number	0	A value specifying whether and how to verify check digit. Valid values are 0 (None), 1 (One), 2 (Two).
`transmitCheckDigit`	boolean	false	A value specifying whether to transmit check digit.
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 134

Code39

Properties:

Name	Type	Default	Description
`length1`	number	4	Length qualification *4 (0 ~ 55) Valid values are [0, 55].
`length2`	number	55	Length qualification *55 (0 ~ 55) Valid values are [0, 55].
`convertToCode32`	boolean	false	A value that specifies whether to convert Code 39 to Code 32 (= Italian Pharmacode).
`convertToCode32Prefix`	boolean	false	A value that specifies whether to transmit prefix for Code 32 data.
`fullASCII`	boolean	false	A value that specifies whether to support Code 39 Full ASCII.
`checkDigitVerification`	boolean	false	A value that specifies whether to verify check digit.
`transmitCheckDigit`	boolean	false	A value that specifies whether to transmit check digit.
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 166

Code93

Properties:

Name	Type	Default	Description
`length1`	number	4	Valid values are [0, 55].
`length2`	number	55	Valid values are [0, 55].
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 188

Code128

Properties:

Name	Type	Default	Description
`length1`	number	4	Length qualification *4 (0 ~ 55) Valid values are [0, 55].
`length2`	number	55	Length qualification *55 (0 ~ 55) Valid values are [0, 55].
`securityLevel`	number	0	A value that specifies the decode security level while reading Code128. Valid values are [0, 55].
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 151

Composite

Properties:

Name	Type	Default	Description
`enableCc_C`	boolean	true
`enableCc_AB`	boolean	false
`enableTlc39`	boolean	false
`enableUpcMode`	number	1	Valid values are 0 (UpcNeverLinked), 1 (UpcAlwaysLinked), 2 (AutoDiscriminate).
`enableEmulationMode`	boolean	false
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 196

DataMatrix

Properties:

Name	Type	Default	Description
`fieldSeparator`	string		A value that specifies whether to apply a field separator of ASCII ranging from 0 to 127. It's set to zero by default.
`mirrorImage`	number	0	A value that specifies whether to decode mirror image Data Matrix barcodes. Valid values are 0 (Never), 1 (Always), 2 (Auto).
`applicationIdentifierMark1`	string
`applicationIdentifierMark2`	string
`enableApplicationIdentifier`	boolean	false
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 213

DutchPostal

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 228

Ean8

Properties:

Name	Type	Default	Description
`addon2`	number	1	A value that specifies the way processing addon2. Valid values are 1 (IgnoresAddon), 2 (AutoDiscriminate).
`addon5`	number	1	A value that specifies the way processing addon5. Valid values are 1 (IgnoresAddon), 2 (AutoDiscriminate).
`convertToEan13`	boolean	false	A value that specifies whether to convert EAN-8 to EAN-13.
`transmitCheckDigit`	boolean	true	A value that specifies whether to transmit check digit.
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 255

Ean13

Properties:

Name	Type	Default	Description
`addon2`	number	1	A value that specifies the way processing addon2. Valid values are 1 (IgnoresAddon), 2 (AutoDiscriminate).
`addon5`	number	1	A value that specifies the way processing addon5. Valid values are 1 (IgnoresAddon), 2 (AutoDiscriminate).
`booklandISBNFormat`	number	0	If you enabled Bookland EAN, select one of the following formats for Bookland data. Valid values are 0 (Isbn10), 1 (Isbn13).
`convertToISBN`	boolean	false	A value that specifies whether to convert EAN-13 to ISBN.
`convertToISSN`	boolean	false	A value that specifies whether to convert EAN-13 to ISSN.
`transmitCheckDigit`	boolean	true	A value that specifies whether to transmit check digit.
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 234

GS1DataBar14

Properties:

Name	Type	Default	Description
`convertToUpcEan`	boolean	false	A value that specifies whether to convert RSS to UPC/EAN barcodes.
`securityLevel`	number	1	A value that specifies the decode security level while reading GS1 DataBar 14. *1 (0 ~ 3) Valid values are [0, 3].
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 320

GS1DataBarExpanded

Properties:

Name	Type	Default	Description
`securityLevel`	number	1	A value that specifies the decode security level while reading GS1 DataBar Expanded. *1 (0 ~ 3) Valid values are [0, 3].
`fieldSeparator`	string		A value that specifies whether to apply a field separator of ASCII ranging from 0 to 127. It's set to zero by default.
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 331

GS1DataBarLimited

Properties:

Name	Type	Default	Description
`convertToUpcEan`	boolean	false	A value that specifies whether to convert RSS to UPC/EAN barcodes.
`securityLevel`	number	3	A value that specifies the decode security level while reading GS1 DataBar Limited. *3 (1 ~ 4) Valid values are [1, 4].
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 343

GS1128

Properties:

Name	Type	Default	Description
`applicationIdentifierMark1`	string
`applicationIdentifierMark2`	string
`enableApplicationIdentifier`	boolean	false	A value that specifies whether to enable the application identifier.
`fieldSeparator`	string		A value that specifies whether to apply a field separator of ASCII ranging from 0 to 127. It's set to zero by default.
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 307

Industrial2Of5

Properties:

Name	Type	Default	Description
`length1`	number	4	Length qualification *4 (0 ~ 55) Valid values are [0, 55].
`length2`	number	55	Length qualification *55 (0 ~ 55) Valid values are [0, 55].
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 271

Interleaved2Of5

Properties:

Name	Type	Default	Description
`length1`	number	4	Length qualification *4 (0 ~ 55) Valid values are [0, 55].
`length2`	number	55	Length qualification *55 (0 ~ 55) Valid values are [0, 55].
`checkDigitVerification`	number	0	A value that specifies whether and how to verify check digit. Valid values are 0 (Disable), 1 (Uss), 2 (Opcc).
`convertToEan13`	boolean	false	A value that specifies whether to convert Interleaved 25 to EAN-13.
`transmitCheckDigit`	boolean	false	A value that specifies whether to transmit check digit. It is available only when I20f5CheckDigitVerification is not disabled.
`securityLevel`	number	1	A value that specifies the decode security level while reading. Valid values are [0, 3].
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 354

Isbt128

Properties:

Name	Type	Default	Description
`concatenation`	number	2	A value that specifies whether to decode and concatenate pairs of ISBT barcodes. Valid values are 0 (Disable), 1 (Enable), 2 (Auto).
`concatenationRedundancy`	number	10	A value that specifies concatenation redundancy (2~20 times) when auto-discriminate of ISBT concatenation is enabled. By default, it is set to 10 times. Valid values are [2, 20].
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 377

JapanPostal

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 283

Korean3Of5

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 390

Matrix2Of5

Properties:

Name	Type	Default	Description
`length1`	number	4	Length qualification *4 (0 ~ 55) Valid values are [0, 55].
`length2`	number	55	Length qualification *55 (0 ~ 55) Valid values are [0, 55].
`checkDigitVerification`	boolean	false
`transmitCheckDigit`	boolean	false
`redundancy`	boolean	false
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 396

MaxiCode

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 411

MicroPdf417

Properties:

Name	Type	Default	Description
`code128Emulation`	boolean	true	A value that specifies whether to enable Code 128 Emulation for certain MicroPDF417 barcodes.
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 417

MicroQR

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 425

Msi

Properties:

Name	Type	Default	Description
`length1`	number	4	Length qualification *4 (0 ~ 55) Valid values are [0, 55].
`length2`	number	55	Length qualification *55 (0 ~ 55) Valid values are [0, 55].
`checkDigitAlgorithm`	number	1	Valid values are 1 (Modulo1011), 2 (DoubleModulo10).
`checkDigitOption`	number	1	Valid values are 1 (OneDigit), 2 (TwoDigits).
`transmitCheckDigit`	boolean	false
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 431

Pdf417

Properties:

Name	Type	Default	Description
`transmitMode`	number	0	A value that specifies how to handle decoding. Valid values are 0 (PassThroughAllSymbols), 1 (BufferAllSymbols), 2 (TransmitAnySymbolInSet).
`escapeCharacter`	boolean	true	A value that specifies whether to use the escape character.
`transmitControlHeader`	boolean	true
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 446

Plessey

Properties:

Name	Type	Default	Description
`length1`	number	4	Length qualification *0 (0 ~ 55) Valid values are [0, 55].
`length2`	number	55	Length qualification *0 (0 ~ 55) Valid values are [0, 55].
`transmitCheckDigit`	boolean	true	A value that specifies whether to transmit check digit.
`unconventionalStop`	boolean	true	A value that specifies whether to enable Plessey unconventional stop. When this function is enabled, Plessey bar codes can be decoded with a stop which is a variation of a standard one (bars are narrower or wider).
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 458

QRCode

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 476

Telepen

Properties:

Name	Type	Default	Description
`length1`	number	4	Length qualification *0 (0 ~ 55) Valid values are [0, 55].
`length2`	number	55	Length qualification *0 (0 ~ 55) Valid values are [0, 55].
`format`	number	0	A value that sets output format. "0" represents ASCII, while "1" represents Numeric. Valid values are 0 (Ascii), 1 (Numeric).
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 482

TriopticCode39

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 497

UccCoupon

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 207

UKPostal

Properties:

Name	Type	Default	Description
`transmitCheckDigit`	boolean	true
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 289

Upca

Properties:

Name	Type	Default	Description
`addon2`	number	1	Valid values are 1 (IgnoresAddon), 2 (AutoDiscriminate).
`addon5`	number	1	Valid values are 1 (IgnoresAddon), 2 (AutoDiscriminate).
`convertToEan13`	boolean	false
`transmitSystemNumber`	number	1	Valid values are 0 (None), 1 (SystemCharacter), 2 (SystemCharacterAndCtyCode).
`transmitCheckDigit`	boolean	true
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 503

Upce0

Properties:

Name	Type	Default	Description
`addon2`	number	1	Valid values are 1 (IgnoresAddon), 2 (AutoDiscriminate).
`addon5`	number	1	Valid values are 1 (IgnoresAddon), 2 (AutoDiscriminate).
`convertToUpcA`	boolean	false
`transmitSystemNumber`	number	1	Valid values are 0 (None), 1 (SystemCharacter), 2 (SystemCharacterAndCtyCode).
`transmitCheckDigit`	boolean	true
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 514

Upce1

Properties:

Name	Type	Default	Description
`addon2`	number	1	Valid values are 1 (IgnoresAddon), 2 (AutoDiscriminate).
`addon5`	number	1	Valid values are 1 (IgnoresAddon), 2 (AutoDiscriminate).
`convertToUpcA`	boolean	false
`transmitSystemNumber`	number	1	Valid values are 0 (None), 1 (SystemCharacter), 2 (SystemCharacterAndCtyCode).
`transmitCheckDigit`	boolean	true
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 296

UpuFicsPostal

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 525

USPostal

Properties:

Name	Type	Default	Description
`enablePlanet`	boolean	true
`enablePostnet`	boolean	true
`transmitCheckDigit`	boolean	true
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 531

UspsPostal

Properties:

Name	Type	Default	Description
`enabled`	boolean	true	Gets or sets a value indicating if the decoder is used to interpret barcodes.

Source:

CipherLab.js, line 540