Skip to main content

Layout

class Layout extends Node

Extended by

  • Shape

Constructors​

constructor​

public override new Layoutprops: LayoutProps: Layout

Parameters

Overwrites Node.constructor

Properties​

absolutePosition​

readonly public absolutePosition: SimpleVector2SignalLayout

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

absoluteRotation​

readonly public absoluteRotation: SimpleSignalnumberLayout

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

absoluteScale​

readonly public absoluteScale: SimpleVector2SignalLayout

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

alignContent​

readonly public alignContent: SimpleSignalFlexContentLayout

alignItems​

readonly public alignItems: SimpleSignalFlexItemsLayout

alignSelf​

readonly public alignSelf: SimpleSignalFlexItemsLayout

anchor​

readonly public anchor: Vector2SignalLayout

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

basis​

readonly public basis: SimpleSignalFlexBasisLayout

bottom​

readonly public bottom: LayoutPositionSignalLayout

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.

bottomLeft​

readonly public bottomLeft: LayoutPositionSignalLayout

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.

bottomRight​

readonly public bottomRight: LayoutPositionSignalLayout

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.

cache​

readonly public cache: SimpleSignalbooleanLayout
Inherited from Node.cache

cachePadding​

readonly public cachePadding: SpacingSignalLayout

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

children​

readonly public children: SignalComponentChildrenNode[]Layout
Inherited from Node.children

clip​

readonly public clip: SimpleSignalbooleanLayout

composite​

readonly public composite: SimpleSignalbooleanLayout
Inherited from Node.composite

compositeOperation​

readonly public compositeOperation: SimpleSignalGlobalCompositeOperationLayout
Inherited from Node.compositeOperation

creationStack​

readonly public creationStack?: string
Inherited from Node.creationStack

direction​

readonly public direction: SimpleSignalFlexDirectionLayout

filters​

readonly public filters: FiltersSignalLayout
Inherited from Node.filters

fontFamily​

readonly public fontFamily: SimpleSignalstringLayout

fontSize​

readonly public fontSize: SimpleSignalnumberLayout

fontStyle​

readonly public fontStyle: SimpleSignalstringLayout

fontWeight​

readonly public fontWeight: SimpleSignalnumberLayout

gap​

readonly public gap: Vector2LengthSignalLayout

grow​

readonly public grow: SimpleSignalnumberLayout

isClass​

public isClass: boolean
Inherited from Node.isClass

justifyContent​

readonly public justifyContent: SimpleSignalFlexContentLayout

key​

readonly public key: string
Inherited from Node.key

layout​

readonly public layout: SimpleSignalLayoutModeLayout

layoutChildren​

readonly public layoutChildren: SimpleSignalLayoutModeLayout

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

layoutSelf​

readonly public layoutSelf: SimpleSignalLayoutModeLayout

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

left​

readonly public left: LayoutPositionSignalLayout

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.

letterSpacing​

readonly public letterSpacing: SimpleSignalnumberLayout

lineHeight​

readonly public lineHeight: SimpleSignalLengthLayout

margin​

readonly public margin: SpacingSignalLayout

maxHeight​

readonly public maxHeight: SimpleSignalLengthLimitLayout

maxWidth​

readonly public maxWidth: SimpleSignalLengthLimitLayout

middle​

readonly public middle: LayoutPositionSignalLayout

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.

minHeight​

readonly public minHeight: SimpleSignalLengthLimitLayout

minWidth​

readonly public minWidth: SimpleSignalLengthLimitLayout

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

opacity​

readonly public opacity: SimpleSignalnumberLayout

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

The value is clamped to the range 0-1.

Inherited from Node.opacity

padding​

readonly public padding: SpacingSignalLayout

parent​

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

position​

readonly public position: PositionSignalLayout

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

Examples

Inherited from Node.position

properties​

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

ratio​

readonly public ratio: SimpleSignalnumbernullLayout
readonly public right: LayoutPositionSignalLayout

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.

rotation​

readonly public rotation: RotationSignalLayout

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

Inherited from Node.rotation

scale​

readonly public scale: ScaleSignalLayout

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

Examples

Inherited from Node.scale

shaders​

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

shadowBlur​

readonly public shadowBlur: SimpleSignalnumberLayout
Inherited from Node.shadowBlur

shadowColor​

readonly public shadowColor: ColorSignalLayout
Inherited from Node.shadowColor

shadowOffset​

readonly public shadowOffset: Vector2SignalLayout
Inherited from Node.shadowOffset

shrink​

readonly public shrink: SimpleSignalnumberLayout

size​

readonly public size: Vector2LengthSignalLayout

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

skew​

readonly public skew: Vector2SignalLayout

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

Examples

Inherited from Node.skew

textAlign​

readonly public textAlign: SimpleSignalTextAlignLayout

textDirection​

readonly public textDirection: SimpleSignalCanvasDirectionLayout

textWrap​

readonly public textWrap: SimpleSignalTextWrapLayout

top​

readonly public top: LayoutPositionSignalLayout

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.

topLeft​

readonly public topLeft: LayoutPositionSignalLayout

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.

topRight​

readonly public topRight: LayoutPositionSignalLayout

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.

translate​

readonly public translate: Vector2SignalLayout

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

verticalAlign​

readonly public verticalAlign: SimpleSignalVerticalAlignLayout

wordBreak​

readonly public wordBreak: SimpleSignalWordBreakLayout

wrap​

readonly public wrap: SimpleSignalFlexWrapLayout

yogaNode​

public yogaNode: Node

zIndex​

readonly public zIndex: SimpleSignalnumberLayout
Inherited from Node.zIndex

Accessors​

columnGap​

public get columnGap(): SignalLengthnumberthis

height​

public get height(): SignalLengthnumberthis

rowGap​

public get rowGap(): SignalLengthnumberthis

width​

public get width(): SignalLengthnumberthis

x​

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

y​

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

Methods​

[iterator]​

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

absoluteOpacity​

public absoluteOpacity(): number
Inherited from Node.absoluteOpacity

add​

public override addnode: ComponentChildren: this
public override 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
Overwrites Node.add

anchorPosition​

public anchorPosition(): Vector2

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 Node.applyState

cacheBBox​

public cacheBBox(): BBox

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

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

canvasFont​

public canvasFont(): string

cardinalPoint​

public cardinalPointorigin: OriginDirection: LayoutPositionSignalLayout

Get the cardinal point corresponding to the given origin.

Parameters

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

childrenAs​

public childrenAs(): T[]

Get the children array cast to the specified type.

Inherited from Node.childrenAs

clone​

public clonecustomProps: NodeState = {}: this

Create a copy of this node.

Parameters

Inherited from Node.clone

compositeToLocal​

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

computedPosition​

public computedPosition(): Vector2

dispose​

public override 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.

Overwrites Node.dispose

drawOverlay​

public override 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

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

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

getOriginDelta​

public getOriginDeltaorigin: Origin: Vector2

Parameters

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

hit​

public override hitposition: Vector2: Nodenull

Try to find a node intersecting the given position.

Parameters

Overwrites Node.hit

insert​

public override insertnode: ComponentChildrenindex?: number: this
public override 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

Overwrites Node.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 Node.instantiate

isLayoutRoot​

public isLayoutRoot(): boolean

layoutEnabled​

public layoutEnabled(): boolean

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

localToParent​

public override 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.

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

morphTo​

public override 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

Overwrites Node.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 Node.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 Node.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 Node.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 Node.moveDown

moveOffset​

public moveOffsetoffset: Vector2: void

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

Parameters

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

parentAs​

public parentAs(): Tnull

Get the parent cast to the specified type.

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

reactiveClone​

public reactiveClonecustomProps: NodeState = {}: this

Create a reactive copy of this node.

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

Parameters

Inherited from Node.reactiveClone

releaseLayout​

public releaseLayout(): void

Decrement the layout lock counter.

remove​

public override remove(): this
public override 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.

Overwrites Node.remove

removeChildren​

public removeChildren(): this

Remove all children of this node.

Inherited from Node.removeChildren

render​

public rendercontext: CanvasRenderingContext2D: void

Render this node onto the given canvas.

Parameters

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

resolvedLineHeight​

public resolvedLineHeight(): number

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

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

toPromise​

public toPromise(): PromiseLayout

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

transitionTo​

public override 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

Overwrites Node.transitionTo

view​

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