Skip to main content

Img

class Img extends Rect

A node for displaying images.

Loading preview…
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);
});

Constructors​

constructor​

public override new Imgprops: ImgProps: Img

Parameters

Overwrites Rect.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.

Deprecated

Use position.abs instead.

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

Deprecated

Use rotation.abs instead.

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

Deprecated

Use scale.abs instead.

Inherited from Rect.absoluteScale

alignContent​

readonly public alignContent: SimpleSignalFlexContentImg
Inherited from Rect.alignContent

alignItems​

readonly public alignItems: SimpleSignalFlexItemsImg
Inherited from Rect.alignItems

alignSelf​

readonly public alignSelf: SimpleSignalFlexItemsImg
Inherited from Rect.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.

anchor​

readonly public anchor: 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 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 Rect.anchor

antialiased​

readonly public antialiased: SimpleSignalbooleanImg
Inherited from Rect.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 Rect.arrowSize

basis​

readonly public basis: SimpleSignalFlexBasisImg
Inherited from Rect.basis

bottom​

readonly public bottom: LayoutPositionSignalImg

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

bottomLeft​

readonly public bottomLeft: LayoutPositionSignalImg

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

bottomRight​

readonly public bottomRight: LayoutPositionSignalImg

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

bowing​

readonly public bowing: SimpleSignalnumberImg

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 Rect.bowing

cache​

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

children​

readonly public children: SignalComponentChildrenNode[]Img
Inherited from Rect.children

clip​

readonly public clip: SimpleSignalbooleanImg
Inherited from Rect.clip

closed​

readonly public closed: SimpleSignalbooleanImg

Whether the curve should be closed.

Closed curves have their start and end points connected.

Inherited from Rect.closed

composite​

readonly public composite: SimpleSignalbooleanImg
Inherited from Rect.composite

compositeOperation​

readonly public compositeOperation: SimpleSignalGlobalCompositeOperationImg
Inherited from Rect.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 Rect.cornerSharpness

creationStack​

readonly public creationStack?: string
Inherited from Rect.creationStack

direction​

readonly public direction: SimpleSignalFlexDirectionImg
Inherited from Rect.direction

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

fill​

readonly public fill: CanvasStyleSignalImg
Inherited from Rect.fill

fillShaders​

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

filters​

readonly public filters: FiltersSignalImg
Inherited from Rect.filters

fontFamily​

readonly public fontFamily: SimpleSignalstringImg
Inherited from Rect.fontFamily

fontSize​

readonly public fontSize: SimpleSignalnumberImg
Inherited from Rect.fontSize

fontStyle​

readonly public fontStyle: SimpleSignalstringImg
Inherited from Rect.fontStyle

fontWeight​

readonly public fontWeight: SimpleSignalnumberImg
Inherited from Rect.fontWeight

gap​

readonly public gap: Vector2LengthSignalImg
Inherited from Rect.gap

grow​

readonly public grow: SimpleSignalnumberImg
Inherited from Rect.grow

isClass​

public isClass: boolean
Inherited from Rect.isClass

justifyContent​

readonly public justifyContent: SimpleSignalFlexContentImg
Inherited from Rect.justifyContent

key​

readonly public key: string
Inherited from Rect.key

layout​

readonly public layout: SimpleSignalLayoutModeImg
Inherited from Rect.layout

layoutChildren​

readonly public layoutChildren: SimpleSignalLayoutModeImg

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

Inherited from Rect.layoutChildren

layoutSelf​

readonly public layoutSelf: SimpleSignalLayoutModeImg

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

Inherited from Rect.layoutSelf

left​

readonly public left: LayoutPositionSignalImg

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

letterSpacing​

readonly public letterSpacing: SimpleSignalnumberImg
Inherited from Rect.letterSpacing

lineCap​

readonly public lineCap: SimpleSignalCanvasLineCapImg
Inherited from Rect.lineCap

lineDash​

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

lineDashOffset​

readonly public lineDashOffset: SimpleSignalnumberImg
Inherited from Rect.lineDashOffset

lineHeight​

readonly public lineHeight: SimpleSignalLengthImg
Inherited from Rect.lineHeight

lineJoin​

readonly public lineJoin: SimpleSignalCanvasLineJoinImg
Inherited from Rect.lineJoin

lineWidth​

readonly public lineWidth: SimpleSignalnumberImg
Inherited from Rect.lineWidth

margin​

readonly public margin: SpacingSignalImg
Inherited from Rect.margin

maxHeight​

readonly public maxHeight: SimpleSignalLengthLimitImg
Inherited from Rect.maxHeight

maxWidth​

readonly public maxWidth: SimpleSignalLengthLimitImg
Inherited from Rect.maxWidth

middle​

readonly public middle: LayoutPositionSignalImg

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

minHeight​

readonly public minHeight: SimpleSignalLengthLimitImg
Inherited from Rect.minHeight

minWidth​

readonly public minWidth: SimpleSignalLengthLimitImg

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 Rect.minWidth

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

padding​

readonly public padding: SpacingSignalImg
Inherited from Rect.padding

parent​

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

position​

readonly public position: PositionSignalImg

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

Examples

Inherited from Rect.position

properties​

readonly public properties: RecordstringPropertyMetadataany = ...
Inherited from Rect.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 Rect.radius

ratio​

readonly public ratio: SimpleSignalnumbernullImg
Inherited from Rect.ratio
readonly public right: LayoutPositionSignalImg

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

rotation​

readonly public rotation: RotationSignalImg

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

Inherited from Rect.rotation

rough​

readonly public rough: SimpleSignalbooleanImg

Enable rough.js rendering.

Inherited from Rect.rough

roughDisableMultiStroke​

readonly public roughDisableMultiStroke: SimpleSignalbooleanImg

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 Rect.roughDisableMultiStroke

roughDisableMultiStrokeFill​

readonly public roughDisableMultiStrokeFill: SimpleSignalbooleanImg

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 Rect.roughDisableMultiStrokeFill

roughFillStyle​

readonly public roughFillStyle: SimpleSignalRoughFillStyleImg

Fill style for the shape.

Inherited from Rect.roughFillStyle

roughFillWeight​

readonly public roughFillWeight: SimpleSignalnumberundefinedImg

Thickness of the lines used for filling.

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

Inherited from Rect.roughFillWeight

roughHachureAngle​

readonly public roughHachureAngle: SimpleSignalnumberImg

Angle of the hachure lines in degrees.

Only applicable for hachure and cross-hatch fill styles.

Inherited from Rect.roughHachureAngle

roughHachureGap​

readonly public roughHachureGap: SimpleSignalnumberImg

Gap between hachure lines in pixels.

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

Inherited from Rect.roughHachureGap

roughness​

readonly public roughness: SimpleSignalnumberImg

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 Rect.roughness

roughSeed​

readonly public roughSeed: SimpleSignalnumberundefinedImg

Seed for the random number generator.

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

Inherited from Rect.roughSeed

scale​

readonly public scale: ScaleSignalImg

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

Examples

Inherited from Rect.scale

shaders​

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

shadowBlur​

readonly public shadowBlur: SimpleSignalnumberImg
Inherited from Rect.shadowBlur

shadowColor​

readonly public shadowColor: ColorSignalImg
Inherited from Rect.shadowColor

shadowOffset​

readonly public shadowOffset: Vector2SignalImg
Inherited from Rect.shadowOffset

shrink​

readonly public shrink: SimpleSignalnumberImg
Inherited from Rect.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 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 Rect.size

skew​

readonly public skew: Vector2SignalImg

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

Examples

Inherited from Rect.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 Rect.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: ```ts true ```

src​

readonly public src: SimpleSignalstringImg

The source of this image.

Examples

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

stroke​

readonly public stroke: CanvasStyleSignalImg
Inherited from Rect.stroke

strokeFirst​

readonly public strokeFirst: SimpleSignalbooleanImg
Inherited from Rect.strokeFirst

strokeShaders​

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

textAlign​

readonly public textAlign: SimpleSignalTextAlignImg
Inherited from Rect.textAlign

textDirection​

readonly public textDirection: SimpleSignalCanvasDirectionImg
Inherited from Rect.textDirection

textWrap​

readonly public textWrap: SimpleSignalTextWrapImg
Inherited from Rect.textWrap

top​

readonly public top: LayoutPositionSignalImg

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

topLeft​

readonly public topLeft: LayoutPositionSignalImg

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

topRight​

readonly public topRight: LayoutPositionSignalImg

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

translate​

readonly public translate: Vector2SignalImg

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

Inherited from Rect.translate

verticalAlign​

readonly public verticalAlign: SimpleSignalVerticalAlignImg
Inherited from Rect.verticalAlign

wordBreak​

readonly public wordBreak: SimpleSignalWordBreakImg
Inherited from Rect.wordBreak

wrap​

readonly public wrap: SimpleSignalFlexWrapImg
Inherited from Rect.wrap

yogaNode​

public yogaNode: Node
Inherited from Rect.yogaNode

zIndex​

readonly public zIndex: SimpleSignalnumberImg
Inherited from Rect.zIndex

Accessors​

columnGap​

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

height​

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

rowGap​

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

width​

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

x​

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

y​

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

Methods​

[iterator]​

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

absoluteOpacity​

public absoluteOpacity(): number
Inherited from Rect.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 Rect.add

anchorPosition​

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

cacheBBox​

public cacheBBox(): BBox

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

Inherited from Rect.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 Rect.canLayoutChildren

canvasFont​

public canvasFont(): string
Inherited from Rect.canvasFont

cardinalPoint​

public cardinalPointorigin: OriginDirection: LayoutPositionSignalImg

Get the cardinal point corresponding to the given origin.

Parameters

Inherited from Rect.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 Rect.childAs

childrenAs​

public childrenAs(): T[]

Get the children array cast to the specified type.

Inherited from Rect.childrenAs

clone​

public clonecustomProps: NodeState = {}: this

Create a copy of this node.

Parameters

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

compositeToLocal​

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

computedPosition​

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

getColorAtPoint​

public getColorAtPointposition: PossibleVector2: Color

Get color of the image at the given position.

Parameters

getOriginDelta​

public getOriginDeltaorigin: Origin: Vector2

Parameters

Inherited from Rect.getOriginDelta

getPixelColor​

public getPixelColorposition: PossibleVector2: Color

Get color of the image at the given pixel.

Parameters

getPointAtPercentage​

public getPointAtPercentagevalue: number: CurvePoint

Parameters

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

hit​

public hitposition: Vector2: Nodenull

Try to find a node intersecting the given position.

Parameters

Inherited from Rect.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 Rect.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 Rect.instantiate

isLayoutRoot​

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

parentAs​

public parentAs(): Tnull

Get the parent cast to the specified type.

Inherited from Rect.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 Rect.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 Rect.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 Rect.percentageToDistance

profile​

public profile(): CurveProfile
Inherited from Rect.profile

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 Rect.reactiveClone

releaseLayout​

public releaseLayout(): void

Decrement the layout lock counter.

Inherited from Rect.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 Rect.remove

removeChildren​

public removeChildren(): this

Remove all children of this node.

Inherited from Rect.removeChildren

render​

public rendercontext: CanvasRenderingContext2D: void

Render this node onto the given canvas.

Parameters

Inherited from Rect.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 Rect.reparent

resolvedLineHeight​

public resolvedLineHeight(): number
Inherited from Rect.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 Rect.restore

ripple​

public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany

Parameters

Inherited from Rect.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 Rect.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 Rect.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 Rect.thawLayout

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 Rect.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 Rect.transitionTo

view​

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