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

38 lines
1.2 KiB
Markdown
Raw Normal View History

---
title: scalebox
---
2022-02-20 14:35:50 +01:00
The `scalebox` macro adds a _scale box_ to your pattern. This box allows
users to verify their pattern is printed to scale.
The `scalebox` macro is provided by the [scalebox plugin](/reference/plugins/scalebox).
<Example part="plugin_scalebox">
Example of the scalebox added by this macro
</Example>
```js
macro('scalebox', {
at: points.anchor
})
```
2022-02-19 08:04:25 +01:00
| Property | Default | Type | Description |
|-------------|---------|---------------------|-------------|
2022-02-20 14:35:50 +01:00
| `at` | | [Point](/reference/api/point) | The point to anchor the _scale box_ on |
| `lead` | FreeSewing | String | The lead text above the title |
2022-02-20 14:35:50 +01:00
| `title` | _pattern name + version_ | String | The title text |
| `text` | (\*) | String | The text below the title |
| `rotate` | 0 | Number | Rotation in degrees |
(\*) `freesewingIsMadeByJoostDeCockAndContributors \n withTheFinancialSupportOfOurPatrons`
## Removing the scalebox
2022-07-31 16:11:50 +02:00
If you inherit a part with a scalebox on it and you'd like to remove all points and paths
generated by the scalebox macro, you can do so by passing `false` to the macro:
```js
macro('scalebox', false)
```