1
0
Fork 0
freesewing/markdown/dev/reference/macros/miniscale/en.md
2022-09-30 15:34:59 +02:00

1.1 KiB

title
miniscale

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. It is the mini version of the scalebox macro.

Signature

macro('miniscale', {
  Point at,
  Number rotate,
})

Example

```js ({ Point, macro, part }) => {

macro('miniscale', { at: new Point(0,0), })

return part }

</Example>

## Configuration

| Property    | Default | Type                | Description |
|-------------|---------|---------------------|-------------|
| `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)