Skip to main content

Rect

class Rect extends Curve

Extended by

  • Img
  • Video
  • View2D

Constructors​

constructor​

public override new Rectprops: RectProps: Rect

Parameters

Overwrites Curve.constructor

Properties​

absolutePosition​

readonly public absolutePosition: SimpleVector2SignalRect

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

absoluteRotation​

readonly public absoluteRotation: SimpleSignalnumberRect

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

absoluteScale​

readonly public absoluteScale: SimpleVector2SignalRect

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

alignContent​

readonly public alignContent: SimpleSignalFlexContentRect
Inherited from Curve.alignContent

alignItems​

readonly public alignItems: SimpleSignalFlexItemsRect
Inherited from Curve.alignItems

alignSelf​

readonly public alignSelf: SimpleSignalFlexItemsRect
Inherited from Curve.alignSelf

anchor​

readonly public anchor: Vector2SignalRect

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 Curve.anchor

antialiased​

readonly public antialiased: SimpleSignalbooleanRect
Inherited from Curve.antialiased

arrowSize​

readonly public arrowSize: SimpleSignalnumberRect

Controls the size of the end and start arrows.

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

Inherited from Curve.arrowSize

basis​

readonly public basis: SimpleSignalFlexBasisRect
Inherited from Curve.basis

bottom​

readonly public bottom: LayoutPositionSignalRect

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

bottomLeft​

readonly public bottomLeft: LayoutPositionSignalRect

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

bottomRight​

readonly public bottomRight: LayoutPositionSignalRect

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

bowing​

readonly public bowing: SimpleSignalnumberRect

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

cache​

readonly public cache: SimpleSignalbooleanRect
Inherited from Curve.cache

cachePadding​

readonly public cachePadding: SpacingSignalRect

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

children​

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

clip​

readonly public clip: SimpleSignalbooleanRect
Inherited from Curve.clip

closed​

readonly public closed: SimpleSignalbooleanRect

Whether the curve should be closed.

Closed curves have their start and end points connected.

Inherited from Curve.closed

composite​

readonly public composite: SimpleSignalbooleanRect
Inherited from Curve.composite

compositeOperation​

readonly public compositeOperation: SimpleSignalGlobalCompositeOperationRect
Inherited from Curve.compositeOperation

cornerSharpness​

readonly public cornerSharpness: SimpleSignalnumberRect

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

creationStack​

readonly public creationStack?: string
Inherited from Curve.creationStack

direction​

readonly public direction: SimpleSignalFlexDirectionRect
Inherited from Curve.direction

end​

readonly public end: SimpleSignalnumberRect

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

endArrow​

readonly public endArrow: SimpleSignalbooleanRect

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

Use arrowSize to control the size of the arrow.

Inherited from Curve.endArrow

endOffset​

readonly public endOffset: SimpleSignalnumberRect

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

fill​

readonly public fill: CanvasStyleSignalRect
Inherited from Curve.fill

fillShaders​

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

filters​

readonly public filters: FiltersSignalRect
Inherited from Curve.filters

fontFamily​

readonly public fontFamily: SimpleSignalstringRect
Inherited from Curve.fontFamily

fontSize​

readonly public fontSize: SimpleSignalnumberRect
Inherited from Curve.fontSize

fontStyle​

readonly public fontStyle: SimpleSignalstringRect
Inherited from Curve.fontStyle

fontWeight​

readonly public fontWeight: SimpleSignalnumberRect
Inherited from Curve.fontWeight

gap​

readonly public gap: Vector2LengthSignalRect
Inherited from Curve.gap

grow​

readonly public grow: SimpleSignalnumberRect
Inherited from Curve.grow

isClass​

public isClass: boolean
Inherited from Curve.isClass

justifyContent​

readonly public justifyContent: SimpleSignalFlexContentRect
Inherited from Curve.justifyContent

key​

readonly public key: string
Inherited from Curve.key

layout​

readonly public layout: SimpleSignalLayoutModeRect
Inherited from Curve.layout

layoutChildren​

readonly public layoutChildren: SimpleSignalLayoutModeRect

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

Inherited from Curve.layoutChildren

layoutSelf​

readonly public layoutSelf: SimpleSignalLayoutModeRect

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

Inherited from Curve.layoutSelf

left​

readonly public left: LayoutPositionSignalRect

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

letterSpacing​

readonly public letterSpacing: SimpleSignalnumberRect
Inherited from Curve.letterSpacing

lineCap​

readonly public lineCap: SimpleSignalCanvasLineCapRect
Inherited from Curve.lineCap

lineDash​

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

lineDashOffset​

readonly public lineDashOffset: SimpleSignalnumberRect
Inherited from Curve.lineDashOffset

lineHeight​

readonly public lineHeight: SimpleSignalLengthRect
Inherited from Curve.lineHeight

lineJoin​

readonly public lineJoin: SimpleSignalCanvasLineJoinRect
Inherited from Curve.lineJoin

lineWidth​

readonly public lineWidth: SimpleSignalnumberRect
Inherited from Curve.lineWidth

margin​

readonly public margin: SpacingSignalRect
Inherited from Curve.margin

maxHeight​

readonly public maxHeight: SimpleSignalLengthLimitRect
Inherited from Curve.maxHeight

maxWidth​

readonly public maxWidth: SimpleSignalLengthLimitRect
Inherited from Curve.maxWidth

middle​

readonly public middle: LayoutPositionSignalRect

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

minHeight​

readonly public minHeight: SimpleSignalLengthLimitRect
Inherited from Curve.minHeight

minWidth​

readonly public minWidth: SimpleSignalLengthLimitRect

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

opacity​

readonly public opacity: SimpleSignalnumberRect

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

The value is clamped to the range 0-1.

Inherited from Curve.opacity

padding​

readonly public padding: SpacingSignalRect
Inherited from Curve.padding

parent​

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

position​

readonly public position: PositionSignalRect

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

Examples

Inherited from Curve.position

properties​

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

radius​

readonly public radius: SpacingSignalRect

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

ratio​

readonly public ratio: SimpleSignalnumbernullRect
Inherited from Curve.ratio
readonly public right: LayoutPositionSignalRect

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

rotation​

readonly public rotation: RotationSignalRect

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

Inherited from Curve.rotation

rough​

readonly public rough: SimpleSignalbooleanRect

Enable rough.js rendering.

Inherited from Curve.rough

roughDisableMultiStroke​

readonly public roughDisableMultiStroke: SimpleSignalbooleanRect

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

roughDisableMultiStrokeFill​

readonly public roughDisableMultiStrokeFill: SimpleSignalbooleanRect

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

roughFillStyle​

readonly public roughFillStyle: SimpleSignalRoughFillStyleRect

Fill style for the shape.

Inherited from Curve.roughFillStyle

roughFillWeight​

readonly public roughFillWeight: SimpleSignalnumberundefinedRect

Thickness of the lines used for filling.

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

Inherited from Curve.roughFillWeight

roughHachureAngle​

readonly public roughHachureAngle: SimpleSignalnumberRect

Angle of the hachure lines in degrees.

Only applicable for hachure and cross-hatch fill styles.

Inherited from Curve.roughHachureAngle

roughHachureGap​

readonly public roughHachureGap: SimpleSignalnumberRect

Gap between hachure lines in pixels.

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

Inherited from Curve.roughHachureGap

roughness​

readonly public roughness: SimpleSignalnumberRect

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

roughSeed​

readonly public roughSeed: SimpleSignalnumberundefinedRect

Seed for the random number generator.

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

Inherited from Curve.roughSeed

scale​

readonly public scale: ScaleSignalRect

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

Examples

Inherited from Curve.scale

shaders​

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

shadowBlur​

readonly public shadowBlur: SimpleSignalnumberRect
Inherited from Curve.shadowBlur

shadowColor​

readonly public shadowColor: ColorSignalRect
Inherited from Curve.shadowColor

shadowOffset​

readonly public shadowOffset: Vector2SignalRect
Inherited from Curve.shadowOffset

shrink​

readonly public shrink: SimpleSignalnumberRect
Inherited from Curve.shrink

size​

readonly public size: Vector2LengthSignalRect

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

skew​

readonly public skew: Vector2SignalRect

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

Examples

Inherited from Curve.skew

smoothCorners​

readonly public smoothCorners: SimpleSignalbooleanRect

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

start​

readonly public start: SimpleSignalnumberRect

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

startArrow​

readonly public startArrow: SimpleSignalbooleanRect

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

Use arrowSize to control the size of the arrow.

Inherited from Curve.startArrow

startOffset​

readonly public startOffset: SimpleSignalnumberRect

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

stroke​

readonly public stroke: CanvasStyleSignalRect
Inherited from Curve.stroke

strokeFirst​

readonly public strokeFirst: SimpleSignalbooleanRect
Inherited from Curve.strokeFirst

strokeShaders​

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

textAlign​

readonly public textAlign: SimpleSignalTextAlignRect
Inherited from Curve.textAlign

textDirection​

readonly public textDirection: SimpleSignalCanvasDirectionRect
Inherited from Curve.textDirection

textWrap​

readonly public textWrap: SimpleSignalTextWrapRect
Inherited from Curve.textWrap

top​

readonly public top: LayoutPositionSignalRect

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

topLeft​

readonly public topLeft: LayoutPositionSignalRect

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

topRight​

readonly public topRight: LayoutPositionSignalRect

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

translate​

readonly public translate: Vector2SignalRect

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

Inherited from Curve.translate

verticalAlign​

readonly public verticalAlign: SimpleSignalVerticalAlignRect
Inherited from Curve.verticalAlign

wordBreak​

readonly public wordBreak: SimpleSignalWordBreakRect
Inherited from Curve.wordBreak

wrap​

readonly public wrap: SimpleSignalFlexWrapRect
Inherited from Curve.wrap

yogaNode​

public yogaNode: Node
Inherited from Curve.yogaNode

zIndex​

readonly public zIndex: SimpleSignalnumberRect
Inherited from Curve.zIndex

Accessors​

columnGap​

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

height​

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

rowGap​

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

width​

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

x​

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

y​

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

Methods​

[iterator]​

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

absoluteOpacity​

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

anchorPosition​

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

cacheBBox​

public cacheBBox(): BBox

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

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

canvasFont​

public canvasFont(): string
Inherited from Curve.canvasFont

cardinalPoint​

public cardinalPointorigin: OriginDirection: LayoutPositionSignalRect

Get the cardinal point corresponding to the given origin.

Parameters

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

childrenAs​

public childrenAs(): T[]

Get the children array cast to the specified type.

Inherited from Curve.childrenAs

clone​

public clonecustomProps: NodeState = {}: this

Create a copy of this node.

Parameters

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

compositeToLocal​

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

computedPosition​

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

getOriginDelta​

public getOriginDeltaorigin: Origin: Vector2

Parameters

Inherited from Curve.getOriginDelta

getPointAtPercentage​

public getPointAtPercentagevalue: number: CurvePoint

Parameters

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

hit​

public hitposition: Vector2: Nodenull

Try to find a node intersecting the given position.

Parameters

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

isLayoutRoot​

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

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

parentAs​

public parentAs(): Tnull

Get the parent cast to the specified type.

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

profile​

public override profile(): CurveProfile
Overwrites Curve.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 Curve.reactiveClone

releaseLayout​

public releaseLayout(): void

Decrement the layout lock counter.

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

removeChildren​

public removeChildren(): this

Remove all children of this node.

Inherited from Curve.removeChildren

render​

public rendercontext: CanvasRenderingContext2D: void

Render this node onto the given canvas.

Parameters

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

resolvedLineHeight​

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

ripple​

public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany

Parameters

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

toPromise​

public toPromise(): PromiseRect

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

view​

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