title

The title macro adds a title to a pattern part.

It is provided by plugin-annotations, which is part of core-plugins (so it is available by default).

Signature

Javascript
macro('title', {
  String id = 'title',
  String align,
  Boolean append,
  Point at,
  Boolean cutlist
  String nr,
  String prefix,
  Number rotation,
  Number scale,
  String title,
  Boolean force = false,
})

Example

9 The title Example v3 (Person) Sunday, Nov 12, 2023

Configuration

PropertyDefaultTypeDescription
`align’‘left’StringHorizontal text alignment. Valid values: ‘left’, ‘right’, ‘center’
appendfalseBooleanSet this to true to append the nr to any text already set in Point at’s attributes, rather than overwrite it
atPointThe point at which to insert the title
cutlisttrueBooleanWhether to include cutting instructions
idtitlestringThe ID of this macro instance
nrStringThe number of the pattern part
titleStringThe name of the pattern part. If title is not set or is an empty string, this won’t be rendered, and the version will go beneath the nr.
prefixStringA prefix to add to the created points. This allow for more than 1 title per part, as long as you give them a different prefix.
rotation0NumberAn optional rotation in degrees
scale1NumberAn optional scaling factor
forcefalsebooleanSet this to true to display the macro output even when complete is false

Notes

This macro takes the complete setting into account and won’t output anything when both complete and force are false.

sprinklevd