Skip to content

@burnmark-io/designer-core


@burnmark-io/designer-core / SheetTemplate

Interface: SheetTemplate

Defined in: packages/core/src/export/sheet.ts:34

Sticker-sheet template — paper size, label size, one or more grid layouts. Structurally compatible with @burnmark-io/sheet-templates so objects from that package pass directly to exportSheet without conversion.

Fields marked "UI metadata" are carried through but not consumed by exportSheet. Applications that need round cut guides, non-printing label margins, or category filters draw/filter them themselves.

Properties

code

code: string

Defined in: packages/core/src/export/sheet.ts:35


cornerRadiusMm?

optional cornerRadiusMm?: number

Defined in: packages/core/src/export/sheet.ts:52

UI metadata — corner radius for rectangle labels. Not consumed.


labelHeightMm

labelHeightMm: number

Defined in: packages/core/src/export/sheet.ts:46


labelShape?

optional labelShape?: "rectangle" | "ellipse" | "round"

Defined in: packages/core/src/export/sheet.ts:50

UI metadata — shape hint for cut guides. Not consumed by exportSheet.


labelWidthMm

labelWidthMm: number

Defined in: packages/core/src/export/sheet.ts:45


layouts

layouts: SheetLayout[]

Defined in: packages/core/src/export/sheet.ts:48

One or more grid layouts; positions from all layouts are union-sorted.


marginMm?

optional marginMm?: number

Defined in: packages/core/src/export/sheet.ts:54

UI metadata — non-printing margin inside each label. Not consumed.


name

name: string

Defined in: packages/core/src/export/sheet.ts:36


paperHeightMm

paperHeightMm: number

Defined in: packages/core/src/export/sheet.ts:44


paperSize

paperSize: string

Defined in: packages/core/src/export/sheet.ts:42

Paper size name (e.g. 'A4', 'Letter', 'A3', 'Legal'). Free-form so sheet-templates can carry any name; the exporter uses paperWidthMm / paperHeightMm for the actual page.


paperWidthMm

paperWidthMm: number

Defined in: packages/core/src/export/sheet.ts:43

Not affiliated with Dymo, Brother, Avery, or any hardware vendor.