Skip to main content

Icon

class Icon extends Img

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 Img.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.

Inherited from Img.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.

Inherited from Img.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.

Inherited from Img.absoluteScale

alignContent​

readonly public alignContent: SimpleSignalFlexContentIcon
Inherited from Img.alignContent

alignItems​

readonly public alignItems: SimpleSignalFlexItemsIcon
Inherited from Img.alignItems

alignSelf​

readonly public alignSelf: SimpleSignalFlexItemsIcon
Inherited from Img.alignSelf

alpha​

readonly public alpha: SimpleSignalnumberIcon

The alpha value of this image.

Unlike opacity, the alpha value affects only the image itself, leaving the fill, stroke, and children intact.

Inherited from Img.alpha

antialiased​

readonly public antialiased: SimpleSignalbooleanIcon
Inherited from Img.antialiased

arrowSize​

readonly public arrowSize: SimpleSignalnumberIcon

Controls the size of the end and start arrows.

To make the arrows visible make sure to enable startArrow and/or endArrow.

Inherited from Img.arrowSize

basis​

readonly public basis: SimpleSignalFlexBasisIcon
Inherited from Img.basis

bottom​

readonly public bottom: SimpleVector2SignalIcon

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 Img.bottom

bottomLeft​

readonly public bottomLeft: SimpleVector2SignalIcon

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 Img.bottomLeft

bottomRight​

readonly public bottomRight: SimpleVector2SignalIcon

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 Img.bottomRight

cache​

readonly public cache: SimpleSignalbooleanIcon
Inherited from Img.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 Img.cachePadding

children​

readonly public children: SignalComponentChildrenNode[]IconSignalContextComponentChildrenNode[]Icon
Inherited from Img.children

clip​

readonly public clip: SimpleSignalbooleanIcon
Inherited from Img.clip

closed​

readonly public closed: SimpleSignalbooleanIcon

Whether the curve should be closed.

Closed curves have their start and end points connected.

Inherited from Img.closed

color​

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: 'white'

composite​

readonly public composite: SimpleSignalbooleanIcon
Inherited from Img.composite

compositeOperation​

readonly public compositeOperation: SimpleSignalGlobalCompositeOperationIcon
Inherited from Img.compositeOperation

cornerSharpness​

readonly public cornerSharpness: SimpleSignalnumberIcon

Controls the sharpness of smoothCorners.

This property only affects the way rounded corners are drawn. To control the corner radius use the radius property.

Requires smoothCorners to be enabled to have any effect. By default, corner sharpness is set to 0.6 which represents a smooth, circle-like rounding. At 0 the edges are squared off.

Examples

Inherited from Img.cornerSharpness

creationStack​

readonly public creationStack?: string
Inherited from Img.creationStack

direction​

readonly public direction: SimpleSignalFlexDirectionIcon
Inherited from Img.direction

element​

public element: HTMLElement
Inherited from Img.element

end​

readonly public end: SimpleSignalnumberIcon

A percentage from the start after which the curve should be clipped.

The portion of the curve that comes after the given percentage will be made invisible.

This property is usefully for animating the curve appearing on the screen. The value of 0 means the very start of the curve (accounting for the startOffset) while 1 means the very end (accounting for the endOffset).

Inherited from Img.end

endArrow​

readonly public endArrow: SimpleSignalbooleanIcon

Whether to display an arrow at the end of the visible curve.

Use arrowSize to control the size of the arrow.

Inherited from Img.endArrow

endOffset​

readonly public endOffset: SimpleSignalnumberIcon

The offset in pixels from the end of the curve.

This property lets you specify where along the defined curve the actual visible portion ends. For example, setting it to 20 will make the last 20 pixels of the curve invisible.

This property is useful for trimming the curve using a fixed distance. If you want to animate the curve appearing on the screen, use end instead.

Inherited from Img.endOffset

fill​

readonly public fill: CanvasStyleSignalIcon
Inherited from Img.fill

filters​

readonly public filters: FiltersSignalIcon
Inherited from Img.filters

fontFamily​

readonly public fontFamily: SimpleSignalstringIcon
Inherited from Img.fontFamily

fontSize​

readonly public fontSize: SimpleSignalnumberIcon
Inherited from Img.fontSize

fontStyle​

readonly public fontStyle: SimpleSignalstringIcon
Inherited from Img.fontStyle

fontWeight​

readonly public fontWeight: SimpleSignalnumberIcon
Inherited from Img.fontWeight

gap​

readonly public gap: Vector2LengthSignalIcon
Inherited from Img.gap

grow​

readonly public grow: SimpleSignalnumberIcon
Inherited from Img.grow

icon​

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 Img.isClass

justifyContent​

readonly public justifyContent: SimpleSignalFlexContentIcon
Inherited from Img.justifyContent

key​

readonly public key: string
Inherited from Img.key

layout​

readonly public layout: SimpleSignalLayoutModeIcon
Inherited from Img.layout

left​

readonly public left: SimpleVector2SignalIcon

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 Img.left

letterSpacing​

readonly public letterSpacing: SimpleSignalnumberIcon
Inherited from Img.letterSpacing

lineCap​

readonly public lineCap: SimpleSignalCanvasLineCapIcon
Inherited from Img.lineCap

lineDash​

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

lineDashOffset​

readonly public lineDashOffset: SimpleSignalnumberIcon
Inherited from Img.lineDashOffset

lineHeight​

readonly public lineHeight: SimpleSignalLengthIcon
Inherited from Img.lineHeight

lineJoin​

readonly public lineJoin: SimpleSignalCanvasLineJoinIcon
Inherited from Img.lineJoin

lineWidth​

readonly public lineWidth: SimpleSignalnumberIcon
Inherited from Img.lineWidth

margin​

readonly public margin: SpacingSignalIcon
Inherited from Img.margin

maxHeight​

readonly public maxHeight: SimpleSignalLengthLimitIcon
Inherited from Img.maxHeight

maxWidth​

readonly public maxWidth: SimpleSignalLengthLimitIcon
Inherited from Img.maxWidth

middle​

readonly public middle: SimpleVector2SignalIcon

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 offset 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 Img.middle

minHeight​

readonly public minHeight: SimpleSignalLengthLimitIcon
Inherited from Img.minHeight

minWidth​

readonly public minWidth: SimpleSignalLengthLimitIcon
Inherited from Img.minWidth

offset​

readonly public offset: Vector2SignalIconVector2SignalContextIcon

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

  • [-1, -1] - top left corner
  • [1, -1] - top right corner
  • [0, 1] - bottom edge
  • [-1, 1] - bottom left corner
Inherited from Img.offset

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 Img.opacity

padding​

readonly public padding: SpacingSignalIcon
Inherited from Img.padding

parent​

readonly public parent: SimpleSignalnullNodevoid = ...
Inherited from Img.parent

position​

readonly public position: Vector2SignalIconVector2SignalContextIcon

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

Examples

Inherited from Img.position

properties​

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

radius​

readonly public radius: SpacingSignalIcon

Rounds the corners of this rectangle.

The value represents the radius of the quarter circle that is used to round the corners. If the value is a number, the same radius is used for all corners. Passing an array of two to four numbers will set individual radii for each corner. Individual radii correspond to different corners depending on the number of values passed:

// top-left-and-bottom-right | top-right-and-bottom-left
[10, 30]
// top-left | top-right-and-bottom-left | bottom-right
[10, 20, 30]
// top-left | top-right | bottom-right | bottom-left
[10, 20, 30, 40]

Examples

Inherited from Img.radius

ratio​

readonly public ratio: SimpleSignalnullnumberIcon
Inherited from Img.ratio
readonly public right: SimpleVector2SignalIcon

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 Img.right

rotation​

readonly public rotation: SimpleSignalnumberIcon

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

Inherited from Img.rotation

scale​

readonly public scale: Vector2SignalIconVector2SignalContextIcon

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

Examples

Inherited from Img.scale

shaders​

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

shadowBlur​

readonly public shadowBlur: SimpleSignalnumberIcon
Inherited from Img.shadowBlur

shadowColor​

readonly public shadowColor: ColorSignalIcon
Inherited from Img.shadowColor

shadowOffset​

readonly public shadowOffset: Vector2SignalIconVector2SignalContextIcon
Inherited from Img.shadowOffset

shrink​

readonly public shrink: SimpleSignalnumberIcon
Inherited from Img.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 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 entire scene.

Examples

Inherited from Img.size

skew​

readonly public skew: Vector2SignalIconVector2SignalContextIcon

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

Examples

Inherited from Img.skew

smoothCorners​

readonly public smoothCorners: SimpleSignalbooleanIcon

Enables corner smoothing.

This property only affects the way rounded corners are drawn. To control the corner radius use the radius property.

When enabled, rounded corners are drawn continuously using Bézier curves rather than quarter circles. The sharpness of the curve can be controlled with cornerSharpness.

You can read more about corner smoothing in this article by Nick Lawrence.

Examples

Inherited from Img.smoothCorners

smoothing​

readonly public smoothing: SimpleSignalbooleanIcon

Whether the image should be smoothed.

When disabled, the image will be scaled using the nearest neighbor interpolation with no smoothing. The resulting image will appear pixelated.

Default Value: trueInherited from Img.smoothing

src​

readonly public src: SimpleSignalstringIcon

The source of this image.

Examples

Inherited from Img.src

start​

readonly public start: SimpleSignalnumberIcon

A percentage from the start before which the curve should be clipped.

The portion of the curve that comes before the given percentage will be made invisible.

This property is usefully for animating the curve appearing on the screen. The value of 0 means the very start of the curve (accounting for the startOffset) while 1 means the very end (accounting for the endOffset).

Inherited from Img.start

startArrow​

readonly public startArrow: SimpleSignalbooleanIcon

Whether to display an arrow at the start of the visible curve.

Use arrowSize to control the size of the arrow.

Inherited from Img.startArrow

startOffset​

readonly public startOffset: SimpleSignalnumberIcon

The offset in pixels from the start of the curve.

This property lets you specify where along the defined curve the actual visible portion starts. For example, setting it to 20 will make the first 20 pixels of the curve invisible.

This property is useful for trimming the curve using a fixed distance. If you want to animate the curve appearing on the screen, use start instead.

Inherited from Img.startOffset

stroke​

readonly public stroke: CanvasStyleSignalIcon
Inherited from Img.stroke

strokeFirst​

readonly public strokeFirst: SimpleSignalbooleanIcon
Inherited from Img.strokeFirst

styles​

public styles: CSSStyleDeclaration
Inherited from Img.styles

textAlign​

readonly public textAlign: SimpleSignalCanvasTextAlignIcon
Inherited from Img.textAlign

textDirection​

readonly public textDirection: SimpleSignalCanvasDirectionIcon
Inherited from Img.textDirection

textWrap​

readonly public textWrap: SimpleSignalTextWrapIcon
Inherited from Img.textWrap

top​

readonly public top: SimpleVector2SignalIcon

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 Img.top

topLeft​

readonly public topLeft: SimpleVector2SignalIcon

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 Img.topLeft

topRight​

readonly public topRight: SimpleVector2SignalIcon

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 Img.topRight

wrap​

readonly public wrap: SimpleSignalFlexWrapIcon
Inherited from Img.wrap

zIndex​

readonly public zIndex: SimpleSignalnumberIcon
Inherited from Img.zIndex

Accessors​

columnGap​

public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Img.columnGap

height​

public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Img.height

rowGap​

public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Img.rowGap

width​

public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Img.width

x​

public get x(): SimpleSignalnumberthis
Inherited from Img.x

y​

public get y(): SimpleSignalnumberthis
Inherited from Img.y

Methods​

[iterator]​

public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidvoidunknown
Inherited from Img.[iterator]

absoluteOpacity​

public absoluteOpacity(): number
Inherited from Img.absoluteOpacity

add​

public addnode: ComponentChildren: Icon

Add the given node(s) as the children of this node.

The nodes will be appended at the end of the children list.

Examples

Parameters

Inherited from Img.add

anchorPosition​

public anchorPosition(): Vector2
Inherited from Img.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

Inherited from Img.applyState

arcLength​

public arcLength(): number

The visible arc length of this curve.

This arc length accounts for both the offset and the start and end properties.

Inherited from Img.arcLength

baseArcLength​

public baseArcLength(): number

The base arc length of this curve.

This is the entire length of this curve, not accounting for the offsets.

Inherited from Img.baseArcLength

cacheBBox​

public cacheBBox(): BBox

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

Inherited from Img.cacheBBox

cardinalPoint​

public cardinalPointorigin: OriginDirection: SimpleVector2SignalIcon

Get the cardinal point corresponding to the given origin.

Parameters

Inherited from Img.cardinalPoint

childAs​

public childAsT extends NodeT = Nodeindex: number: nullT

Get the nth children cast to the specified type.

Type Parameters

Parameters

  • index: number

    The index of the child to retrieve.

Inherited from Img.childAs

childrenAs​

public childrenAsT extends NodeT = Node(): T[]

Get the children array cast to the specified type.

Type Parameters

Inherited from Img.childrenAs

clone​

public clonecustomProps: NodeState = {}: Icon

Create a copy of this node.

Parameters

Inherited from Img.clone

completion​

public completion(): number

The percentage of the curve that's currently visible.

The returned value is the ratio between the visible length (as defined by start and end) and the offset length of the curve.

Inherited from Img.completion

compositeToLocal​

public compositeToLocal(): DOMMatrix
Inherited from Img.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 Img.compositeToWorld

computedPosition​

public computedPosition(): Vector2
Inherited from Img.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 Img.dispose

distanceToPercentage​

public distanceToPercentagevalue: number: number

Convert a distance along the curve to a percentage.

The distance should be given in relation to the full curve, not accounting for startOffset and endOffset.

Parameters

  • value: number

    The distance along the curve.

Inherited from Img.distanceToPercentage

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 Img.drawOverlay

findAll​

public findAllT extends NodeTpredicate: node: any => node is T: T[]
public findAllT extends NodeT = Nodepredicate: node: any => boolean: T[]

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

Type Parameters

Parameters

  • predicate: node: any => node is T

    A function that returns true if the node matches.

Inherited from Img.findAll

findAncestor​

public findAncestorT extends NodeTpredicate: node: Node => node is T: nullT
public findAncestorT extends NodeT = Nodepredicate: node: Node => boolean: nullT

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

Type Parameters

Parameters

Inherited from Img.findAncestor

findFirst​

public findFirstT extends NodeTpredicate: node: Node => node is T: nullT
public findFirstT extends NodeT = Nodepredicate: node: Node => boolean: nullT

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

Type Parameters

Parameters

Inherited from Img.findFirst

findLast​

public findLastT extends NodeTpredicate: node: Node => node is T: nullT
public findLastT extends NodeT = Nodepredicate: node: Node => boolean: nullT

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

Type Parameters

Parameters

Inherited from Img.findLast

getColorAtPoint​

public getColorAtPointposition: PossibleVector2number: Color

Get color of the image at the given position.

Parameters

Inherited from Img.getColorAtPoint

getOriginDelta​

public getOriginDeltaorigin: Origin: Vector2

Parameters

Inherited from Img.getOriginDelta

getPixelColor​

public getPixelColorposition: PossibleVector2number: Color

Get color of the image at the given pixel.

Parameters

Inherited from Img.getPixelColor

getPointAtPercentage​

public getPointAtPercentagevalue: number: CurvePoint

Parameters

Inherited from Img.getPointAtPercentage

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 Img.getState

hit​

public hitposition: Vector2: nullNode

Try to find a node intersecting the given position.

Parameters

Inherited from Img.hit

insert​

public insertnode: ComponentChildrenindex: number = 0: Icon

Insert the given node(s) at the specified index in the children list.

Examples

Parameters

Inherited from Img.insert

instantiate​

public instantiateprops: NodeProps = {}: Icon

Create an instance of this node's class.

Parameters

Inherited from Img.instantiate

isLayoutRoot​

public isLayoutRoot(): boolean
Inherited from Img.isLayoutRoot

layoutEnabled​

public layoutEnabled(): boolean

Get the resolved layout mode of this node.

When the mode is null, its value will be inherited from the parent.

Use layout to get the raw mode set for this node (without inheritance).

Inherited from Img.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 Img.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 Img.localToWorld

lockSize​

public lockSize(): void
Inherited from Img.lockSize

move​

public moveby: number = 1: Icon

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 Img.move

moveAbove​

public moveAbovenode: NodedirectlyAbove: boolean = false: Icon

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 Img.moveAbove

moveBelow​

public moveBelownode: NodedirectlyBelow: boolean = false: Icon

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 Img.moveBelow

moveDown​

public moveDown(): Icon

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 Img.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 Img.moveOffset

moveTo​

public moveToindex: number: Icon

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 Img.moveTo

moveToBottom​

public moveToBottom(): Icon

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 Img.moveToBottom

moveToTop​

public moveToTop(): Icon

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 Img.moveToTop

moveUp​

public moveUp(): Icon

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 Img.moveUp

naturalSize​

public naturalSize(): Vector2

The natural size of this image.

The natural size is the size of the source image unaffected by the size and scale properties.

Inherited from Img.naturalSize

offsetArcLength​

public offsetArcLength(): number

The offset arc length of this curve.

This is the length of the curve that accounts for the offsets.

Inherited from Img.offsetArcLength

parentAs​

public parentAsT extends NodeT = Node(): nullT

Get the parent cast to the specified type.

Type Parameters

Inherited from Img.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 Img.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 Img.peekChildren

percentageToDistance​

public percentageToDistancevalue: number: number

Convert a percentage along the curve to a distance.

The returned distance is given in relation to the full curve, not accounting for startOffset and endOffset.

Parameters

  • value: number

    The percentage along the curve.

Inherited from Img.percentageToDistance

profile​

public profile(): CurveProfile
Inherited from Img.profile

reactiveClone​

public reactiveClonecustomProps: NodeState = {}: Icon

Create a reactive copy of this node.

A reactive copy has all its properties dynamically updated to match the source node.

Parameters

Inherited from Img.reactiveClone

releaseSize​

public releaseSize(): void
Inherited from Img.releaseSize

remove​

public remove(): Icon

Remove this node from the tree.

Inherited from Img.remove

removeChildren​

public removeChildren(): Icon

Remove all children of this node.

Inherited from Img.removeChildren

render​

public rendercontext: CanvasRenderingContext2D: void

Render this node onto the given canvas.

Parameters

Inherited from Img.render

reparent​

public reparentnewParent: Node: Icon

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 Img.reparent

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 Img.restore

ripple​

public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany

Parameters

Inherited from Img.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 Img.save

snapshotClone​

public snapshotClonecustomProps: NodeState = {}: Icon

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 Img.snapshotClone

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 Img.toPromise

view​

public view(): View2D
Inherited from Img.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 Img.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 Img.worldToParent