From 8e44616fb50a7dbe0b24a4b9de191616f289efe3 Mon Sep 17 00:00:00 2001 From: Joost De Cock Date: Sun, 16 Jan 2022 17:31:25 +0100 Subject: [PATCH] fix(markdown): Added missing docs for banner macro --- .../dev/reference/api/macros/banner/en.md | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 markdown/dev/reference/api/macros/banner/en.md diff --git a/markdown/dev/reference/api/macros/banner/en.md b/markdown/dev/reference/api/macros/banner/en.md new file mode 100644 index 00000000000..da35e12af7d --- /dev/null +++ b/markdown/dev/reference/api/macros/banner/en.md @@ -0,0 +1,29 @@ +--- +title: banner +--- + +The `banner` macro allows you to add repeating text along a path. +It is provided by the [banner plugin](/reference/plugins/banner). + +Example of the banner macro + +```js +points.from = new Point(0,0) +points.to = new Point(320,0) + +paths.banner = new Path() + .move(points.from) + .line(points.to) + +macro('banner', { + path: 'banner', + text: 'banner plugin', +}) +``` + +| Property | Default | Type | Description | +|-------------:|------------|------------|-------------| +| `text` | | `text` | The text to place repeat along the path | +| `dy` | `1` | `number` | Controls how far the text will be located above the path | +| `spaces` | `12` | `number` | The number of spaces to place between repetitions | +| `repeat` | `10` | `number` | The number of repetitions |