1
0
Fork 0
freesewing/sites/dev/docs/reference/hooks/presample/readme.mdx

31 lines
605 B
Text
Raw Normal View History

---
title: preSample
---
The `preSample` hook runs just before your pattern is sampled.
2022-09-29 23:43:00 +02:00
## Signature
2022-09-29 23:43:00 +02:00
```js
null hook(Pattern pattern)
```
## Example
```js
pattern.on('preSample', pattern => {
// Mutate the pattern object here
}
```
2022-09-29 23:43:00 +02:00
## Notes
2022-09-29 23:43:00 +02:00
The `preSample` hook is rarely used, but it's there if you need it.
2022-09-29 23:43:00 +02:00
It is triggered just before the start of either:
- the [Pattern.sampleOption()](/reference/api/pattern/sampleoption) method
- the [Pattern.sampleMeasurement()](/reference/api/pattern/samplemeasurement) method
- the [Pattern.sampleModels()](/reference/api/pattern/samplemodels) method