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

51 lines
1.1 KiB
Markdown
Raw Normal View History

---
title: miniscale
---
2022-02-20 14:35:50 +01:00
The `miniscale` macro adds a mini _scale box_ to your pattern. This box allows
users to verify their pattern is printed to scale.
The `miniscale` macro is provided by the [scalebox plugin](/reference/plugins/scalebox).
It is the mini version of [the scalebox macro](/reference/macros/scalebox/).
## Signature
```js
macro('miniscale', {
Point at,
Number rotate,
})
```
## Example
<Example caption="An example of the miniscale macro">
```js
({ Point, macro, part }) => {
macro('miniscale', {
at: new Point(0,0),
})
return part
}
```
</Example>
## Configuration
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 |
| `rotate` | 0 | Number | Rotation in degrees |
## Notes
If you inherit a part with a miniscale on it and you'd like to remove all
points and paths generated by the miniscale macro, you can do so by passing
`false` to the macro:
```js
macro('miniscale', false)
```