- CSS Classes
Core API
- Design
Path
- Path._curve()
- Path.addClass()
- Path.addText()
- Path.asPathString()
- Path.asRenderProps()
- Path.attr()
- Path.bbox()
- Path.clean()
- Path.clone()
- Path.close()
- Path.combine()
- Path.curve()
- Path.curve_()
- Path.divide()
- Path.edge()
- Path.end()
- Path.hide()
- Path.insop()
- Path.intersects()
- Path.intersectsX()
- Path.intersectsY()
- Path.join()
- Path.length()
- Path.line()
- Path.move()
- Path.noop()
- Path.offset()
- Path.reverse()
- Path.roughLength()
- Path.setClass()
- Path.setHidden()
- Path.setText()
- Path.shiftAlong()
- Path.shiftFractionAlong()
- Path.smurve()
- Path.smurve_()
- Path.split()
- Path.start()
- Path.translate()
- Path.trim()
- Path.unhide()
Point
- Point.addCircle()
- Point.addText()
- Point.angle()
- Point.asRenderProps()
- Point.attr()
- Point.clone()
- Point.copy()
- Point.dist()
- Point.dx()
- Point.dy()
- Point.flipX()
- Point.flipY()
- Point.rotate()
- Point.setCircle()
- Point.setText()
- Point.shift()
- Point.shiftFractionTowards()
- Point.shiftOutwards()
- Point.shiftTowards()
- Point.sitsOn()
- Point.sitsRoughlyOn()
- Point.slope()
- Point.translate()
utils
- utils.applyTransformToPoint()
- utils.beamIntersectsCircle()
- utils.beamIntersectsCurve()
- utils.beamIntersectsX()
- utils.beamIntersectsY()
- utils.beamsIntersect()
- utils.capitalize()
- utils.circlesIntersect()
- utils.combineTransform()
- utils.curveEdge()
- utils.curveIntersectsX()
- utils.curveIntersectsY()
- utils.curvesIntersect()
- utils.deg2rad()
- utils.generateStackTransform()
- utils.getTransformedBounds()
- utils.lineIntersectsCircle()
- utils.lineIntersectsCurve()
- utils.linesIntersect()
- utils.mergeI18n()
- utils.mergeOptions()
- utils.pctBasedOn()
- utils.pointOnBeam()
- utils.pointOnCurve()
- utils.pointOnLine()
- utils.rad2deg()
- utils.round()
- utils.splitCurve()
- utils.stretchToScale()
- utils.units()
Macros
- banner
- bannerBox
- bartack
- bartackAlong
- bartackFractionAlong
- crossBox
- cutOnFold
- flip
- gore
- grainline
- hd
- ld
- miniScale
- mirror
- pd
- pleat
- ringSector
- rmBanner
- rmBannerBox
- rmBartack
- rmBartackAlong
- rmBartackFractionAlong
- rmCrossBox
- rmCutOnFold
- rmGrainline
- rmHd
- rmLd
- rmMiniScale
- rmPd
- rmPleat
- rmRingSector
- rmScaleBox
- rmSewTogether
- rmTitle
- rmVd
- rmaD
- rmaHd
- rmaLd
- rmaPd
- rmaVd
- round
- scalebox
- sewTogether
- sprinkle
- title
- vd
- Measurements
Store Methods
- cutlist.addCut()
- cutlist.removeCut()
- cutlist.setCutOnFold()
- cutlist.setGrain()
- flag.error()
- flag.fixme()
- flag.info()
- flag.note()
- flag.preset()
- flag.tip()
- flag.warn()
- generateMacroIds()
- getMacroIds()
- log.debug()
- log.error()
- log.info()
- log.warn()
- pack()
- removeMacroNodes()
- storeMacroIds()
- unflag.error()
- unflag.fixme()
- unflag.info()
- unflag.note()
- unflag.preset()
- unflag.tip()
- unflag.warn()
- Web of Trust
Pattern.getRenderProps()
Table of contents
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
Javascript
Object pattern.getRenderProps()
Returned object properties
The Pattern.getRenderProps() method returns an object with
the following properties:
| 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 |
settings | The (sets of) settings used to draft the pattern |
stacks | A plain object holding the drafted stacks |
svg | The Svg Object object with the preRender hook applied as Svg.asRenderProps() |
Contents by
- Authors:
- Maintainers:
- Last updated: 2 days, 11 hours ago