2021-10-17 18:26:00 +02:00
|
|
|
---
|
|
|
|
title: Pattern.getRenderProps()
|
|
|
|
---
|
2021-08-25 16:09:31 +02:00
|
|
|
|
2022-09-20 18:09:28 +02:00
|
|
|
The `Pattern.getRenderProps()` method will return an object that
|
|
|
|
facilitates rendered the pattern by an external renderer such as
|
2021-09-25 17:05:18 +02:00
|
|
|
a React component. It should only be called after calling `Pattern.draft()`.
|
|
|
|
|
|
|
|
## Pattern.getRenderProps() signature
|
|
|
|
|
2021-08-25 16:09:31 +02:00
|
|
|
```js
|
|
|
|
Object pattern.getRenderProps()
|
2022-02-19 08:04:25 +01:00
|
|
|
```
|
2021-08-25 16:09:31 +02:00
|
|
|
|
2022-09-20 18:09:28 +02:00
|
|
|
## Pattern.getRenderProps() example
|
2021-08-25 16:09:31 +02:00
|
|
|
|
2022-09-20 18:09:28 +02:00
|
|
|
```js
|
|
|
|
import { Aaron } from "@freesewing/aaron"
|
|
|
|
import { cisFemaleAdult34 } from "@freesewing/models"
|
2021-09-25 17:05:18 +02:00
|
|
|
|
2022-09-20 18:09:28 +02:00
|
|
|
const pattern = new Aaron({
|
|
|
|
measurements: cisFemaleAdult34
|
|
|
|
})
|
2021-09-25 17:05:18 +02:00
|
|
|
|
2022-09-20 18:09:28 +02:00
|
|
|
const props = pattern.draft().getRenderProps()
|
|
|
|
```
|
2021-09-25 17:05:18 +02:00
|
|
|
|
2022-09-20 18:09:28 +02:00
|
|
|
## Pattern.getRenderProps() returned object
|
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` |
|
|
|
|
| `logs` | The logs generated by the pattern |
|
|
|
|
| `parts` | A plain object holding the drafted parts |
|
|
|
|
| `settings` | The (sets of) settings used to draft the pattern |
|
|
|
|
| `stacks` | A plain object holding the drafted stacks |
|
|
|
|
| `svg` | An [Svg Object](/reference/api/svg/) object with the `preRender` hook applied |
|
2022-12-14 12:52:37 -08:00
|
|
|
| `width` | Width of the drafted pattern in `mm` |
|