SVG
class SVG extends Shape
A Node for drawing and animating SVG images.
If you're not interested in animating SVG, you can use Img instead.
Extended by
IconLatex
Constructors
constructor
Parameters
props: SVGProps
Shape.constructorProperties
absolutePosition
readonly public absolutePosition: SimpleVector2SignalSVG
A helper signal for operating on the position in world space.
Retrieving the position using this signal returns the position in world space. Similarly, setting the position using this signal transforms the new value to local space.
If the new value is a function, the position of this node will be continuously updated to always match the position returned by the function. This can be useful to "pin" the node in a specific place or to make it follow another node's position.
Unlike position, this signal is not compound - it doesn't contain
separate signals for the x and y components.
Deprecated
Use position.abs instead.
Shape.absolutePositionabsoluteRotation
readonly public absoluteRotation: SimpleSignalnumberSVG
A helper signal for operating on the rotation in world space.
Retrieving the rotation using this signal returns the rotation in world space. Similarly, setting the rotation using this signal transforms the new value to local space.
If the new value is a function, the rotation of this node will be continuously updated to always match the rotation returned by the function.
Deprecated
Use rotation.abs instead.
Shape.absoluteRotationabsoluteScale
readonly public absoluteScale: SimpleVector2SignalSVG
A helper signal for operating on the scale in world space.
Retrieving the scale using this signal returns the scale in world space. Similarly, setting the scale using this signal transforms the new value to local space.
If the new value is a function, the scale of this node will be continuously updated to always match the position returned by the function.
Unlike scale, this signal is not compound - it doesn't contain
separate signals for the x and y components.
Deprecated
Use scale.abs instead.
Shape.absoluteScalealignContent
readonly public alignContent: SimpleSignalFlexContentSVG
Shape.alignContentalignItems
readonly public alignItems: SimpleSignalFlexItemsSVG
Shape.alignItemsalignSelf
readonly public alignSelf: SimpleSignalFlexItemsSVG
Shape.alignSelfanchor
readonly public anchor: Vector2SignalSVG
Represents the offset of this node's origin.
By default, the origin of a node is located at its center. The origin serves as the pivot point when rotating and scaling a node, but it doesn't affect the placement of its children.
The value is relative to the size of this node. A value of 1 means as far
to the right/bottom as possible. Here are a few examples of anchors:
[-1, -1]orVector2.topLeft- top left corner[1, -1]orVector2.topRight- top right corner[0, 1]orVector2.bottom- bottom edge[-1, 1]orVector2.bottomLeft- bottom left corner
Shape.anchorantialiased
readonly public antialiased: SimpleSignalbooleanSVG
Shape.antialiasedbasis
readonly public basis: SimpleSignalFlexBasisSVG
Shape.basisbottom
readonly public bottom: LayoutPositionSignalSVG
The position of the bottom edge of this node.
When set, this shortcut property will modify the node's position so that the bottom edge ends up in the given place.
When retrieved, it will return the position of the bottom edge in the parent space.
Inherited fromShape.bottombottomLeft
readonly public bottomLeft: LayoutPositionSignalSVG
The position of the bottom left corner of this node.
When set, this shortcut property will modify the node's position so that the bottom left corner ends up in the given place.
When retrieved, it will return the position of the bottom left corner in the parent space.
Inherited fromShape.bottomLeftbottomRight
readonly public bottomRight: LayoutPositionSignalSVG
The position of the bottom right corner of this node.
When set, this shortcut property will modify the node's position so that the bottom right corner ends up in the given place.
When retrieved, it will return the position of the bottom right corner in the parent space.
Inherited fromShape.bottomRightbowing
readonly public bowing: SimpleSignalnumberSVG
Controls the curve deviation from a straight line.
A value of 0 will cause lines to be perfectly straight. Higher values introduce more curvature.
Inherited fromShape.bowingcache
readonly public cache: SimpleSignalbooleanSVG
Shape.cachecachePadding
readonly public cachePadding: SpacingSignalSVG
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
Shape.cachePaddingchildren
Inherited from Shape.childrenclip
readonly public clip: SimpleSignalbooleanSVG
Shape.clipcomposite
readonly public composite: SimpleSignalbooleanSVG
Shape.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationSVG
Shape.compositeOperationcreationStack
readonly public creationStack?: string
Shape.creationStackdirection
readonly public direction: SimpleSignalFlexDirectionSVG
Shape.directionfill
readonly public fill: CanvasStyleSignalSVG
Shape.fillfillShaders
readonly public fillShaders: SignalPossibleShaderConfigShaderConfig[]SVG
Shape.fillShadersfilters
readonly public filters: FiltersSignalSVG
Shape.filtersfontFamily
readonly public fontFamily: SimpleSignalstringSVG
Shape.fontFamilyfontSize
readonly public fontSize: SimpleSignalnumberSVG
Shape.fontSizefontStyle
readonly public fontStyle: SimpleSignalstringSVG
Shape.fontStylefontWeight
readonly public fontWeight: SimpleSignalnumberSVG
Shape.fontWeightgap
readonly public gap: Vector2LengthSignalSVG
Shape.gapgrow
readonly public grow: SimpleSignalnumberSVG
Shape.growisClass
public isClass: boolean
Shape.isClassjustifyContent
readonly public justifyContent: SimpleSignalFlexContentSVG
Shape.justifyContentkey
readonly public key: string
Shape.keylayout
readonly public layout: SimpleSignalLayoutModeSVG
Shape.layoutlayoutChildren
readonly public layoutChildren: SimpleSignalLayoutModeSVG
Whether this node lays out its own children with flex. Use
canLayoutChildren to read the resolved mode.
Shape.layoutChildrenlayoutSelf
readonly public layoutSelf: SimpleSignalLayoutModeSVG
Whether this node participates in its parent's flex layout. Use
layoutEnabled to read the resolved mode.
Shape.layoutSelfleft
readonly public left: LayoutPositionSignalSVG
The position of the left edge of this node.
When set, this shortcut property will modify the node's position so that the left edge ends up in the given place.
When retrieved, it will return the position of the left edge in the parent space.
Inherited fromShape.leftletterSpacing
readonly public letterSpacing: SimpleSignalnumberSVG
Shape.letterSpacinglineCap
readonly public lineCap: SimpleSignalCanvasLineCapSVG
Shape.lineCaplineDash
readonly public lineDash: SimpleSignalnumber[]SVG
Shape.lineDashlineDashOffset
readonly public lineDashOffset: SimpleSignalnumberSVG
Shape.lineDashOffsetlineHeight
readonly public lineHeight: SimpleSignalLengthSVG
Shape.lineHeightlineJoin
readonly public lineJoin: SimpleSignalCanvasLineJoinSVG
Shape.lineJoinlineWidth
readonly public lineWidth: SimpleSignalnumberSVG
Shape.lineWidthmargin
readonly public margin: SpacingSignalSVG
Shape.marginmaxHeight
readonly public maxHeight: SimpleSignalLengthLimitSVG
Shape.maxHeightmaxWidth
readonly public maxWidth: SimpleSignalLengthLimitSVG
Shape.maxWidthmiddle
readonly public middle: LayoutPositionSignalSVG
The position of the center of this node.
When set, this shortcut property will modify the node's position so that the center ends up in the given place.
If the anchor has not been changed, this will be the same as the
position.
When retrieved, it will return the position of the center in the parent space.
Inherited fromShape.middleminHeight
readonly public minHeight: SimpleSignalLengthLimitSVG
Shape.minHeightminWidth
readonly public minWidth: SimpleSignalLengthLimitSVG
The smallest width flex may shrink this node to. Left unset, a flex item
of a row keeps room for its narrowest content, capped by its own width
and maxWidth; 0 lets it shrink past that, as CSS min-width: 0 does.
Examples
Inherited fromShape.minWidthopacity
readonly public opacity: SimpleSignalnumberSVG
Represents the opacity of this node in the range 0-1.
The value is clamped to the range 0-1.
Inherited fromShape.opacitypadding
readonly public padding: SpacingSignalSVG
Shape.paddingparent
readonly public parent: SimpleSignalNodenullvoid = ...
Shape.parentposition
readonly public position: PositionSignalSVG
Represents the position of this node in local space of its parent.
Examples
Inherited fromShape.positionproperties
readonly public properties: RecordstringPropertyMetadataany = ...
Shape.propertiesratio
readonly public ratio: SimpleSignalnumbernullSVG
Shape.ratioright
readonly public right: LayoutPositionSignalSVG
The position of the right edge of this node.
When set, this shortcut property will modify the node's position so that the right edge ends up in the given place.
When retrieved, it will return the position of the right edge in the parent space.
Inherited fromShape.rightrotation
readonly public rotation: RotationSignalSVG
Represents the rotation (in degrees) of this node relative to its parent.
Inherited fromShape.rotationrough
readonly public rough: SimpleSignalbooleanSVG
Enable rough.js rendering.
Inherited fromShape.roughroughDisableMultiStroke
readonly public roughDisableMultiStroke: SimpleSignalbooleanSVG
Whether to disable multi-stroke rendering.
By default, Rough.js renders strokes with multiple lines for a more sketchy appearance. Set to true to use a single stroke.
Inherited fromShape.roughDisableMultiStrokeroughDisableMultiStrokeFill
readonly public roughDisableMultiStrokeFill: SimpleSignalbooleanSVG
Whether to disable multi-stroke fill.
By default, Rough.js renders fills with multiple passes. Set to true to use a single fill pass.
Inherited fromShape.roughDisableMultiStrokeFillroughFillStyle
readonly public roughFillStyle: SimpleSignalRoughFillStyleSVG
Fill style for the shape.
Inherited fromShape.roughFillStyleroughFillWeight
readonly public roughFillWeight: SimpleSignalnumberundefinedSVG
Thickness of the lines used for filling.
Only applicable for hachure, cross-hatch, and similar fill styles.
Inherited fromShape.roughFillWeightroughHachureAngle
readonly public roughHachureAngle: SimpleSignalnumberSVG
Angle of the hachure lines in degrees.
Only applicable for hachure and cross-hatch fill styles.
Inherited fromShape.roughHachureAngleroughHachureGap
readonly public roughHachureGap: SimpleSignalnumberSVG
Gap between hachure lines in pixels.
Only applicable for hachure, cross-hatch, and similar fill styles.
Inherited fromShape.roughHachureGaproughness
readonly public roughness: SimpleSignalnumberSVG
Numerical value indicating how rough the drawing is.
A value of 0 will produce a smooth shape, while higher values introduce more irregularity. Typical range is 0-10.
Inherited fromShape.roughnessroughSeed
readonly public roughSeed: SimpleSignalnumberundefinedSVG
Seed for the random number generator.
Using the same seed produces consistent results, which is useful for reproducible animations.
Inherited fromShape.roughSeedscale
readonly public scale: ScaleSignalSVG
Represents the scale of this node in local space of its parent.
Examples
Inherited fromShape.scaleshaders
Shape.shadersshadowBlur
readonly public shadowBlur: SimpleSignalnumberSVG
Shape.shadowBlurshadowColor
readonly public shadowColor: ColorSignalSVG
Shape.shadowColorshadowOffset
readonly public shadowOffset: Vector2SignalSVG
Shape.shadowOffsetshrink
readonly public shrink: SimpleSignalnumberSVG
Shape.shrinksize
readonly public size: Vector2LengthSignalSVG
Represents the size of this node.
A size is a two-dimensional vector, where x represents the width, and y
represents the height.
The value of both x and y is of type partials.Length which is
either:
number- the desired length in pixels${number}%- a string with the desired length in percents, for example'50%'null- an automatic length
When retrieving the size, all units are converted to pixels, using the
current state of the layout. For example, retrieving the width set to
'50%', while the parent has a width of 200px will result in the number
100 being returned.
When the node is not part of the layout, setting its size using percents refers to the size of the nearest ancestor that has a size or a layout, which is the entire scene when no other ancestor does.
Examples
Inherited fromShape.sizeskew
readonly public skew: Vector2SignalSVG
Represents the skew of this node in local space of its parent.
Examples
Inherited fromShape.skewstroke
readonly public stroke: CanvasStyleSignalSVG
Shape.strokestrokeFirst
readonly public strokeFirst: SimpleSignalbooleanSVG
Shape.strokeFirststrokeShaders
readonly public strokeShaders: SignalPossibleShaderConfigShaderConfig[]SVG
Shape.strokeShaderssvg
readonly public svg: SimpleSignalstringSVG
SVG string to be rendered
textAlign
readonly public textAlign: SimpleSignalTextAlignSVG
Shape.textAligntextDirection
readonly public textDirection: SimpleSignalCanvasDirectionSVG
Shape.textDirectiontextWrap
readonly public textWrap: SimpleSignalTextWrapSVG
Shape.textWraptop
readonly public top: LayoutPositionSignalSVG
The position of the top edge of this node.
When set, this shortcut property will modify the node's position so that the top edge ends up in the given place.
When retrieved, it will return the position of the top edge in the parent space.
Inherited fromShape.toptopLeft
readonly public topLeft: LayoutPositionSignalSVG
The position of the top left corner of this node.
When set, this shortcut property will modify the node's position so that the top left corner ends up in the given place.
When retrieved, it will return the position of the top left corner in the parent space.
Inherited fromShape.topLefttopRight
readonly public topRight: LayoutPositionSignalSVG
The position of the top right corner of this node.
When set, this shortcut property will modify the node's position so that the top right corner ends up in the given place.
When retrieved, it will return the position of the top right corner in the parent space.
Inherited fromShape.topRighttranslate
readonly public translate: Vector2SignalSVG
A visual offset applied to this node's rendering, analogous to CSS
transform: translate(). Does not affect layout.
Shape.translateverticalAlign
readonly public verticalAlign: SimpleSignalVerticalAlignSVG
Shape.verticalAlignwordBreak
readonly public wordBreak: SimpleSignalWordBreakSVG
Shape.wordBreakwrap
readonly public wrap: SimpleSignalFlexWrapSVG
Shape.wrapwrapper
public wrapper: Node
Child to wrap all SVG node
yogaNode
Inherited from Shape.yogaNodezIndex
readonly public zIndex: SimpleSignalnumberSVG
Shape.zIndexAccessors
columnGap
public get columnGap(): SignalLengthnumberthis
Shape.columnGapheight
public get height(): SignalLengthnumberthis
Shape.heightrowGap
public get rowGap(): SignalLengthnumberthis
Shape.rowGapwidth
public get width(): SignalLengthnumberthis
Shape.widthx
public get x(): PositionComponentSignalthis
Shape.xy
public get y(): PositionComponentSignalthis
Shape.yMethods
[iterator]
public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidunknown
Shape.[iterator]absoluteOpacity
public absoluteOpacity(): number
Shape.absoluteOpacityadd
public addnode: ComponentChildren: this
public addnode: ComponentChildrenduration: numbertiming?: TimingFunctionanimate?: LayoutAnimateCallback: ThreadGenerator
Append a child. With a duration, the call returns a
ThreadGenerator that scales the child into its slot while the
surrounding flex layout reflows; without one, it behaves like
Node.add and returns this.
Parameters
node: ComponentChildren
Shape.addanchorPosition
public anchorPosition(): Vector2
Shape.anchorPositionapplyState
public applyStatestate: NodeState: void
public applyStatestate: NodeStateduration: numbertiming?: TimingFunction: ThreadGenerator
Apply the given state to the node, setting all matching signal values to the provided values.
Parameters
state: NodeStateThe state to apply to the node.
Shape.applyStatecacheBBox
public cacheBBox(): BBox
Get a bounding box for the contents rendered by this node as well as its children.
Inherited fromShape.cacheBBoxcanLayoutChildren
public canLayoutChildren(): boolean
Whether this node lays out its own children with flex. Resolves
layoutChildren, then layout, then the parent's
canLayoutChildren.
Overridden by Txt (and similar leaves) that must not host yoga children.
Shape.canLayoutChildrencanvasFont
public canvasFont(): string
Shape.canvasFontcardinalPoint
Get the cardinal point corresponding to the given origin.
Parameters
Inherited fromShape.cardinalPointchildAs
public childAsindex: number: Tnull
Get the nth children cast to the specified type.
Parameters
index: numberThe index of the child to retrieve.
Shape.childAschildrenAs
public childrenAs(): T[]
Get the children array cast to the specified type.
Inherited fromShape.childrenAsclone
public clonecustomProps: NodeState = {}: this
Create a copy of this node.
Parameters
customProps: NodeState = {}Properties to override.
Shape.clonecompositeToLocal
public compositeToLocal(): DOMMatrix
Shape.compositeToLocalcompositeToWorld
public compositeToWorld(): DOMMatrix
A matrix mapping composite space to world space.
Certain effects such as blur and shadows ignore the current transformation. This matrix can be used to transform their parameters so that the effect appears relative to the closest composite root.
Inherited fromShape.compositeToWorldcomputedPosition
public computedPosition(): Vector2
Shape.computedPositiondispose
public dispose(): void
Prepare this node to be disposed of.
This method is called automatically when a scene is refreshed. It will be called even if the node is not currently attached to the tree.
The goal of this method is to clean any external references to allow the node to be garbage collected.
Inherited fromShape.disposedrawOverlay
public drawOverlaycontext: CanvasRenderingContext2Dmatrix: DOMMatrix: void
Draw an overlay for this node.
The overlay for the currently inspected node is displayed on top of the canvas.
The provided context is in screen space. The local-to-screen matrix can be used to transform all shapes that need to be displayed. This approach allows to keep the line widths and gizmo sizes consistent, no matter how zoomed-in the view is.
Parameters
context: CanvasRenderingContext2DThe context to draw with.
matrix: DOMMatrixA local-to-screen matrix.
Shape.drawOverlayeditLayout
public editLayoutthis: TLayoutduration: numbermutator: node: TLayout => voidtiming: TimingFunction = easeInOutCubicinterpolation: InterpolationFunctionVector2 = Vector2.lerp: ThreadGenerator
Animate a batch of layout-property changes. Children tween from their pre-mutation positions to wherever the post-mutation layout puts them.
Examples
Parameters
this: TLayoutduration: numbermutator: node: TLayout => voidtiming: TimingFunction = easeInOutCubicinterpolation: InterpolationFunctionVector2 = Vector2.lerp
Shape.editLayoutfindAll
Find all descendants of this node that match the given predicate.
Parameters
Inherited fromShape.findAllfindAncestor
Find the closest ancestor of this node that matches the given predicate.
Parameters
Inherited fromShape.findAncestorfindFirst
Find the first descendant of this node that matches the given predicate.
Parameters
Inherited fromShape.findFirstfindLast
Find the last descendant of this node that matches the given predicate.
Parameters
Inherited fromShape.findLastfreezeLayout
public freezeLayout(): void
Snap each laid-out child to its current visual position, then disable
layoutChildren. Pair with thawLayout to bring children back
under flex.
Shape.freezeLayoutgetChildrenById
public getChildrenByIdid: string: Node[]
Get all SVG nodes with the given id.
Parameters
id: stringAn id to query.
getOriginDelta
Parameters
Inherited fromShape.getOriginDeltagetState
public getState(): NodeState
Return a snapshot of the node's current signal values.
This method will calculate the values of any reactive properties of the node at the time the method is called.
Inherited fromShape.getStatehit
Try to find a node intersecting the given position.
Parameters
Inherited fromShape.hitinsert
public insertnode: ComponentChildrenindex: numberduration: numbertiming?: TimingFunctionanimate?: LayoutAnimateCallback: ThreadGenerator
Insert a child at a specific index. With a duration, the call
returns a ThreadGenerator that scales the child into its slot
while the surrounding flex layout reflows; without one, it behaves
like Node.insert and returns this.
Parameters
Inherited fromShape.insertinstantiate
public instantiateprops: NodeProps = {}: this
Create an instance of this node's class.
Parameters
props: NodeProps = {}Properties to pass to the constructor.
Shape.instantiateisLayoutRoot
public isLayoutRoot(): boolean
Shape.isLayoutRootlayoutEnabled
public layoutEnabled(): boolean
Whether this node participates in its parent's flex layout. Resolves
layoutSelf, then layout, then the parent's
canLayoutChildren.
Shape.layoutEnabledlocalToParent
public localToParent(): DOMMatrix
Get the local-to-parent matrix for this node.
This matrix transforms vectors from local space of this node to local space of this node's parent.
Inherited fromShape.localToParentlocalToWorld
public localToWorld(): DOMMatrix
Get the local-to-world matrix for this node.
This matrix transforms vectors from local space of this node to world space.
Examples
Inherited fromShape.localToWorldlockLayout
public lockLayout(): void
Increment the layout lock counter. While positive, this node's
flexGrow / flexShrink are forced to 0, holding its slot in the
parent's flex layout. Pair every call with releaseLayout.
Shape.lockLayoutmorphTo
public morphToother: Nodeduration: numbertiming: TimingFunction = easeInOutCubicinterpolation: InterpolationFunctionVector2 = Vector2.lerp: ThreadGenerator
Cross-fade this Layout into another node. Detaches from the parent's flex layout for the duration of the tween so the slot collapses immediately and siblings glide via FLIP.
Parameters
other: Nodeduration: numbertiming: TimingFunction = easeInOutCubicinterpolation: InterpolationFunctionVector2 = Vector2.lerp
Shape.morphTomove
public moveby: number = 1: this
Rearrange this node in relation to its siblings.
Children are rendered starting from the beginning of the children list. We can change the rendering order by rearranging said list.
A positive by arguments move the node up (it will be rendered on top of
the elements it has passed). Negative values move it down.
Parameters
by: number = 1Number of places by which the node should be moved.
Shape.movemoveAbove
public moveAbovenode: NodedirectlyAbove: boolean = false: this
Move the node above the provided node in the parent's layout.
The node will be moved above the provided node and from then on will be rendered on top of it. By default, if the node is already positioned higher than the sibling node, it will not get moved.
Parameters
node: NodeThe sibling node below which to move.
directlyAbove: boolean = falseWhether the node should be positioned directly above the sibling. When true, will move the node even if it is already positioned above the sibling.
Shape.moveAbovemoveBelow
public moveBelownode: NodedirectlyBelow: boolean = false: this
Move the node below the provided node in the parent's layout.
The node will be moved below the provided node and from then on will be rendered below it. By default, if the node is already positioned lower than the sibling node, it will not get moved.
Parameters
node: NodeThe sibling node below which to move.
directlyBelow: boolean = falseWhether the node should be positioned directly below the sibling. When true, will move the node even if it is already positioned below the sibling.
Shape.moveBelowmoveDown
public moveDown(): this
Move the node down in relation to its siblings.
The node will exchange places with the sibling right below it (if any) and from then on will be rendered under it.
Inherited fromShape.moveDownmoveOffset
Update the offset of this node and adjust the position to keep it in the same place.
Parameters
Inherited fromShape.moveOffsetmoveTo
public moveToindex: number: this
Move the node to the provided position relative to its siblings.
If the node is getting moved to a lower position, it will be placed below the sibling that's currently at the provided index (if any). If the node is getting moved to a higher position, it will be placed above the sibling that's currently at the provided index (if any).
Parameters
index: numberThe index to move the node to.
Shape.moveTomoveToBottom
public moveToBottom(): this
Move the node to the bottom in relation to its siblings.
The node will be placed at the beginning of the children list and from then on will be rendered below all of its siblings.
Inherited fromShape.moveToBottommoveToTop
public moveToTop(): this
Move the node to the top in relation to its siblings.
The node will be placed at the end of the children list and from then on will be rendered on top of all of its siblings.
Inherited fromShape.moveToTopmoveUp
public moveUp(): this
Move the node up in relation to its siblings.
The node will exchange places with the sibling right above it (if any) and from then on will be rendered on top of it.
Inherited fromShape.moveUpparentAs
public parentAs(): Tnull
Get the parent cast to the specified type.
Inherited fromShape.parentAsparentToWorld
public parentToWorld(): DOMMatrix
Get the parent-to-world matrix for this node.
This matrix transforms vectors from local space of this node's parent to world space.
Inherited fromShape.parentToWorldpeekChildren
public peekChildren(): readonly Node[]
Get the current children of this node.
Unlike children, this method does not have any side effects.
It does not register the children signal as a dependency, and it does not
spawn any children. It can be used to safely retrieve the current state of
the scene graph for debugging purposes.
Shape.peekChildrenreactiveClone
public reactiveClonecustomProps: NodeState = {}: this
Create a reactive copy of this node.
A reactive copy has all its properties dynamically updated to match the source node.
Parameters
customProps: NodeState = {}Properties to override.
Shape.reactiveClonereleaseLayout
public releaseLayout(): void
Decrement the layout lock counter.
Inherited fromShape.releaseLayoutremove
public remove(): this
public removeduration: numbertiming?: TimingFunctionanimate?: LayoutAnimateCallback: ThreadGenerator
Remove this node from its parent. With a duration and a Layout
parent, the call returns a ThreadGenerator that scales the node
out as its slot collapses; without one (or with a non-Layout
parent), it behaves like Node.remove and returns this.
Shape.removeremoveChildren
public removeChildren(): this
Remove all children of this node.
Inherited fromShape.removeChildrenrender
public rendercontext: CanvasRenderingContext2D: void
Render this node onto the given canvas.
Parameters
context: CanvasRenderingContext2DThe context to draw with.
Shape.renderreparent
public reparentnewParent: Node: this
Change the parent of this node while keeping the absolute transform.
After performing this operation, the node will stay in the same place visually, but its parent will be changed.
Parameters
newParent: NodeThe new parent of this node.
Shape.reparentresolvedLineHeight
public resolvedLineHeight(): number
Shape.resolvedLineHeightrestore
public restore(): void
public restoreduration: numbertiming?: TimingFunction: ThreadGenerator
Restore the node to its last saved state.
This method can be used together with the save method to restore a
node to a previously saved state. Restoring a node to a previous state
removes that state from the state stack.
Examples
Inherited fromShape.restoreripple
public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany
Parameters
duration: number = 1
Shape.ripplesave
public save(): void
Push a snapshot of the node's current state onto the node's state stack.
This method can be used together with the restore method to save a
node's current state and later restore it. It is possible to store more
than one state by calling save method multiple times.
Shape.savesnapshotClone
public snapshotClonecustomProps: NodeState = {}: this
Create a copy of this node.
Unlike clone, a snapshot clone calculates any reactive properties
at the moment of cloning and passes the raw values to the copy.
Parameters
customProps: NodeState = {}Properties to override.
Shape.snapshotClonethawLayout
public thawLayoutduration: numbertiming: TimingFunction = easeInOutCubicinterpolation: InterpolationFunctionVector2 = Vector2.lerp: ThreadGenerator
Re-enable layoutChildren and animate each child from its manual
position to wherever the flex layout now places it.
Parameters
duration: numbertiming: TimingFunction = easeInOutCubicinterpolation: InterpolationFunctionVector2 = Vector2.lerp
Shape.thawLayouttoPromise
public toPromise(): PromiseSVG
Wait for any asynchronous resources that this node or its children have.
Certain resources like images are always loaded asynchronously. Awaiting this method makes sure that all such resources are done loading before continuing the animation.
Inherited fromShape.toPromisetransitionTo
public transitionTonewParent: NodeindexOrDuration: numberdurationOrTiming?: numberTimingFunctiontiming: TimingFunction = easeInOutCubicinterpolation: InterpolationFunctionVector2 = Vector2.lerp: ThreadGenerator
Move this Layout into a new parent, smoothly shrinking the slot in the old parent and growing the slot in the new parent.
Parameters
newParent: NodeindexOrDuration: numberdurationOrTiming?: numberTimingFunctiontiming: TimingFunction = easeInOutCubicinterpolation: InterpolationFunctionVector2 = Vector2.lerp
Shape.transitionToview
public view(): View2D
Shape.viewworldToLocal
public worldToLocal(): DOMMatrix
Get the world-to-local matrix for this node.
This matrix transforms vectors from world space to local space of this node.
Examples
Inherited fromShape.worldToLocalworldToParent
public worldToParent(): DOMMatrix
Get the world-to-parent matrix for this node.
This matrix transforms vectors from world space to local space of this node's parent.
Inherited fromShape.worldToParent