The Pattern.getRenderProps() method will return an object that facilitates rendering the pattern by an external renderer such as our Pattern React component. It should only be called after calling Pattern.draft().

Pattern.getRenderProps() signature

Object pattern.getRenderProps()

Returned object properties

The Pattern.getRenderProps() method returns an object with the following properties:

autoLayoutAn object describing the (automated) pattern layout
heightHeight of the drafted pattern in mm
widthWidth of the drafted pattern in mm
settingsThe (sets of) settings used to draft the pattern
stacksA plain object holding the drafted stacks
svgThe Svg Object object with the preRender hook applied as Svg.asRenderProps()