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

35 lines
1 KiB
Markdown
Raw Normal View History

---
title: grainline
---
2022-02-20 14:35:50 +01:00
The `grainline` macro adds a _grainline_ indicator to your pattern.\
It is provided by the [grainline plugin](/reference/plugins/grainline/).
<Example part="plugin_grainline">
Example of the grainline indicator added by this macro
</Example>
```js
macro("grainline", {
from: points.grainlineFrom,
to: points.grainlineTo,
2022-01-18 10:13:16 +01:00
})
```
2022-02-19 08:04:25 +01:00
| Property | Default | Type | Description |
|------------:|-------------|------------|----------------------------------------------|
2022-02-20 14:35:50 +01:00
| `from` | | [Point][1] | The startpoint of the _grainline_ indicator |
| `to` | | [Point][1] | The endpoint of the _grainline_ indicator |
| `text` | 'grainline' | string | The text to put on the _grainline_ indicator |
[1]: /reference/api/point
## Removing the grainline indicator
If you inherit a part with a grainline indicator and you'd like to remove it,
you can do so by passing `false` to the macro:
```js
macro('grainline', false)
```