Class Label

Readonlycfg

StaticfromZPL

addressBlock

• addressBlock(o: AddressBlockOpts): Label

  Multiline text block for addresses/blocks (size and lineHeight rounded to min 1)

  Parameters

  • o: AddressBlockOpts

  Returns Label

barcode

• barcode(o: BarcodeOpts): Label

  Add a barcode field

  Parameters

  • o: BarcodeOpts

  Returns Label

box

• box(o: BoxOpts): Label

  Draw a box/line.

  Parameters

  • o: BoxOpts

  Returns Label

  Remarks

  Border thickness is rounded to an integer with a minimum of 1. Corner radius is rounded and clamped between 0 and 8 to match ZPL limits.

caption

• caption(o: CaptionOpts): Label

  Caption text with symmetric h/w and optional wrap width (size rounded to min 1)

  Parameters

  • o: CaptionOpts

  Returns Label

comment

• comment(text: string): Label

  Add a ZPL comment (^FX) - useful for debugging and documentation

  Parameters

  • text: string

  Returns Label

epc

• epc(o: EPCOpts): Label

  EPC encoding convenience method

  Parameters

  • o: EPCOpts

  Returns Label

gs1_128

• gs1_128(o: GS1_128Opts): Label

  Pragmatic GS1-128 helper rendered via Code128

  Parameters

  • o: GS1_128Opts

  Returns Label

image

• image(o: ImageCachedOpts): Label

  Cached asset (~DG + ^XG). Consider pairing with a registry for dedupe.

  Parameters

  • o: ImageCachedOpts

  Returns Label

imageInline

• imageInline(o: ImageInlineOpts): Label

  Inline bitmap (^GF) — fully self-contained

  Parameters

  • o: ImageInlineOpts

  Returns Label

qr

• qr(o: QRCodeOpts): Label

  Convenience QR method using ^BQ under the hood

  Parameters

  • o: QRCodeOpts

  Returns Label

rfid

• rfid(o: RFIDOpts): Label

  RFID field for EPC encoding

  Parameters

  • o: RFIDOpts

  Returns Label

rfidRead

• rfidRead(o: RFIDReadOpts): Label

  Read RFID tag data

  Parameters

  • o: RFIDReadOpts

  Returns Label

setBarcodeDefaults

• setBarcodeDefaults(
      opts: {
          height?: number;
          moduleWidth?: number;
          wideToNarrowRatio?: number;
      },
  ): Label

  Set global barcode module settings (^BY) - affects all subsequent barcodes.

  Parameters

  • opts: { height?: number; moduleWidth?: number; wideToNarrowRatio?: number }

  Returns Label

  Remarks

  Module width, ratio, and height are rounded to integers with a minimum of 1 when provided.

setDefaultFont

• setDefaultFont(
      opts: { family?: FontFamily; height?: number; width?: number },
  ): Label

  Set global default font (^CF) - height/width rounded to ints with a minimum of 1.

  Parameters

  • opts: { family?: FontFamily; height?: number; width?: number }

  Returns Label

text

• text(o: TextOpts): Label

  Add a text field.

  Parameters

  • o: TextOpts

  Returns Label

  Remarks

  Font height/width are rounded to integers with a minimum of 1. Wrap spacing and hanging indent are rounded to integers with a minimum of 0.

toZPL

• toZPL(): string

  Emit the final ZPL string. Untouched tokens re-emit byte-identical.

  Returns string

withMetadata

• withMetadata(meta: Record<string, string | number>): Label

  Add metadata as ZPL comments (^FX) for debugging and traceability

  Parameters

  • meta: Record<string, string | number>

  Returns Label

Staticcreate

• create(opts: LabelOptions): Label

  Create a fresh label (^XA … ^XZ) with basic page setup

  Parameters

  • opts: LabelOptions

  Returns Label

Staticparse

• parse(
      zpl: string | Uint8Array<ArrayBufferLike>,
      dpi?: DPI,
      units?: Units,
  ): Label

  Parse an existing ZPL string/bytes into a fluent Label instance

  Parameters

  • zpl: string | Uint8Array<ArrayBufferLike>
  • dpi: DPI = ...
  • units: Units = Units.Dot

  Returns Label