banner

The banner macro allows you to add repeating text along a path.

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

Signature

Javascript
macro('banner', {
  String id='banner',
  String className='',
  Number dy=1,
  Number repeat=10,
  Number spaces=12,
  Path path,
  String text,
  Boolean force = false,
})

Example

banner              banner              banner              banner              banner              banner              banner              banner              banner              banner              banner

Configuration

PropertyDefaultTypeDescription
className“stringAny additional CSS classes to apply to the text
dy1numberControls how far the text will be located above the path
idbannerstringThe id of this macro instance
pathPathThe Path to add the text on
repeat10numberThe number of repetitions
spaces12numberThe number of spaces to place between repetitions
textstringThe text to place repeat along the path
forcefalsebooleanSet this to true to display the macro output even when complete is false

Notes

Under the hood, this macro will:

  • Add data-text, data-text-dy, and data-text-class Attributes to the path to generate the text.

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

MacrosbannerBox