Pdf417Parameters

Pdf417Parameters

PDF417 parameters. Contains PDF417, MacroPDF417, MicroPDF417 and GS1MicroPdf417 parameters. MacroPDF417 requires two fields: Pdf417MacroFileID and Pdf417MacroSegmentID. All other fields are optional. MicroPDF417 in Structured Append mode (same as MacroPDF417 mode) requires two fields: Pdf417MacroFileID and Pdf417MacroSegmentID. All other fields are optional.

These samples show how to encode UCC/EAN-128 non Linked modes in GS1MicroPdf417
        

Constructor

new Pdf417Parameters()

Source:
Examples
# Encodes GS1 UCC/EAN-128 non Linked mode 905 with AI 01 (GTIN)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(01)12345678901231");
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
   let result = results[i];
   console.log( result.getCodeText());
}
# Encodes GS1 UCC/EAN-128 non Linked modes 903, 904 with any AI
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(241)123456789012345(241)ABCD123456789012345");
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
   let result = results[i];
   console.log( result.getCodeText());
}
</pre>
</pre>
</p>

Methods

getAspectRatio()

Height/Width ratio of 2D BarCode module.
Source:

getColumns()

Columns count.
Source:

getECIEncoding()

Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Not applied for Macro PDF417 text fields. Current implementation consists all well known charset encodings.

Source:

getEncodeMode()

Identifies Pdf417 encode mode. Default value: Auto.

Source:

getErrorLevel()

Gets Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.

Returns:
Type Description
Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.
Source:

getMacroCharacters()

Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with MicroPdf417 and encodes 916 and 917 MicroPdf417 modes Default value: MacroCharacters.None.


These samples show how to encode Macro Characters in MicroPdf417
  
Source:
Examples
# Encodes MicroPdf417 with 05 Macro the string: "[)>\u001E05\u001Dabcde1234\u001E\u0004"
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "abcde1234");
generator.getParameters().getBarcode().getPdf417().setMacroCharacters(MacroCharacter.MACRO_05);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log( result.getCodeText());
}
# Encodes MicroPdf417 with 06 Macro the string: "[)>\u001E06\u001Dabcde1234\u001E\u0004"
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "abcde1234");
generator.getParameters().getBarcode().getPdf417().setMacroCharacters(MacroCharacter.MACRO_06);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText());
}
</pre>
</pre></blockquote></hr></p>

getMacroPdf417Addressee()

MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode)

Source:

getMacroPdf417Checksum()

MacroPdf417 barcode checksum (optional field). MicroPDF417 barcode checksum (optional field for Structured Append mode) The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial. x^16 + x^12 + x^5 + 1

Source:

getMacroPdf417ECIEncoding()

Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

Source:

getMacroPdf417FileID()

MacroPdf417 barcode's file ID (Required field). MicroPDF417 barcode's file ID (Required field for Structured Append mode)

Source:

getMacroPdf417FileName()

MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode)

Source:

getMacroPdf417FileSize()

MacroPdf417 file size (optional field). MicroPDF417 file size (optional field for Structured Append mode) The file size field contains the size in bytes of the entire source file.

Source:

getMacroPdf417SegmentID()

MacroPdf417 barcode's segment ID (Required field), which starts from 0, to MacroSegmentsCount - 1. MicroPDF417 barcode's segment ID (Required field for Structured Append mode)

Source:

getMacroPdf417SegmentsCount()

MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode)

Source:

getMacroPdf417Sender()

MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode)

Source:

getMacroPdf417Terminator()

Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.

Source:

getMacroPdf417TimeStamp()

MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode)

Source:

getPdf417CompactionMode()

Pdf417 symbology type of BarCode's compaction mode.
Default value: Pdf417CompactionMode.AUTO.
Source:

getPdf417ECIEncoding()

Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details
about the used references for encoding the data in the symbol.
Current implementation consists all well known charset encodings.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getECIEncoding().

Source:

getPdf417EncodeMode()

Identifies Pdf417 encode mode. Default value: Auto.
Source:

getPdf417ErrorLevel()

Gets Pdf417 symbology type of BarCode's error correction level
ranging from level0 to level8, level0 means no error correction info,
level8 means best error correction which means a larger picture.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getErrorLevel().

Source:

getPdf417MacroAddressee()

Gets macro Pdf417 barcode addressee name.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getMacroPdf417Addressee().

Source:

getPdf417MacroChecksum()

Gets macro Pdf417 barcode checksum.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getMacroPdf417Checksum().

Returns:
Type Description
The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial.
Source:

getPdf417MacroECIEncoding()

Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getMacroPdf417ECIEncoding().

Source:

getPdf417MacroFileID()

Getsmacro Pdf417 barcode's file ID.
Used for MacroPdf417.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getMacroPdf417FileID().

Source:

getPdf417MacroFileName()

Gets macro Pdf417 barcode file name.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getMacroPdf417FileName().

Source:

getPdf417MacroFileSize()

Gets macro Pdf417 file size.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getMacroPdf417FileSize().

Returns:
Type Description
The file size field contains the size in bytes of the entire source file.
Source:

getPdf417MacroSegmentID()

Gets macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getMacroPdf417SegmentID().

Source:

getPdf417MacroSegmentsCount()

Gets macro Pdf417 barcode segments count.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getMacroPdf417SegmentsCount().

Source:

getPdf417MacroSender()

Gets macro Pdf417 barcode sender name.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getMacroPdf417Sender().

Source:

getPdf417MacroTerminator()

Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment.
Applied only for Macro PDF417.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getMacroPdf417Terminator().

Source:

getPdf417MacroTimeStamp()

Gets macro Pdf417 barcode time stamp.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getMacroPdf417TimeStamp().

Source:

getPdf417Truncate()

Whether Pdf417 symbology type of BarCode is truncated (to reduce space).
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the getTruncate().

Source:

getRows()

Rows count.
Source:

getStructuredAppendModeBarcodeId()

Identifies the ID of the DotCode structured append mode barcode. ID starts from 1 and must be less or equal to barcodes count. Default value is -1.

Source:

getTruncate()

Whether Pdf417 symbology type of BarCode is truncated (to reduce space). Also known as CompactPDF417. Rigth row indicator and right stop pattern are removed in this mode.

Source:

isCode128Emulation()

Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128


These samples show how to encode Code 128 emulation modes with FNC1 in second position and without. In this way MicroPdf417 can be decoded as Code 128 barcode
  
Source:
Examples
# Encodes MicroPdf417 in Code 128 emulation mode with FNC1 in second position and Application Indicator "a", mode 908.
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "a\u001d1222322323");
generator.getParameters().getBarcode().getPdf417().setCode128Emulation(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsCode128Emulation:" + result.getExtended().getPdf417().isCode128Emulation());
}
# Encodes MicroPdf417 in Code 128 emulation mode with FNC1 in second position and Application Indicator "99", mode 909.
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "99\u001d1222322323");
generator.getParameters().getBarcode().getPdf417().setCode128Emulation(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsCode128Emulation:" + result.getExtended().getPdf417().isCode128Emulation());
}
# Encodes MicroPdf417 in Code 128 emulation mode, modes 910, 911
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "123456789012345678");
generator.getParameters().getBarcode().getPdf417().setCode128Emulation(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsCode128Emulation:" + result.getExtended().getPdf417().isCode128Emulation());
}
</pre>
</pre></blockquote></hr></p>

isLinked()

Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC


These samples show how to encode "Linked" UCC/EAN-128 modes in GS1MicroPdf417 and Linkage Flag (918) in MicroPdf417 and Pdf417 barcodes
  
Source:
Examples
# Encodes GS1 Linked mode 912 with date field AI 11 (Production date) and AI 10 (Lot number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(11)991231(10)ABCD");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes GS1 Linked mode 912 with date field AI 13 (Packaging date) and AI 21 (Serial number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(13)991231(21)ABCD");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes GS1 Linked mode 912 with date field AI 15 (Sell-by date) and AI 10 (Lot number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(15)991231(10)ABCD");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes GS1 Linked mode 912 with date field AI 17 (Expiration date) and AI 21 (Serial number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(17)991231(21)ABCD");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes GS1 Linked mode 914 with AI 10 (Lot number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(10)ABCD12345");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes GS1 Linked mode 915 with AI 21 (Serial number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(21)ABCD12345");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes GS1 Linked modes 906, 907 with any AI
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(240)123456789012345");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes MicroPdf417 NON EAN.UCC Linked mode 918
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "ABCDE123456789012345678");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes Pdf417 NON EAN.UCC Linked mode 918
let generator = new BarcodeGenerator(EncodeTypes.PDF_417, "ABCDE123456789012345678");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
</pre>
</pre></blockquote></hr></p>

isReaderInitialization()

Used to instruct the reader to interpret the data contained within the symbol
as programming for reader initialization
Returns:
Type Description
boolean value
Source:

setAspectRatio()

Height/Width ratio of 2D BarCode module.
Source:

setCode128Emulation()

Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128


These samples show how to encode Code 128 emulation modes with FNC1 in second position and without. In this way MicroPdf417 can be decoded as Code 128 barcode
  
Source:
Examples
# Encodes MicroPdf417 in Code 128 emulation mode with FNC1 in second position and Application Indicator "a", mode 908.
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "a\u001d1222322323");
generator.getParameters().getBarcode().getPdf417().setCode128Emulation(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsCode128Emulation:" + result.getExtended().getPdf417().isCode128Emulation());
}
# Encodes MicroPdf417 in Code 128 emulation mode with FNC1 in second position and Application Indicator "99", mode 909.
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "99\u001d1222322323");
generator.getParameters().getBarcode().getPdf417().setCode128Emulation(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsCode128Emulation:" + result.getExtended().getPdf417().isCode128Emulation());
}
# Encodes MicroPdf417 in Code 128 emulation mode, modes 910, 911
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "123456789012345678");
generator.getParameters().getBarcode().getPdf417().setCode128Emulation(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
   console.log(result.getCodeText() + " IsCode128Emulation:" + result.getExtended().getPdf417().isCode128Emulation());
}
</pre>
</pre></blockquote></hr></p>

setColumns()

Columns count.
Source:

setECIEncoding()

Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Not applied for Macro PDF417 text fields. Current implementation consists all well known charset encodings.

Source:

setEncodeMode()

Identifies Pdf417 encode mode. Default value: Auto.

Source:

setErrorLevel(value)

Sets Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.

Parameters:
Name Type Description
value Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.
Source:

setLinked()

Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC


These samples show how to encode "Linked" UCC/EAN-128 modes in GS1MicroPdf417 and Linkage Flag (918) in MicroPdf417 and Pdf417 barcodes
  
Source:
Examples
# Encodes GS1 Linked mode 912 with date field AI 11 (Production date) and AI 10 (Lot number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(11)991231(10)ABCD");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes GS1 Linked mode 912 with date field AI 13 (Packaging date) and AI 21 (Serial number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(13)991231(21)ABCD");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes GS1 Linked mode 912 with date field AI 15 (Sell-by date) and AI 10 (Lot number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(15)991231(10)ABCD");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes GS1 Linked mode 912 with date field AI 17 (Expiration date) and AI 21 (Serial number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(17)991231(21)ABCD");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log(result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes GS1 Linked mode 914 with AI 10 (Lot number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(10)ABCD12345");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes GS1 Linked mode 915 with AI 21 (Serial number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(21)ABCD12345");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
   let result = results[i];
   result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes GS1 Linked modes 906, 907 with any AI
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(240)123456789012345");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
   let result = results[i];
   result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes MicroPdf417 NON EAN.UCC Linked mode 918
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "ABCDE123456789012345678");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
   let result = results[i];
   result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
# Encodes Pdf417 NON EAN.UCC Linked mode 918
let generator = new BarcodeGenerator(EncodeTypes.PDF_417, "ABCDE123456789012345678");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
   let result = results[i];
   result.getCodeText() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}
</pre>
</pre></blockquote></hr></p>

setMacroCharacters()

Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with MicroPdf417 and encodes 916 and 917 MicroPdf417 modes Default value: MacroCharacters.None.


These samples show how to encode Macro Characters in MicroPdf417
  
Source:
Examples
# Encodes MicroPdf417 with 05 Macro the string: "[)>\u001E05\u001Dabcde1234\u001E\u0004"
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "abcde1234");
generator.getParameters().getBarcode().getPdf417().setMacroCharacters(MacroCharacter.MACRO_05);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];  
    console.log( result.getCodeText());
}
# Encodes MicroPdf417 with 06 Macro the string: "[)>\u001E06\u001Dabcde1234\u001E\u0004"
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "abcde1234");
generator.getParameters().getBarcode().getPdf417().setMacroCharacters(MacroCharacter.MACRO_06);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
   let result = results[i];
   console.log( result.getCodeText());
}
</pre>
</pre></blockquote></hr></p>

setMacroPdf417Addressee()

MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode)

Source:

setMacroPdf417Checksum()

MacroPdf417 barcode checksum (optional field). MicroPDF417 barcode checksum (optional field for Structured Append mode) The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial. x^16 + x^12 + x^5 + 1

Source:

setMacroPdf417ECIEncoding()

Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

Source:

setMacroPdf417FileID()

MacroPdf417 barcode's file ID (Required field). MicroPDF417 barcode's file ID (Required field for Structured Append mode)

Source:

setMacroPdf417FileName()

MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode)

Source:

setMacroPdf417FileSize()

MacroPdf417 file size (optional field). MicroPDF417 file size (optional field for Structured Append mode) The file size field contains the size in bytes of the entire source file.

Source:

setMacroPdf417SegmentID()

MacroPdf417 barcode's segment ID (Required field), which starts from 0, to MacroSegmentsCount - 1. MicroPDF417 barcode's segment ID (Required field for Structured Append mode)

Source:

setMacroPdf417SegmentsCount()

MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode)

Source:

setMacroPdf417Sender()

MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode)

Source:

setMacroPdf417Terminator()

Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.

Source:

setMacroPdf417TimeStamp()

MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode)

Source:

setPdf417CompactionMode()

Pdf417 symbology type of BarCode's compaction mode.
Default value: Pdf417CompactionMode.AUTO.
Source:

setPdf417ECIEncoding()

Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details
about the used references for encoding the data in the symbol.
Current implementation consists all well known charset encodings.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setECIEncoding().

Source:

setPdf417EncodeMode()

Identifies Pdf417 encode mode. Default value: Auto.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setEncodeMode().

Source:

setPdf417ErrorLevel()

Sets Pdf417 symbology type of BarCode's error correction level
ranging from level0 to level8, level0 means no error correction info,
level8 means best error correction which means a larger picture.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setErrorLevel().

Source:

setPdf417MacroAddressee()

Sets macro Pdf417 barcode addressee name.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setMacroPdf417Addressee().

Source:

setPdf417MacroChecksum(value)

Sets macro Pdf417 barcode checksum.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setMacroPdf417Checksum().

Parameters:
Name Type Description
value The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial.
Source:

setPdf417MacroECIEncoding()

Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setMacroPdf417ECIEncoding().

Source:

setPdf417MacroFileID()

Sets macro Pdf417 barcode's file ID.
Used for MacroPdf417.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setMacroPdf417FileID().

Source:

setPdf417MacroFileName()

Sets macro Pdf417 barcode file name.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setMacroPdf417FileName().

Source:

setPdf417MacroFileSize(value)

Sets macro Pdf417 file size.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setMacroPdf417FileSize().

Parameters:
Name Type Description
value The file size field contains the size in bytes of the entire source file.
Source:

setPdf417MacroSegmentID()

Sets macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setMacroPdf417SegmentID().

Source:

setPdf417MacroSegmentsCount()

Sets macro Pdf417 barcode segments count.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setMacroPdf417SegmentsCount().

Source:

setPdf417MacroSender()

Sets macro Pdf417 barcode sender name.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setMacroPdf417Sender().

Source:

setPdf417MacroTerminator()

Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment.
Applied only for Macro PDF417.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setMacroPdf417Terminator().

Source:

setPdf417MacroTimeStamp()

Sets macro Pdf417 barcode time stamp.
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setMacroPdf417TimeStamp().

Source:

setPdf417Truncate()

Whether Pdf417 symbology type of BarCode is truncated (to reduce space).
Deprecated: This property is obsolete and will be removed in future releases. Instead, use the setTruncate().

Source:

setReaderInitialization(value)

Used to instruct the reader to interpret the data contained within the symbol
as programming for reader initialization
Parameters:
Name Type Description
value
Source:

setRows()

Rows count.
Source:

setStructuredAppendModeBarcodeId()

Identifies the ID of the DotCode structured append mode barcode. ID starts from 1 and must be less or equal to barcodes count. Default value is -1.

Source:

setTruncate()

Whether Pdf417 symbology type of BarCode is truncated (to reduce space). Also known as CompactPDF417. Rigth row indicator and right stop pattern are removed in this mode.

Source:

toString()

Returns a human-readable string representation of this Pdf417Parameters.
Returns:
Type Description
A string that represents this Pdf417Parameters.
Source: