1
0
Fork 0

Merge pull request #3978 from BenJamesBen/sample-setting

chore(docs): Move sample setting docs from Pattern.sample() to its own doc
This commit is contained in:
Joost De Cock 2023-05-18 08:48:27 +02:00 committed by GitHub
commit 58c9da608d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 49 additions and 8 deletions

View file

@ -0,0 +1,47 @@
---
title: sample
---
The `sample` setting holds an object that is used by pass information
to the [`Pattern.sample()`][1] method.
[1]: /reference/api/pattern/sample
## Signature
```js
const settings = {
Object sample = {}
}
```
## Example
```js
import { Aaron } from "@freesewing/aaron"
const pattern = new Aaron({
settings = {
Object sample = {
type: 'option',
option: 'headEase',
}
}
})
```
## Notes
The `sample` setting object can hold the following properties:
- __type__: One of `option`, `measurement`, or `models`
- __option__: An option name as defined in the pattern config file (only used when `type` is option).
- __measurement__: A measurement name as defined in the pattern config file (only used when `type` is measurement).
- __models__: A plain object of different models where the key is the model name and the value an object with the required measurements.
<Related>
Please see the [`Pattern.sample()`][1] documentation for more information
about pattern sampling.
</Related>