Skip to main content

Icon

class Icon extends SVG

An Icon Component that provides easy access to over 150k icons. See https://icones.js.org/collection/all for all available Icons.

Constructors​

constructor​

public override new Iconprops: IconProps: Icon

Parameters

Overwrites SVG.constructor

Properties​

absolutePosition​

readonly public absolutePosition: SimpleVector2SignalIcon

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.

Inherited from SVG.absolutePosition

absoluteRotation​

readonly public absoluteRotation: SimpleSignalnumberIcon

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.

Inherited from SVG.absoluteRotation

absoluteScale​

readonly public absoluteScale: SimpleVector2SignalIcon

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.

Inherited from SVG.absoluteScale

alignContent​

readonly public alignContent: SimpleSignalFlexContentIcon
Inherited from SVG.alignContent

alignItems​

readonly public alignItems: SimpleSignalFlexItemsIcon
Inherited from SVG.alignItems

alignSelf​

readonly public alignSelf: SimpleSignalFlexItemsIcon
Inherited from SVG.alignSelf

anchor​

readonly public anchor: Vector2SignalIcon

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] or Vector2.topLeft - top left corner
  • [1, -1] or Vector2.topRight - top right corner
  • [0, 1] or Vector2.bottom - bottom edge
  • [-1, 1] or Vector2.bottomLeft - bottom left corner
Inherited from SVG.anchor

antialiased​

readonly public antialiased: SimpleSignalbooleanIcon
Inherited from SVG.antialiased

basis​

readonly public basis: SimpleSignalFlexBasisIcon
Inherited from SVG.basis

bottom​

readonly public bottom: LayoutPositionSignalIcon

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 from SVG.bottom

bottomLeft​

readonly public bottomLeft: LayoutPositionSignalIcon

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 from SVG.bottomLeft

bottomRight​

readonly public bottomRight: LayoutPositionSignalIcon

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 from SVG.bottomRight

bowing​

readonly public bowing: SimpleSignalnumberIcon

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 from SVG.bowing

cache​

readonly public cache: SimpleSignalbooleanIcon
Inherited from SVG.cache

cachePadding​

readonly public cachePadding: SpacingSignalIcon

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.

Inherited from SVG.cachePadding

children​

readonly public children: SignalComponentChildrenNode[]Icon
Inherited from SVG.children

clip​

readonly public clip: SimpleSignalbooleanIcon
Inherited from SVG.clip

color​

readonly public color: ColorSignalIcon

The color of the icon

Provide the color in one of the following formats:

  • named color like red, darkgray, …
  • hexadecimal string with # like #bada55, #141414 Value can be either RGB or RGBA: #bada55, #bada55aa (latter is partially transparent) The shorthand version (e.g. #abc for #aabbcc is also possible.)
Default Value: ```ts 'white' ```

composite​

readonly public composite: SimpleSignalbooleanIcon
Inherited from SVG.composite

compositeOperation​

readonly public compositeOperation: SimpleSignalGlobalCompositeOperationIcon
Inherited from SVG.compositeOperation

creationStack​

readonly public creationStack?: string
Inherited from SVG.creationStack

direction​

readonly public direction: SimpleSignalFlexDirectionIcon
Inherited from SVG.direction

fill​

readonly public fill: CanvasStyleSignalIcon
Inherited from SVG.fill

fillShaders​

readonly public fillShaders: SignalPossibleShaderConfigShaderConfig[]Icon
Experimental
This is an experimental feature. The behavior and API may change drastically between minor releases.
Inherited from SVG.fillShaders

filters​

readonly public filters: FiltersSignalIcon
Inherited from SVG.filters

fontFamily​

readonly public fontFamily: SimpleSignalstringIcon
Inherited from SVG.fontFamily

fontSize​

readonly public fontSize: SimpleSignalnumberIcon
Inherited from SVG.fontSize

fontStyle​

readonly public fontStyle: SimpleSignalstringIcon
Inherited from SVG.fontStyle

fontWeight​

readonly public fontWeight: SimpleSignalnumberIcon
Inherited from SVG.fontWeight

gap​

readonly public gap: Vector2LengthSignalIcon
Inherited from SVG.gap

grow​

readonly public grow: SimpleSignalnumberIcon
Inherited from SVG.grow

icon​

readonly public icon: SimpleSignalstringIcon

The identifier of the icon.

You can find identifiers on Icônes. They can look like this:

  • mdi:language-typescript
  • ph:anchor-simple-bold
  • ph:activity-bold

isClass​

public isClass: boolean
Inherited from SVG.isClass

justifyContent​

readonly public justifyContent: SimpleSignalFlexContentIcon
Inherited from SVG.justifyContent

key​

readonly public key: string
Inherited from SVG.key

layout​

readonly public layout: SimpleSignalLayoutModeIcon
Inherited from SVG.layout

layoutChildren​

readonly public layoutChildren: SimpleSignalLayoutModeIcon

Whether this node lays out its own children with flex. Use canLayoutChildren to read the resolved mode.

Inherited from SVG.layoutChildren

layoutSelf​

readonly public layoutSelf: SimpleSignalLayoutModeIcon

Whether this node participates in its parent's flex layout. Use layoutEnabled to read the resolved mode.

Inherited from SVG.layoutSelf

left​

readonly public left: LayoutPositionSignalIcon

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 from SVG.left

letterSpacing​

readonly public letterSpacing: SimpleSignalnumberIcon
Inherited from SVG.letterSpacing

lineCap​

readonly public lineCap: SimpleSignalCanvasLineCapIcon
Inherited from SVG.lineCap

lineDash​

readonly public lineDash: SimpleSignalnumber[]Icon
Inherited from SVG.lineDash

lineDashOffset​

readonly public lineDashOffset: SimpleSignalnumberIcon
Inherited from SVG.lineDashOffset

lineHeight​

readonly public lineHeight: SimpleSignalLengthIcon
Inherited from SVG.lineHeight

lineJoin​

readonly public lineJoin: SimpleSignalCanvasLineJoinIcon
Inherited from SVG.lineJoin

lineWidth​

readonly public lineWidth: SimpleSignalnumberIcon
Inherited from SVG.lineWidth

margin​

readonly public margin: SpacingSignalIcon
Inherited from SVG.margin

maxHeight​

readonly public maxHeight: SimpleSignalLengthLimitIcon
Inherited from SVG.maxHeight

maxWidth​

readonly public maxWidth: SimpleSignalLengthLimitIcon
Inherited from SVG.maxWidth

middle​

readonly public middle: LayoutPositionSignalIcon

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 from SVG.middle

minHeight​

readonly public minHeight: SimpleSignalLengthLimitIcon
Inherited from SVG.minHeight

minWidth​

readonly public minWidth: SimpleSignalLengthLimitIcon

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 from SVG.minWidth

opacity​

readonly public opacity: SimpleSignalnumberIcon

Represents the opacity of this node in the range 0-1.

The value is clamped to the range 0-1.

Inherited from SVG.opacity

padding​

readonly public padding: SpacingSignalIcon
Inherited from SVG.padding

parent​

readonly public parent: SimpleSignalNodenullvoid = ...
Inherited from SVG.parent

position​

readonly public position: PositionSignalIcon

Represents the position of this node in local space of its parent.

Examples

Inherited from SVG.position

properties​

readonly public properties: RecordstringPropertyMetadataany = ...
Inherited from SVG.properties

ratio​

readonly public ratio: SimpleSignalnumbernullIcon
Inherited from SVG.ratio
readonly public right: LayoutPositionSignalIcon

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 from SVG.right

rotation​

readonly public rotation: RotationSignalIcon

Represents the rotation (in degrees) of this node relative to its parent.

Inherited from SVG.rotation

rough​

readonly public rough: SimpleSignalbooleanIcon

Enable rough.js rendering.

Inherited from SVG.rough

roughDisableMultiStroke​

readonly public roughDisableMultiStroke: SimpleSignalbooleanIcon

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 from SVG.roughDisableMultiStroke

roughDisableMultiStrokeFill​

readonly public roughDisableMultiStrokeFill: SimpleSignalbooleanIcon

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 from SVG.roughDisableMultiStrokeFill

roughFillStyle​

readonly public roughFillStyle: SimpleSignalRoughFillStyleIcon

Fill style for the shape.

Inherited from SVG.roughFillStyle

roughFillWeight​

readonly public roughFillWeight: SimpleSignalnumberundefinedIcon

Thickness of the lines used for filling.

Only applicable for hachure, cross-hatch, and similar fill styles.

Inherited from SVG.roughFillWeight

roughHachureAngle​

readonly public roughHachureAngle: SimpleSignalnumberIcon

Angle of the hachure lines in degrees.

Only applicable for hachure and cross-hatch fill styles.

Inherited from SVG.roughHachureAngle

roughHachureGap​

readonly public roughHachureGap: SimpleSignalnumberIcon

Gap between hachure lines in pixels.

Only applicable for hachure, cross-hatch, and similar fill styles.

Inherited from SVG.roughHachureGap

roughness​

readonly public roughness: SimpleSignalnumberIcon

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 from SVG.roughness

roughSeed​

readonly public roughSeed: SimpleSignalnumberundefinedIcon

Seed for the random number generator.

Using the same seed produces consistent results, which is useful for reproducible animations.

Inherited from SVG.roughSeed

scale​

readonly public scale: ScaleSignalIcon

Represents the scale of this node in local space of its parent.

Examples

Inherited from SVG.scale

shaders​

readonly public shaders: SignalPossibleShaderConfigShaderConfig[]Icon
Experimental
This is an experimental feature. The behavior and API may change drastically between minor releases.
Inherited from SVG.shaders

shadowBlur​

readonly public shadowBlur: SimpleSignalnumberIcon
Inherited from SVG.shadowBlur

shadowColor​

readonly public shadowColor: ColorSignalIcon
Inherited from SVG.shadowColor

shadowOffset​

readonly public shadowOffset: Vector2SignalIcon
Inherited from SVG.shadowOffset

shrink​

readonly public shrink: SimpleSignalnumberIcon
Inherited from SVG.shrink

size​

readonly public size: Vector2LengthSignalIcon

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 from SVG.size

skew​

readonly public skew: Vector2SignalIcon

Represents the skew of this node in local space of its parent.

Examples

Inherited from SVG.skew

stroke​

readonly public stroke: CanvasStyleSignalIcon
Inherited from SVG.stroke

strokeFirst​

readonly public strokeFirst: SimpleSignalbooleanIcon
Inherited from SVG.strokeFirst

strokeShaders​

readonly public strokeShaders: SignalPossibleShaderConfigShaderConfig[]Icon
Experimental
This is an experimental feature. The behavior and API may change drastically between minor releases.
Inherited from SVG.strokeShaders

svg​

readonly public svg: SimpleSignalstringIcon

SVG string to be rendered

Inherited from SVG.svg

textAlign​

readonly public textAlign: SimpleSignalTextAlignIcon
Inherited from SVG.textAlign

textDirection​

readonly public textDirection: SimpleSignalCanvasDirectionIcon
Inherited from SVG.textDirection

textWrap​

readonly public textWrap: SimpleSignalTextWrapIcon
Inherited from SVG.textWrap

top​

readonly public top: LayoutPositionSignalIcon

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 from SVG.top

topLeft​

readonly public topLeft: LayoutPositionSignalIcon

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 from SVG.topLeft

topRight​

readonly public topRight: LayoutPositionSignalIcon

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 from SVG.topRight

translate​

readonly public translate: Vector2SignalIcon

A visual offset applied to this node's rendering, analogous to CSS transform: translate(). Does not affect layout.

Inherited from SVG.translate

verticalAlign​

readonly public verticalAlign: SimpleSignalVerticalAlignIcon
Inherited from SVG.verticalAlign

wordBreak​

readonly public wordBreak: SimpleSignalWordBreakIcon
Inherited from SVG.wordBreak

wrap​

readonly public wrap: SimpleSignalFlexWrapIcon
Inherited from SVG.wrap

wrapper​

public wrapper: Node

Child to wrap all SVG node

Inherited from SVG.wrapper

yogaNode​

public yogaNode: Node
Inherited from SVG.yogaNode

zIndex​

readonly public zIndex: SimpleSignalnumberIcon
Inherited from SVG.zIndex

Accessors​

columnGap​

public get columnGap(): SignalLengthnumberthis
Inherited from SVG.columnGap

height​

public get height(): SignalLengthnumberthis
Inherited from SVG.height

rowGap​

public get rowGap(): SignalLengthnumberthis
Inherited from SVG.rowGap

width​

public get width(): SignalLengthnumberthis
Inherited from SVG.width

x​

public get x(): PositionComponentSignalthis
Inherited from SVG.x

y​

public get y(): PositionComponentSignalthis
Inherited from SVG.y

Methods​

[iterator]​

public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidunknown
Inherited from SVG.[iterator]

absoluteOpacity​

public absoluteOpacity(): number
Inherited from SVG.absoluteOpacity

add​

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
Inherited from SVG.add

anchorPosition​

public anchorPosition(): Vector2
Inherited from SVG.anchorPosition

applyState​

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: NodeState

    The state to apply to the node.

Inherited from SVG.applyState

cacheBBox​

public cacheBBox(): BBox

Get a bounding box for the contents rendered by this node as well as its children.

Inherited from SVG.cacheBBox

canLayoutChildren​

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.

Inherited from SVG.canLayoutChildren

canvasFont​

public canvasFont(): string
Inherited from SVG.canvasFont

cardinalPoint​

public cardinalPointorigin: OriginDirection: LayoutPositionSignalIcon

Get the cardinal point corresponding to the given origin.

Parameters

Inherited from SVG.cardinalPoint

childAs​

public childAsindex: number: Tnull

Get the nth children cast to the specified type.

Parameters

  • index: number

    The index of the child to retrieve.

Inherited from SVG.childAs

childrenAs​

public childrenAs(): T[]

Get the children array cast to the specified type.

Inherited from SVG.childrenAs

clone​

public clonecustomProps: NodeState = {}: this

Create a copy of this node.

Parameters

Inherited from SVG.clone

compositeToLocal​

public compositeToLocal(): DOMMatrix
Inherited from SVG.compositeToLocal

compositeToWorld​

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 from SVG.compositeToWorld

computedPosition​

public computedPosition(): Vector2
Inherited from SVG.computedPosition

dispose​

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 from SVG.dispose

drawOverlay​

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

Inherited from SVG.drawOverlay

editLayout​

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

Inherited from SVG.editLayout

findAll​

public findAllpredicate: node: any => node is T: T[]
public findAllpredicate: node: any => boolean: T[]

Find all descendants of this node that match the given predicate.

Parameters

  • predicate: node: any => node is T

    A function that returns true if the node matches.

Inherited from SVG.findAll

findAncestor​

public findAncestorpredicate: node: Node => node is T: Tnull
public findAncestorpredicate: node: Node => boolean: Tnull

Find the closest ancestor of this node that matches the given predicate.

Parameters

  • predicate: node: Node => node is T

    A function that returns true if the node matches.

Inherited from SVG.findAncestor

findFirst​

public findFirstpredicate: node: Node => node is T: Tnull
public findFirstpredicate: node: Node => boolean: Tnull

Find the first descendant of this node that matches the given predicate.

Parameters

  • predicate: node: Node => node is T

    A function that returns true if the node matches.

Inherited from SVG.findFirst

findLast​

public findLastpredicate: node: Node => node is T: Tnull
public findLastpredicate: node: Node => boolean: Tnull

Find the last descendant of this node that matches the given predicate.

Parameters

  • predicate: node: Node => node is T

    A function that returns true if the node matches.

Inherited from SVG.findLast

freezeLayout​

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.

Inherited from SVG.freezeLayout

getChildrenById​

public getChildrenByIdid: string: Node[]

Get all SVG nodes with the given id.

Parameters

  • id: string

    An id to query.

Inherited from SVG.getChildrenById

getOriginDelta​

public getOriginDeltaorigin: Origin: Vector2

Parameters

Inherited from SVG.getOriginDelta

getState​

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 from SVG.getState

hit​

public hitposition: Vector2: Nodenull

Try to find a node intersecting the given position.

Parameters

Inherited from SVG.hit

insert​

public insertnode: ComponentChildrenindex?: number: this
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 from SVG.insert

instantiate​

public instantiateprops: NodeProps = {}: this

Create an instance of this node's class.

Parameters

  • props: NodeProps = {}

    Properties to pass to the constructor.

Inherited from SVG.instantiate

isLayoutRoot​

public isLayoutRoot(): boolean
Inherited from SVG.isLayoutRoot

layoutEnabled​

public layoutEnabled(): boolean

Whether this node participates in its parent's flex layout. Resolves layoutSelf, then layout, then the parent's canLayoutChildren.

Inherited from SVG.layoutEnabled

localToParent​

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 from SVG.localToParent

localToWorld​

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 from SVG.localToWorld

lockLayout​

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.

Inherited from SVG.lockLayout

morphTo​

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

Inherited from SVG.morphTo

move​

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 = 1

    Number of places by which the node should be moved.

Inherited from SVG.move

moveAbove​

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: Node

    The sibling node below which to move.

  • directlyAbove: boolean = false

    Whether the node should be positioned directly above the sibling. When true, will move the node even if it is already positioned above the sibling.

Inherited from SVG.moveAbove

moveBelow​

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: Node

    The sibling node below which to move.

  • directlyBelow: boolean = false

    Whether the node should be positioned directly below the sibling. When true, will move the node even if it is already positioned below the sibling.

Inherited from SVG.moveBelow

moveDown​

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 from SVG.moveDown

moveOffset​

public moveOffsetoffset: Vector2: void

Update the offset of this node and adjust the position to keep it in the same place.

Parameters

Inherited from SVG.moveOffset

moveTo​

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: number

    The index to move the node to.

Inherited from SVG.moveTo

moveToBottom​

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 from SVG.moveToBottom

moveToTop​

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 from SVG.moveToTop

moveUp​

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 from SVG.moveUp

parentAs​

public parentAs(): Tnull

Get the parent cast to the specified type.

Inherited from SVG.parentAs

parentToWorld​

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 from SVG.parentToWorld

peekChildren​

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.

Inherited from SVG.peekChildren

reactiveClone​

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

Inherited from SVG.reactiveClone

releaseLayout​

public releaseLayout(): void

Decrement the layout lock counter.

Inherited from SVG.releaseLayout

remove​

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.

Inherited from SVG.remove

removeChildren​

public removeChildren(): this

Remove all children of this node.

Inherited from SVG.removeChildren

render​

public rendercontext: CanvasRenderingContext2D: void

Render this node onto the given canvas.

Parameters

Inherited from SVG.render

reparent​

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

Inherited from SVG.reparent

resolvedLineHeight​

public resolvedLineHeight(): number
Inherited from SVG.resolvedLineHeight

restore​

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 from SVG.restore

ripple​

public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany

Parameters

Inherited from SVG.ripple

save​

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.

Inherited from SVG.save

snapshotClone​

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

Inherited from SVG.snapshotClone

thawLayout​

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

Inherited from SVG.thawLayout

toPromise​

public toPromise(): PromiseIcon

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 from SVG.toPromise

transitionTo​

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

Inherited from SVG.transitionTo

view​

public view(): View2D
Inherited from SVG.view

worldToLocal​

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 from SVG.worldToLocal

worldToParent​

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 from SVG.worldToParent