freesewing/markdown/dev/reference/macros/scalebox/en.md

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 white inside of the box provides a metric scale, and the black outside of the box provides an imperial scale.

The scalebox macro is is provided by the annotations plugin.

Signature

macro('scalebox', {
  Point at,
  String lead,
  Number rotate,
  String text,
  String title,
})

Example

```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 |
| `lead`      | FreeSewing | String           | The lead text above the title |
| `title`     | _pattern name + version_ | String | The title text |
| `text`      | (\*)    | String              | The text below the title |
| `rotate`    | 0       | Number              | Rotation in degrees |

(\*) `freesewingIsMadeByJoostDeCockAndContributors \n withTheFinancialSupportOfOurPatrons`

## Result

| Generated Element | Description |
|-------------------|-------------|
| `paths.__scaleboxImperial` | Path of the imperial, outer box |
| `paths.__scaleboxMetric` | Path of the metric, inner box |
| `points.__scaleboxLead` | Point anchoring the lead text above the title |
| `points.__scaleboxTitle` | Point anchoring the title text |
| `points.__scaleboxTitle` | Point anchoring the text below the title |
| `points.__scaleboxImperial` | Point anchoring the imperial text |
| `points.__scaleboxMetric` | Point anchoring the metric text |
| `points.__scalebox[Metric/Imperial][Top/Bottom][Left/Right]` | Points for the corners of the boxes |

## 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:

```js
macro('scalebox', false)