1
0
Fork 0
freesewing/markdown/dev/reference/api/part/config/measurements/en.md

50 lines
1.1 KiB
Markdown
Raw Normal View History

2022-09-21 09:55:21 +02:00
---
title: Part measurements
---
The `measurements` and `optionalMeasurements` properties on the
part configuration object list the part's required and optional
measurements respectively.
<Tip>You should only include what's required by the part itself, not its dependencies</Tip>
## measurements
2022-12-07 14:20:07 -08:00
The `measurements` property should hold the names of the measurements
2022-09-21 09:55:21 +02:00
that are required to draft the current part.
```js
const part = {
name: 'example.front',
measurements: [ 'head', 'chest' ],
draft: ({ part }) => part
}
```
## optionalMeasurements
2022-12-07 14:20:07 -08:00
The `optionalMeasurements` property should hold the names of the measurements
2022-09-21 09:55:21 +02:00
that are optional to draft the current part.
```js
import { pluginBust } from '@freesewing/plugin-bust'
const part = {
name: 'example.front',
plugins: [ pluginBust ],
measurements: [ 'head', 'chest' ],
optionalMeasurements: [ 'highBust' ],
draft: ({ part }) => part
}
```
<Tip>
Although they are specified via the part configuration `optionalMeasurements`
property, optional measurements are accessed via the 'measurements'
settings property.
(There is no `optionalMeasurements` settings property.)`
</Tip>