DocsObject referenceView source

Number Variable

A number. '{{<id>}}' inserts it as text using 'format'; 'var:<id>' as a whole field supplies the number itself (chart values, font sizes).

Metadata

Definition: #/$defs/NumberVariable
Type: object
Source: spec/schemas/opf.schema.json

Field index

Field	Type	Req.	Description
type	const	yes	Variable kind. One of color, text, number, date, image, url or list.
value	number	—	Number this variable resolves to.
required	boolean	—	Whether the variable must be filled. Defaults to true: a variable with no 'value' is unfilled, and an unfilled required variable is an error in a normal deck and expected in a template. Set false for an optional slot: an unfilled optional variable resolves to empty text (inline…
label	string	—	Optional short human label for forms and fill panels.
description	string	—	Optional prose describing what the variable is for, surfaced by pickers, fill forms and agents.
example	number	—	Illustrative number shown in fill forms and used when a template is previewed with examples. Never written to output.
format	ref:NumberFormat	—	Display pattern used by '{{<id>}}' (the shared NumberFormat syntax). A literal prefix, a numeric part of '#', '0', ',' and '.', and a literal suffix. '0' pads digits, '#' is optional, ',' groups thousands, digits after '.' fix the decimals ('0' required, '#' optional), and a '%'…

`type`

typeconstrequiredyesdefault—

Variable kind. One of color, text, number, date, image, url or list.

type.json

{
  "type": "number"
}

`value`

typenumberrequirednodefault—

Number this variable resolves to.

value.json

{
  "value": 1
}

`required`

typebooleanrequirednodefaulttrue

Whether the variable must be filled. Defaults to true: a variable with no 'value' is unfilled, and an unfilled required variable is an error in a normal deck and expected in a template. Set false for an optional slot: an unfilled optional variable resolves to empty text (inline…

required.json

{
  "required": true
}

`label`

typestringrequirednodefault—

Optional short human label for forms and fill panels.

label.json

{
  "label": "label-value"
}

`description`

typestringrequirednodefault—

Optional prose describing what the variable is for, surfaced by pickers, fill forms and agents.

description.json

{
  "description": "description-value"
}

`example`

typenumberrequirednodefault—

Illustrative number shown in fill forms and used when a template is previewed with examples. Never written to output.

example.json

{
  "example": 1
}

`format`

typeref:NumberFormatrequirednodefault—

Display pattern used by '{{<id>}}' (the shared NumberFormat syntax). A literal prefix, a numeric part of '#', '0', ',' and '.', and a literal suffix. '0' pads digits, '#' is optional, ',' groups thousands, digits after '.' fix the decimals ('0' required, '#' optional), and a '%'…

format.json

{
  "format": "format-value"
}