PDF417
PDF417 is a stacked linear barcode capable of encoding large amounts of data.
Mandatory properties
The following properties are available in addition to the common label object properties.
| Property | Type | Description |
|---|---|---|
| type | string | Must be PDF417. |
| text | string | Barcode data. May contain dynamic text. |
| barWidth | number | X-dimension: width of the narrowest bar element. |
Optional properties
The following properties are available in addition to the common label object properties.
| Property | Type | Description |
|---|---|---|
| aspect | number | Row height to module width aspect ratio. If omitted, a default aspect is used. |
| rowHeight | number | Fixed row height. Overrides aspect if set. |
| rows | integer | Fixed number of rows. If omitted, chosen automatically. |
| columns | integer | Fixed number of data columns. If omitted, chosen automatically. |
| errorCorrection | integer | Error correction level (0–8). If omitted, chosen automatically based on data size. |
| eci | integer | ECI (Extended Channel Interpretation) value for the data encoding. Common values: 3 (ISO-8859-1), 26 (UTF-8). |
| compact | boolean | If true, use compact PDF417 (omits right-side stop pattern). Default is false. |
| quietZone | boolean | Enable or disable the quiet zone. Default is true. |
| extraQuietZone | number | Extra quiet zone added on all sides. |
| debleed | number | Ink spread compensation. |
| barColor | string | Color of the bars. May contain dynamic text. Default is black. |
Example
{
"type": "PDF417",
"x": 10.0,
"y": 10.0,
"text": "Hello, world!",
"barWidth": 0.5
}