1
0
Fork 0
freesewing/markdown/dev/reference/api/pattern/en.md

48 lines
1.7 KiB
Markdown
Raw Normal View History

---
title: Pattern
order: 15
---
The `Pattern` object in FreeSewing's core library holds all data and logic of a pattern.
2021-09-25 17:05:18 +02:00
It is the parametric blueprint that when instantiated with a user's measurements and
objects will generated a made-to-measure pattern.
## Pattern constructor
```js
function freesewing.Pattern(object settings)
```
A pattern is instantiated by passing a [settings object](/reference/api/settings/) to the pattern constructor.
2021-09-25 17:05:18 +02:00
This settings objects holds, amongst other things, the measurements and options chosen by the user.
Refer to the [settings documentation](/reference/api/settings/) for an exhaustive list.
2021-09-25 17:05:18 +02:00
2021-09-25 17:05:18 +02:00
## Pattern properties
| Property | Description |
| --------:| ----------- |
| `config` | The pattern configuration |
| `is` | A string that will be set to `draft` or `sample` when you respectively draft or sample a pattern. |
| `options` | The options as set by the user |
| `parts` | A plain object to hold your parts |
| `Part` | The [Part](/reference/api/part) constructor |
2021-09-25 17:05:18 +02:00
| `settings` | The settings as set by the user |
| `store` | A [Store](/reference/api/store) instance |
| `svg` | An [Svg](/reference/api/svg) instance |
- `settings` : The settings as set by the user
- `options` : the options as set by the user
- `config` : The pattern configuration
- `parts` : A plain object to hold your parts
- `Part` : The [Part](/reference/api/part) constructor
- `store` : A [Store](/reference/api/store) instance
- `svg` : An [Svg](/reference/api/svg) instance
- `is` : A string that will be set to `draft` or `sample` when you respectively draft or sample a pattern.
This allows plugins that hook into your pattern to determine what to do in a given scenario.
2021-09-25 17:05:18 +02:00
## Pattern methods
<ReadMore list />