b34a2ee2ed
This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
60 lines
1.7 KiB
Markdown
60 lines
1.7 KiB
Markdown
---
|
|
title: scalebox
|
|
---
|
|
|
|
[](/plugins)
|
|
|
|
[](https://www.npmjs.com/package/@freesewing/plugin-scalebox)
|
|
|
|
[](https://deepscan.io/dashboard#view=project&tid=2114&pid=2993&bid=23256)
|
|
|
|
[](https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-scalebox)
|
|
|
|
The **scalebox** plugin provides [the scalebox macro](/reference/macros/scalebox/):
|
|
|
|
<Example part="plugin_scalebox" caption="An example of the scalebox" design={false} />
|
|
|
|
```js
|
|
let { Point, points, macro } = part.shorthand();
|
|
|
|
points.anchor = new Point(0, 0);
|
|
|
|
macro("scalebox", {
|
|
at: points.anchor
|
|
});
|
|
```
|
|
|
|
<Note>
|
|
|
|
###### Purpose of a scale box
|
|
|
|
A scalebox allows people to verify the pattern is printed at the correct scale
|
|
|
|
</Note>
|
|
|
|
<Tip>
|
|
|
|
The scalebox plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
|
|
|
</Tip>
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @freesewing/plugin-scalebox
|
|
```
|
|
|
|
## Usage
|
|
|
|
Like all [build-time plugins](/guides/plugins/#build-time-plugins), you load them
|
|
by passing them to the [`freesewing.Design`](/reference/api#design) constructor:
|
|
|
|
```js
|
|
import freesewing from "@freesewing/core";
|
|
import scalebox from "@freesewing/plugin-scalebox";
|
|
import config from "../config";
|
|
|
|
const Pattern = new freesewing.Design(config, scalebox);
|
|
```
|
|
|
|
Now you can use [the scalebox macro](/reference/macros/scalebox/) the macro in your parts.
|