MaxiCode
MaxiCode is a fixed-size 2D matrix barcode used primarily by UPS for parcel routing.
Mandatory properties
The following properties are available in addition to the common label object properties.
| Property | Type | Description |
|---|---|---|
| type | string | Must be MaxiCode. |
| text | string | Barcode data. May contain dynamic text. |
| mode | integer | Encoding mode. Common values: 2 (structured carrier, numeric zip), 3 (structured carrier, alphanumeric zip), 4 (standard symbol), 5 (full ECC), 6 (reader programming). |
Optional properties
The following properties are available in addition to the common label object properties.
| Property | Type | Description |
|---|---|---|
| fgColor | string | Color of the symbol. May contain dynamic text. Default is black. |
| quietZone | boolean | Enable or disable the quiet zone. Default is true. |
| extraQuietZone | number | Extra quiet zone width added on all sides. |
| symIndex | integer | Symbol index for structured append (1-based). Default is 0 (no structured append). |
| symTotal | integer | Total number of symbols in a structured append sequence. Default is 1. |
Example
{
"type": "MaxiCode",
"x": 10.0,
"y": 10.0,
"text": "Example MaxiCode data",
"mode": 4
}