Pdf417Parameters
Contents
[
Hide
]Pdf417Parameters class
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
new Pdf417Parameters()
Example:
# 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());
}
Methods
| Name | Description |
|---|---|
| getAspectRatio() | Height/Width ratio of 2D BarCode module. |
| getColumns() | Columns count. |
| getECIEncoding() | Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for |
| getEncodeMode() | Identifies Pdf417 encode mode. Default value: Auto. |
| getErrorLevel() | Gets Pdf417 symbology type of BarCode’s error correction level ranging from level0 to level8, level0 means no error corr |
| getMacroCharacters() | Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with Micro |
| getMacroPdf417Addressee() | MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured A |
| getMacroPdf417Checksum() | MacroPdf417 barcode checksum (optional field). MicroPDF417 barcode checksum (optional field for Structured Append mode) |
| getMacroPdf417ECIEncoding() | Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields. |
| getMacroPdf417FileID() | MacroPdf417 barcode’s file ID (Required field). MicroPDF417 barcode’s file ID (Required field for Structured Append mode |
| getMacroPdf417FileName() | MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode |
| getMacroPdf417FileSize() | MacroPdf417 file size (optional field). MicroPDF417 file size (optional field for Structured Append mode) The file size |
| getMacroPdf417SegmentID() | MacroPdf417 barcode’s segment ID (Required field), which starts from 0, to MacroSegmentsCount - 1. MicroPDF417 barcode’s |
| getMacroPdf417SegmentsCount() | MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured A |
| getMacroPdf417Sender() | MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append |
| getMacroPdf417Terminator() | Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PD |
| getMacroPdf417TimeStamp() | MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mo |
| getPdf417CompactionMode() | Pdf417 symbology type of BarCode’s compaction mode. Default value: Pdf417CompactionMode.AUTO. |
| getPdf417ECIEncoding() | Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for |
| getPdf417EncodeMode() | Identifies Pdf417 encode mode. Default value: Auto. |
| getPdf417ErrorLevel() | Gets Pdf417 symbology type of BarCode’s error correction level ranging from level0 to level8, level0 means no error corr |
| getPdf417MacroAddressee() | Gets macro Pdf417 barcode addressee name. |
| getPdf417MacroChecksum() | Gets macro Pdf417 barcode checksum. |
| getPdf417MacroECIEncoding() | Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields. |
| getPdf417MacroFileID() | Getsmacro Pdf417 barcode’s file ID. Used for MacroPdf417. |
| getPdf417MacroFileName() | Gets macro Pdf417 barcode file name. |
| getPdf417MacroFileSize() | Gets macro Pdf417 file size. |
| getPdf417MacroSegmentID() | Gets macro Pdf417 barcode’s segment ID, which starts from 0, to MacroSegmentsCount - 1. |
| getPdf417MacroSegmentsCount() | Gets macro Pdf417 barcode segments count. |
| getPdf417MacroSender() | Gets macro Pdf417 barcode sender name. |
| getPdf417MacroTerminator() | Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PD |
| getPdf417MacroTimeStamp() | Gets macro Pdf417 barcode time stamp. |
| getPdf417Truncate() | Whether Pdf417 symbology type of BarCode is truncated (to reduce space). |
| getRows() | Rows count. |
| getStructuredAppendModeBarcodeId() | Identifies the ID of the DotCode structured append mode barcode. ID starts from 1 and must be less or equal to barcodes |
| getTruncate() | Whether Pdf417 symbology type of BarCode is truncated (to reduce space). Also known as CompactPDF417. Rigth row indicato |
| isCode128Emulation() | Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and |
| isLinked() | Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907 |
| isReaderInitialization() | Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization |
| setAspectRatio() | Height/Width ratio of 2D BarCode module. |
| setCode128Emulation() | Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and |
| setColumns() | Columns count. |
| setECIEncoding() | Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for |
| setEncodeMode() | Identifies Pdf417 encode mode. Default value: Auto. |
| setErrorLevel(value) | Sets Pdf417 symbology type of BarCode’s error correction level ranging from level0 to level8, level0 means no error corr |
| setLinked() | Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907 |
| setMacroCharacters() | Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with Micro |
| setMacroPdf417Addressee() | MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured A |
| setMacroPdf417Checksum() | MacroPdf417 barcode checksum (optional field). MicroPDF417 barcode checksum (optional field for Structured Append mode) |
| setMacroPdf417ECIEncoding() | Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields. |
| setMacroPdf417FileID() | MacroPdf417 barcode’s file ID (Required field). MicroPDF417 barcode’s file ID (Required field for Structured Append mode |
| setMacroPdf417FileName() | MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode |
| setMacroPdf417FileSize() | MacroPdf417 file size (optional field). MicroPDF417 file size (optional field for Structured Append mode) The file size |
| setMacroPdf417SegmentID() | MacroPdf417 barcode’s segment ID (Required field), which starts from 0, to MacroSegmentsCount - 1. MicroPDF417 barcode’s |
| setMacroPdf417SegmentsCount() | MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured A |
| setMacroPdf417Sender() | MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append |
| setMacroPdf417Terminator() | Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PD |
| setMacroPdf417TimeStamp() | MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mo |
| setPdf417CompactionMode() | Pdf417 symbology type of BarCode’s compaction mode. Default value: Pdf417CompactionMode.AUTO. |
| setPdf417ECIEncoding() | Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for |
| setPdf417EncodeMode() | Identifies Pdf417 encode mode. Default value: Auto. |
| setPdf417ErrorLevel() | Sets Pdf417 symbology type of BarCode’s error correction level ranging from level0 to level8, level0 means no error corr |
| setPdf417MacroAddressee() | Sets macro Pdf417 barcode addressee name. |
| setPdf417MacroChecksum(value) | Sets macro Pdf417 barcode checksum. |
| setPdf417MacroECIEncoding() | Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields. |
| setPdf417MacroFileID() | Sets macro Pdf417 barcode’s file ID. Used for MacroPdf417. |
| setPdf417MacroFileName() | Sets macro Pdf417 barcode file name. |
| setPdf417MacroFileSize(value) | Sets macro Pdf417 file size. |
| setPdf417MacroSegmentID() | Sets macro Pdf417 barcode’s segment ID, which starts from 0, to MacroSegmentsCount - 1. |
| setPdf417MacroSegmentsCount() | Sets macro Pdf417 barcode segments count. |
| setPdf417MacroSender() | Sets macro Pdf417 barcode sender name. |
| setPdf417MacroTerminator() | Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PD |
| setPdf417MacroTimeStamp() | Sets macro Pdf417 barcode time stamp. |
| setPdf417Truncate() | Whether Pdf417 symbology type of BarCode is truncated (to reduce space). |
| setReaderInitialization(value) | Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization |
| setRows() | Rows count. |
| setStructuredAppendModeBarcodeId() | Identifies the ID of the DotCode structured append mode barcode. ID starts from 1 and must be less or equal to barcodes |
| setTruncate() | Whether Pdf417 symbology type of BarCode is truncated (to reduce space). Also known as CompactPDF417. Rigth row indicato |
| toString() | Returns a human-readable string representation of this Pdf417Parameters. |