1
0
Fork 0

chore(markdown): Work on macro reference docs

This commit is contained in:
Joost De Cock 2022-09-30 04:39:30 +02:00
parent 403f0c45c2
commit cfef146fd3
13 changed files with 416 additions and 129 deletions

View file

@ -2,21 +2,43 @@
title: scalebox
---
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 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).
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>
## Signature
```js
macro('scalebox', {
at: points.anchor
Point at,
String lead,
Number rotate,
String text,
String title,
})
```
## Example
<Example caption="An example of the scalebox macro">
```js
({ Point, macro, part }) => {
macro('scalebox', {
at: new Point(0,0),
title: 'This is the title',
number: 666,
})
return part
}
```
</Example>
## Configuration
| Property | Default | Type | Description |
|-------------|---------|---------------------|-------------|
| `at` | | [Point](/reference/api/point) | The point to anchor the _scale box_ on |
@ -27,7 +49,9 @@ macro('scalebox', {
(\*) `freesewingIsMadeByJoostDeCockAndContributors \n withTheFinancialSupportOfOurPatrons`
## Removing the scalebox
## Notes
### Removing the scalebox
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: