Skip to main content

Img

class Img extends Asset

A node for displaying images.

Press play to preview the animation
import ...

export default makeScene2D(function* (view) {
  const ref = createRef<Img>();
  yield view.add(
    <Img
      ref={ref}
      src="https://images.unsplash.com/photo-1679218407381-a6f1660d60e9"
      width={300}
      radius={20}
    />,
  );

  // set the background using the color sampled from the image:
  ref().fill(ref().getColorAtPoint(0));

  yield* all(
    ref().size([100, 100], 1).to([300, null], 1),
    ref().radius(50, 1).to(20, 1),
    ref().alpha(0, 1).to(1, 1),
  );
  yield* waitFor(0.5);
});

Extended by

Constructors​

constructor​

public override new Imgprops: ImgProps: Img

Parameters

Overwrites Asset.constructor

Properties​

absolutePosition​

readonly public absolutePosition: SimpleVector2SignalImg

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 Asset.absolutePosition

absoluteRotation​

readonly public absoluteRotation: SimpleSignalnumberImg

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 Asset.absoluteRotation

absoluteScale​

readonly public absoluteScale: SimpleVector2SignalImg

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 Asset.absoluteScale

alignContent​

readonly public alignContent: SimpleSignalFlexContentImg
Inherited from Asset.alignContent

alignItems​

readonly public alignItems: SimpleSignalFlexItemsImg
Inherited from Asset.alignItems

alignSelf​

readonly public alignSelf: SimpleSignalFlexItemsImg
Inherited from Asset.alignSelf

alpha​

readonly public alpha: SimpleSignalnumberImg

The alpha value of this image.

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

antialiased​

readonly public antialiased: SimpleSignalbooleanImg
Inherited from Asset.antialiased

arrowSize​

readonly public arrowSize: SimpleSignalnumberImg

Controls the size of the end and start arrows.

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

Inherited from Asset.arrowSize

assetRoot​

public assetRoot?: `${string}/`
Inherited from Asset.assetRoot

basis​

readonly public basis: SimpleSignalFlexBasisImg
Inherited from Asset.basis

bottom​

readonly public bottom: SimpleVector2SignalImg

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

bottomLeft​

readonly public bottomLeft: SimpleVector2SignalImg

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

bottomRight​

readonly public bottomRight: SimpleVector2SignalImg

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

cache​

readonly public cache: SimpleSignalbooleanImg
Inherited from Asset.cache

cachePadding​

readonly public cachePadding: SpacingSignalImg

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 Asset.cachePadding

children​

readonly public children: SignalComponentChildrenNode[]ImgSignalContextComponentChildrenNode[]Img
Inherited from Asset.children

clip​

readonly public clip: SimpleSignalbooleanImg
Inherited from Asset.clip

closed​

readonly public closed: SimpleSignalbooleanImg

Whether the curve should be closed.

Closed curves have their start and end points connected.

Inherited from Asset.closed

composite​

readonly public composite: SimpleSignalbooleanImg
Inherited from Asset.composite

compositeOperation​

readonly public compositeOperation: SimpleSignalGlobalCompositeOperationImg
Inherited from Asset.compositeOperation

cornerSharpness​

readonly public cornerSharpness: SimpleSignalnumberImg

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 Asset.cornerSharpness

creationStack​

readonly public creationStack?: string
Inherited from Asset.creationStack

direction​

readonly public direction: SimpleSignalFlexDirectionImg
Inherited from Asset.direction

element​

public element: HTMLElement
Inherited from Asset.element

end​

readonly public end: SimpleSignalnumberImg

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 Asset.end

endArrow​

readonly public endArrow: SimpleSignalbooleanImg

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

Use arrowSize to control the size of the arrow.

Inherited from Asset.endArrow

endOffset​

readonly public endOffset: SimpleSignalnumberImg

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 Asset.endOffset

fill​

readonly public fill: CanvasStyleSignalImg
Inherited from Asset.fill

filters​

readonly public filters: FiltersSignalImg
Inherited from Asset.filters

fontFamily​

readonly public fontFamily: SimpleSignalstringImg
Inherited from Asset.fontFamily

fontSize​

readonly public fontSize: SimpleSignalnumberImg
Inherited from Asset.fontSize

fontStyle​

readonly public fontStyle: SimpleSignalstringImg
Inherited from Asset.fontStyle

fontWeight​

readonly public fontWeight: SimpleSignalnumberImg
Inherited from Asset.fontWeight

gap​

readonly public gap: Vector2LengthSignalImg
Inherited from Asset.gap

grow​

readonly public grow: SimpleSignalnumberImg
Inherited from Asset.grow

isClass​

public isClass: boolean
Inherited from Asset.isClass

justifyContent​

readonly public justifyContent: SimpleSignalFlexContentImg
Inherited from Asset.justifyContent

key​

readonly public key: string
Inherited from Asset.key

layout​

readonly public layout: SimpleSignalLayoutModeImg
Inherited from Asset.layout

left​

readonly public left: SimpleVector2SignalImg

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

letterSpacing​

readonly public letterSpacing: SimpleSignalnumberImg
Inherited from Asset.letterSpacing

lineCap​

readonly public lineCap: SimpleSignalCanvasLineCapImg
Inherited from Asset.lineCap

lineDash​

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

lineDashOffset​

readonly public lineDashOffset: SimpleSignalnumberImg
Inherited from Asset.lineDashOffset

lineHeight​

readonly public lineHeight: SimpleSignalLengthImg
Inherited from Asset.lineHeight

lineJoin​

readonly public lineJoin: SimpleSignalCanvasLineJoinImg
Inherited from Asset.lineJoin

lineWidth​

readonly public lineWidth: SimpleSignalnumberImg
Inherited from Asset.lineWidth

margin​

readonly public margin: SpacingSignalImg
Inherited from Asset.margin

maxHeight​

readonly public maxHeight: SimpleSignalLengthLimitImg
Inherited from Asset.maxHeight

maxWidth​

readonly public maxWidth: SimpleSignalLengthLimitImg
Inherited from Asset.maxWidth

middle​

readonly public middle: SimpleVector2SignalImg

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 Asset.middle

minHeight​

readonly public minHeight: SimpleSignalLengthLimitImg
Inherited from Asset.minHeight

minWidth​

readonly public minWidth: SimpleSignalLengthLimitImg
Inherited from Asset.minWidth

offset​

readonly public offset: Vector2SignalImg

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 Asset.offset

opacity​

readonly public opacity: SimpleSignalnumberImg

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

The value is clamped to the range 0-1.

Inherited from Asset.opacity

padding​

readonly public padding: SpacingSignalImg
Inherited from Asset.padding

parent​

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

position​

readonly public position: Vector2SignalImg

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

Examples

Inherited from Asset.position

properties​

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

radius​

readonly public radius: SpacingSignalImg

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 Asset.radius

ratio​

readonly public ratio: SimpleSignalnullnumberImg
Inherited from Asset.ratio
readonly public right: SimpleVector2SignalImg

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

rotation​

readonly public rotation: SimpleSignalnumberImg

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

Inherited from Asset.rotation

scale​

readonly public scale: Vector2SignalImg

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

Examples

Inherited from Asset.scale

shaders​

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

shadowBlur​

readonly public shadowBlur: SimpleSignalnumberImg
Inherited from Asset.shadowBlur

shadowColor​

readonly public shadowColor: ColorSignalImg
Inherited from Asset.shadowColor

shadowOffset​

readonly public shadowOffset: Vector2SignalImg
Inherited from Asset.shadowOffset

shrink​

readonly public shrink: SimpleSignalnumberImg
Inherited from Asset.shrink

size​

readonly public size: Vector2LengthSignalImg

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 Asset.size

skew​

readonly public skew: Vector2SignalImg

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

Examples

Inherited from Asset.skew

smoothCorners​

readonly public smoothCorners: SimpleSignalbooleanImg

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 Asset.smoothCorners

smoothing​

readonly public smoothing: SimpleSignalbooleanImg

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

src​

readonly public src: SimpleSignalstringImg

The source of this asset.

Examples

Inherited from Asset.src

start​

readonly public start: SimpleSignalnumberImg

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 Asset.start

startArrow​

readonly public startArrow: SimpleSignalbooleanImg

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

Use arrowSize to control the size of the arrow.

Inherited from Asset.startArrow

startOffset​

readonly public startOffset: SimpleSignalnumberImg

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 Asset.startOffset

stroke​

readonly public stroke: CanvasStyleSignalImg
Inherited from Asset.stroke

strokeFirst​

readonly public strokeFirst: SimpleSignalbooleanImg
Inherited from Asset.strokeFirst

styles​

public styles: CSSStyleDeclaration
Inherited from Asset.styles

textAlign​

readonly public textAlign: SimpleSignalCanvasTextAlignImg
Inherited from Asset.textAlign

textDirection​

readonly public textDirection: SimpleSignalCanvasDirectionImg
Inherited from Asset.textDirection

textWrap​

readonly public textWrap: SimpleSignalTextWrapImg
Inherited from Asset.textWrap

top​

readonly public top: SimpleVector2SignalImg

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

topLeft​

readonly public topLeft: SimpleVector2SignalImg

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

topRight​

readonly public topRight: SimpleVector2SignalImg

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

wrap​

readonly public wrap: SimpleSignalFlexWrapImg
Inherited from Asset.wrap

zIndex​

readonly public zIndex: SimpleSignalnumberImg
Inherited from Asset.zIndex

Accessors​

columnGap​

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

height​

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

rowGap​

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

width​

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

x​

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

y​

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

Methods​

[iterator]​

public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidvoidunknown
Inherited from Asset.__@iterator@3541

absoluteOpacity​

public absoluteOpacity(): number
Inherited from Asset.absoluteOpacity

add​

public addnode: ComponentChildren: Img

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 Asset.add

anchorPosition​

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

cacheBBox​

public cacheBBox(): BBox

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

Inherited from Asset.cacheBBox

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 Asset.childAs

childrenAs​

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

Get the children array cast to the specified type.

Type Parameters

Inherited from Asset.childrenAs

clone​

public clonecustomProps: NodeState = {}: Img

Create a copy of this node.

Parameters

Inherited from Asset.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 Asset.completion

compositeToLocal​

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

computedPosition​

public computedPosition(): Vector2
Inherited from Asset.computedPosition

dispose​

public dispose(): void
Inherited from Asset.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 Asset.distanceToPercentage

drawOverlay​

public drawOverlaycontext: CanvasRenderingContext2Dmatrix: DOMMatrix: void

Parameters

Inherited from Asset.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 Asset.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 Asset.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 Asset.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 Asset.findLast

fullSource​

public fullSource(): string
Inherited from Asset.fullSource

getColorAtPoint​

public getColorAtPointposition: PossibleVector2number: Color

Get color of the image at the given position.

Parameters

getOriginDelta​

public getOriginDeltaorigin: Origin: Vector2

Parameters

Inherited from Asset.getOriginDelta

getPixelColor​

public getPixelColorposition: PossibleVector2number: Color

Get color of the image at the given pixel.

Parameters

getPointAtPercentage​

public getPointAtPercentagevalue: number: CurvePoint

Parameters

Inherited from Asset.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 Asset.getState

hit​

public hitposition: Vector2: nullNode

Parameters

Inherited from Asset.hit

insert​

public insertnode: ComponentChildrenindex: number = 0: Img

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

Examples

Parameters

Inherited from Asset.insert

instantiate​

public instantiateprops: NodeProps = {}: Img

Create an instance of this node's class.

Parameters

Inherited from Asset.instantiate

isLayoutRoot​

public isLayoutRoot(): boolean
Inherited from Asset.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 Asset.layoutEnabled

localToParent​

public localToParent(): DOMMatrix
Inherited from Asset.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 Asset.localToWorld

lockSize​

public lockSize(): void
Inherited from Asset.lockSize

move​

public moveby: number = 1: Img

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

moveAbove​

public moveAbovenode: NodedirectlyAbove: boolean = false: Img

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

moveBelow​

public moveBelownode: NodedirectlyBelow: boolean = false: Img

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

moveDown​

public moveDown(): Img

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

moveTo​

public moveToindex: number: Img

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

moveToBottom​

public moveToBottom(): Img

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

moveToTop​

public moveToTop(): Img

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

moveUp​

public moveUp(): Img

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

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 Asset.offsetArcLength

parentAs​

public parentAsT extends NodeT = Node(): nullT

Get the parent cast to the specified type.

Type Parameters

Inherited from Asset.parentAs

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 Asset.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 Asset.percentageToDistance

profile​

public profile(): CurveProfile
Inherited from Asset.profile

reactiveClone​

public reactiveClonecustomProps: NodeState = {}: Img

Create a reactive copy of this node.

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

Parameters

Inherited from Asset.reactiveClone

releaseSize​

public releaseSize(): void
Inherited from Asset.releaseSize

remove​

public remove(): Img

Remove this node from the tree.

Inherited from Asset.remove

removeChildren​

public removeChildren(): void

Remove all children of this node.

Inherited from Asset.removeChildren

render​

public rendercontext: CanvasRenderingContext2D: Promisevoid

Render this node onto the given canvas.

Parameters

Inherited from Asset.render

reparent​

public reparentnewParent: Node: void

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

ripple​

public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany

Parameters

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

snapshotClone​

public snapshotClonecustomProps: NodeState = {}: Img

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

toPromise​

public toPromise(): PromiseImg

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

view​

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