BarcodeSettings

BarcodeSettings class

The main BarCode decoding parameters. Contains parameters which make influence on recognized data.

new BarcodeSettings(settings)

BarcodeSettings copy constructor

Parameter	Description
settings	The source of the data

Methods

Name	Description
getAustraliaPost()	Gets AustraliaPost decoding parameters
getChecksumValidation()	Enable checksum validation during recognition for 1D and Postal barcodes. Default is treated as Yes for symbologies whic
getDetectEncoding()	The flag which force engine to detect codetext encoding for Unicode codesets. Default value is true.
getStripFNC()	Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.
isOnlyRequestedTypes()	Returns only barcode types explicitly specified for recognition. When enabled, recognized barcodes of other compatible o
setChecksumValidation(value)	Enable checksum validation during recognition for 1D and Postal barcodes. Default is treated as Yes for symbologies whic
setDetectEncoding()	The flag which force engine to detect codetext encoding for Unicode codesets. Default value is true.
setOnlyRequestedTypes()	Returns only barcode types explicitly specified for recognition. When enabled, recognized barcodes of other compatible o
setStripFNC(value)	Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.

getAustraliaPost()

Gets AustraliaPost decoding parameters

Returns: The AustraliaPost decoding parameters which make influence on recognized data of AustraliaPost symbology

getChecksumValidation()

Enable checksum validation during recognition for 1D and Postal barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar, PatchCode, Pharmacode, DataLogic2of5 Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, ItalianPost25, Matrix2of5, MSI, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies

Returns: Enable checksum validation during recognition for 1D and Postal barcodes.

Example:

let generator = new BarcodeGenerator(EncodeTypes.EAN_13, "1234567890128");
generator.save("c:/test.png", BarcodeImageFormat.PNG);
let reader = new BarCodeReader("c:/test.png", DecodeType.EAN_13);
//checksum disabled
reader.getBarcodeSettings().setChecksumValidation(ChecksumValidation.OFF);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
     let result = results[i];
     console.log ("BarCode CodeText: " + result.getCodeText());
     console.log ("BarCode Value: " + result.getExtended().getOneD().getValue());
     console.log ("BarCode Checksum: " + result.getExtended().getOneD().getCheckSum());
}

getDetectEncoding()

The flag which force engine to detect codetext encoding for Unicode codesets. Default value is true.

Returns: The flag which force engine to detect codetext encoding for Unicode codesets

Example:

let generator = new BarcodeGenerator(EncodeTypes.QR, "Слово"))
im = generator.generateBarcodeImage(BarcodeImageFormat.PNG);

//detects encoding for Unicode codesets is enabled
let reader = new BarCodeReader(im, DecodeType.QR);
reader.getBarcodeSettings().setDetectEncoding(true);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
   let result = results[i];
   console.log ("BarCode CodeText: " + result.getCodeText());
}

getStripFNC()

Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.

Returns: Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.

Example:

let generator = new BarcodeGenerator(EncodeTypes.GS_1_CODE_128, "(02)04006664241007(37)1(400)7019590754");
generator.save("c:/test.png", BarcodeImageFormat.PNG);
let reader = new BarCodeReader("c:/test.png", DecodeType.CODE_128);

//StripFNC disabled
reader.getBarcodeSettings().setStripFNC(false);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
   let result = results[i];
   console.log ("BarCode CodeText: " + result.getCodeText());
}

isOnlyRequestedTypes()

Returns only barcode types explicitly specified for recognition. When enabled, recognized barcodes of other compatible or equivalent types are filtered out. Default value is false. Example: // generate EAN13 barcode let generator = new BarcodeGenerator(EncodeTypes.EAN_13, “2383823482894”); generator.save(“test.png”); // recognize only UPCA barcodes (no results, because source is EAN13) const reader = new BarCodeReader(“test.png”, null, DecodeType.UPCA); reader.getBarcodeSettings().setOnlyRequestedTypes(true); let results = reader.readBarCodes(); for (let i = 0; i < results.length; i++) { console.log(“BarCode CodeText: " + results[i].getCodeText()); } // recognize compatible types: EAN13, UPCA, ISSN, ISMN, ISBN // (EAN13 will be returned as UPCA-equivalent) let reader2 = new BarCodeReader(“test.png”, null, DecodeType.UPCA); reader2.getBarcodeSettings().setOnlyRequestedTypes(false); let results2 = reader2.readBarCodes(); for (let i = 0; i < results2.length; i++) { console.log(“BarCode CodeText: " + results2[i].getCodeText()); }

Returns: true if only explicitly requested barcode types are returned; otherwise false

setChecksumValidation(value)

Parameter	Description
value	Enable checksum validation during recognition for 1D and Postal barcodes.

Example:

let generator = new BarcodeGenerator(EncodeTypes.EAN_13, "1234567890128");
generator.save("c:/test.png", BarcodeImageFormat.PNG);
let reader = new BarCodeReader("c:/test.png", DecodeType.EAN_13);
//checksum disabled
reader.getBarcodeSettings().setChecksumValidation(ChecksumValidation.OFF);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
     let result = results[i];
     console.log ("BarCode CodeText: " + result.getCodeText());
     console.log ("BarCode Value: " + result.getExtended().getOneD().getValue());
     console.log ("BarCode Checksum: " + result.getExtended().getOneD().getCheckSum());
}

setDetectEncoding()

The flag which force engine to detect codetext encoding for Unicode codesets. Default value is true.

Returns: The flag which force engine to detect codetext encoding for Unicode codesets

Example:

let generator = new BarcodeGenerator(EncodeTypes.QR, "Слово"))
im = generator.generateBarcodeImage(BarcodeImageFormat.PNG);

//detects encoding for Unicode codesets is enabled
let reader = new BarCodeReader(im, DecodeType.QR);
reader.getBarcodeSettings().setDetectEncoding(true);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
   let result = results[i];
   console.log ("BarCode CodeText: " + result.getCodeText());
}

setOnlyRequestedTypes()

Returns: true if only explicitly requested barcode types are returned; otherwise false

setStripFNC(value)

Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.

Parameter	Description
value	Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.

Example:

let generator = new BarcodeGenerator(EncodeTypes.GS_1_CODE_128, "(02)04006664241007(37)1(400)7019590754");
generator.save("c:/test.png", BarcodeImageFormat.PNG);
let reader = new BarCodeReader("c:/test.png", DecodeType.CODE_128);

//StripFNC disabled
reader.getBarcodeSettings().setStripFNC(false);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
   let result = results[i];
   console.log ("BarCode CodeText: " + result.getCodeText());
}

BarcodeParameters BaseGenerationParameters