1
0
Fork 0
freesewing/markdown/dev/reference/api/macros/banner/en.md

31 lines
970 B
Markdown
Raw Normal View History

---
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 part="plugin_banner">Example of the banner macro</Example>
```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: paths.banner,
text: 'banner plugin',
})
```
2022-02-19 08:04:25 +01:00
| Property | Default | Type | Description |
|-------------:|------------|------------|-------------|
| `path` | | `Path` | The Path to add the text on |
| `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 |