Shelf Tickets

name

The name of the function's argument

source

Where the argument's value comes from, which decides which of value, field or call is used

value

The value of a CONSTANT argument

field

The field of a FIELD argument

call

The function of a FUNCTION argument

x

The distance from the left of the ticket, in mm

y

The distance from the top of the ticket, in mm

width

The width of the element, in mm

height

The height of the element, in mm

rotation

The rotation of the element, in degrees

zIndex

The stacking order of the element, higher values are shown above lower ones

locked

Whether the element is locked from being moved in the builder

hideWhenEmpty

Whether the element is hidden when it has no content

script

A JavaScript expression that provides the element's content

css

CSS that's scoped to the element

id

The ID of the element, only letters and numbers, used as the el_<id> field of the template

name

A name for the element, shown in the builder

kind

The kind of element, which decides which of field, text, function or custom is used

box

Where the element is placed on the ticket

style

How the element is styled

format

How the element's text is formatted

field

The field shown by a FIELD element

text

The text shown by a TEXT element

function

The function shown by a FUNCTION element

parts

Styles for the parts of a FUNCTION element with a multi-part result, part names must be unique

custom

The script and styles of a CUSTOM element

keys

The ticket fields to use, the first one that isn't empty is shown

fallback

Shown when all of the fields are empty

prefix

Text added before the content when it isn't empty

suffix

Text added after the content when it isn't empty

textCase

Changes the case of the text

name

The function to call

arguments

The arguments passed to the function

version

The version of the layout format

elements

The elements placed on the ticket, element IDs must be unique and functions can only be nested 3 deep

name

The part of the function's result, e.g. cents for SPLIT_CURRENCY

style

How the part is styled, on top of the element's style

fontSize

The font size, in pt, the element's font size is used when not set

fontWeight

The font weight, e.g. 700 for bold

italic

Whether the text is italic

color

The text colour, as a CSS colour

verticalAlign

Where the part sits against the other parts, e.g. TOP to raise the cents

marginLeft

The space before the part, in mm, negative to move it closer to the part before

marginRight

The space after the part, in mm, negative to move the next part closer

minSize

The smallest font size, in pt

maxSize

The largest font size, in pt

maxLines

The most lines the text can wrap onto

fontFamily

The font family, from the template's fonts

fontSize

The font size, in pt

fontWeight

The font weight, e.g. 700 for bold

italic

Whether the text is italic

color

The text colour, as a CSS colour

textAlign

The horizontal alignment of the content

verticalAlign

The vertical alignment of the content

lineHeight

The line height, relative to the font size

backgroundColor

The background colour, as a CSS colour

borderWidth

The border width, in mm

borderColor

The border colour, as a CSS colour

borderRadius

The border radius, in mm

padding

The padding inside the element, in mm

shrinkToFit

Shrinks the font size so the text fits within the element

text

The text to show, {field} is replaced with the field's value and {a|b|"text"} uses the first value that isn't empty