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

30 lines
975 B
Markdown
Raw Normal View History

---
title: Pattern.getRenderProps()
---
2022-09-20 18:09:28 +02:00
The `Pattern.getRenderProps()` method will return an object that
facilitates rendering the pattern by an external renderer such as
[our Pattern React component](/fixme).
It should only be called after calling `Pattern.draft()`.
2021-09-25 17:05:18 +02:00
## Pattern.getRenderProps() signature
```js
Object pattern.getRenderProps()
2022-02-19 08:04:25 +01:00
```
## Returned object properties
2021-09-25 17:05:18 +02:00
2022-09-20 18:09:28 +02:00
The `Pattern.getRenderProps()` method returns an object with
the following properties:
2021-09-25 17:05:18 +02:00
2022-09-20 18:09:28 +02:00
| Property | Description |
| --------:| ----------- |
| `autoLayout` | An object describing the (automated) pattern layout |
| `height` | Height of the drafted pattern in `mm` |
| `width` | Width of the drafted pattern in `mm` |
2022-09-20 18:09:28 +02:00
| `settings` | The (sets of) settings used to draft the pattern |
| `stacks` | A plain object holding the drafted stacks |
| `svg` | The [Svg Object](/reference/api/svg/) object with the `preRender` hook applied as [Svg.asRenderProps()](/reference/api/svg/asrenderprops) |