Txt

class Txt extends Shape

Constructors​

constructor​

public override new Txt{...}: TxtProps: Txt

Parameters

• {...}: TxtProps

Properties​

absolutePosition​

readonly public absolutePosition: SimpleVector2SignalTxt

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.

absoluteRotation​

readonly public absoluteRotation: SimpleSignalnumberTxt

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.

absoluteScale​

readonly public absoluteScale: SimpleVector2SignalTxt

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.

alignContent​

readonly public alignContent: SimpleSignalFlexContentTxt

alignItems​

readonly public alignItems: SimpleSignalFlexItemsTxt

alignSelf​

readonly public alignSelf: SimpleSignalFlexItemsTxt

antialiased​

readonly public antialiased: SimpleSignalbooleanTxt

basis​

readonly public basis: SimpleSignalFlexBasisTxt

bottom​

readonly public bottom: SimpleVector2SignalTxt

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

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

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

cachePadding​

readonly public cachePadding: SpacingSignalTxt

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.

children​

readonly public children: SignalComponentChildrenNode[]Txt

clip​

readonly public clip: SimpleSignalbooleanTxt

composite​

readonly public composite: SimpleSignalbooleanTxt

compositeOperation​

readonly public compositeOperation: SimpleSignalGlobalCompositeOperationTxt

creationStack​

readonly public creationStack?: string

direction​

readonly public direction: SimpleSignalFlexDirectionTxt

element​

public element: HTMLElement

fill​

readonly public fill: CanvasStyleSignalTxt

filters​

readonly public filters: FiltersSignalTxt

fontFamily​

readonly public fontFamily: SimpleSignalstringTxt

fontSize​

readonly public fontSize: SimpleSignalnumberTxt

fontStyle​

readonly public fontStyle: SimpleSignalstringTxt

fontWeight​

readonly public fontWeight: SimpleSignalnumberTxt

gap​

readonly public gap: Vector2LengthSignalTxt

grow​

readonly public grow: SimpleSignalnumberTxt

isClass​

public isClass: boolean

justifyContent​

readonly public justifyContent: SimpleSignalFlexContentTxt

key​

readonly public key: string

layout​

readonly public layout: SimpleSignalLayoutModeTxt

left​

readonly public left: SimpleVector2SignalTxt

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

lineCap​

readonly public lineCap: SimpleSignalCanvasLineCapTxt

lineDash​

readonly public lineDash: SimpleSignalnumber[]Txt

lineDashOffset​

readonly public lineDashOffset: SimpleSignalnumberTxt

lineHeight​

readonly public lineHeight: SimpleSignalLengthTxt

lineJoin​

readonly public lineJoin: SimpleSignalCanvasLineJoinTxt

lineWidth​

readonly public lineWidth: SimpleSignalnumberTxt

margin​

readonly public margin: SpacingSignalTxt

maxHeight​

readonly public maxHeight: SimpleSignalLengthLimitTxt

maxWidth​

readonly public maxWidth: SimpleSignalLengthLimitTxt

middle​

readonly public middle: SimpleVector2SignalTxt

The position of the center of this node.

When set, this shortcut property will modify the node's position so that the center ends up in the given place.

If the offset has not been changed, this will be the same as the position.

When retrieved, it will return the position of the center in the parent space.

minHeight​

readonly public minHeight: SimpleSignalLengthLimitTxt

minWidth​

readonly public minWidth: SimpleSignalLengthLimitTxt

offset​

readonly public offset: Vector2SignalTxt

Represents the offset of this node's origin.

By default, the origin of a node is located at its center. The origin serves as the pivot point when rotating and scaling a node, but it doesn't affect the placement of its children.

The value is relative to the size of this node. A value of 1 means as far to the right/bottom as possible. Here are a few examples of offsets:

• [-1, -1] - top left corner
• [1, -1] - top right corner
• [0, 1] - bottom edge
• [-1, 1] - bottom left corner

opacity​

readonly public opacity: SimpleSignalnumberTxt

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

The value is clamped to the range 0-1.

padding​

readonly public padding: SpacingSignalTxt

parent​

readonly public parent: SimpleSignalnullNodevoid = ...

position​

readonly public position: Vector2SignalTxt

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

Examples

properties​

readonly public properties: RecordstringPropertyMetadataany = ...

ratio​

readonly public ratio: SimpleSignalnullnumberTxt

right​

readonly public right: SimpleVector2SignalTxt

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

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

scale​

readonly public scale: Vector2SignalTxt

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

Examples

shaders​

readonly public shaders: SignalPossibleShaderConfigShaderConfig[]Txt

shadowBlur​

readonly public shadowBlur: SimpleSignalnumberTxt

shadowColor​

readonly public shadowColor: ColorSignalTxt

shadowOffset​

readonly public shadowOffset: Vector2SignalTxt

shrink​

readonly public shrink: SimpleSignalnumberTxt

size​

readonly public size: Vector2LengthSignalTxt

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 entire scene.

Examples

skew​

readonly public skew: Vector2SignalTxt

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

Examples

stroke​

readonly public stroke: CanvasStyleSignalTxt

strokeFirst​

readonly public strokeFirst: SimpleSignalbooleanTxt

styles​

public styles: CSSStyleDeclaration

text​

readonly public text: SimpleSignalstringTxt

textAlign​

readonly public textAlign: SimpleSignalCanvasTextAlignTxt

textDirection​

readonly public textDirection: SimpleSignalCanvasDirectionTxt

textWrap​

readonly public textWrap: SimpleSignalTextWrapTxt

top​

readonly public top: SimpleVector2SignalTxt

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

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

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.

wrap​

readonly public wrap: SimpleSignalFlexWrapTxt

zIndex​

readonly public zIndex: SimpleSignalnumberTxt

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(): SimpleSignalnumberthis

y​

public get y(): SimpleSignalnumberthis

Methods​

[iterator]​

public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidunknown

absoluteOpacity​

public absoluteOpacity(): number

add​

public addnode: ComponentChildren: this

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

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

Examples

Parameters

• node: ComponentChildren

  A node or an array of nodes to append.

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.

cacheBBox​

public cacheBBox(): BBox

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

cardinalPoint​

public cardinalPointorigin: OriginDirection: SimpleVector2SignalTxt

Get the cardinal point corresponding to the given origin.

Parameters

• origin: OriginDirection

  The origin or direction of the point.

childAs​

public childAsindex: number: nullT

Get the nth children cast to the specified type.

Parameters

• index: number

  The index of the child to retrieve.

childrenAs​

public childrenAs(): T[]

Get the children array cast to the specified type.

clone​

public clonecustomProps: NodeState = {}: this

Create a copy of this node.

Parameters

• customProps: NodeState = {}

  Properties to override.

compositeToLocal​

public compositeToLocal(): DOMMatrix

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.

computedPosition​

public computedPosition(): Vector2

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.

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

• context: CanvasRenderingContext2D

  The context to draw with.

• matrix: DOMMatrix

  A local-to-screen matrix.

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.

findAncestor​

public findAncestorpredicate: node: Node => node is T: nullT

public findAncestorpredicate: node: Node => boolean: nullT

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.

findFirst​

public findFirstpredicate: node: Node => node is T: nullT

public findFirstpredicate: node: Node => boolean: nullT

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.

findLast​

public findLastpredicate: node: Node => node is T: nullT

public findLastpredicate: node: Node => boolean: nullT

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.

getOriginDelta​

public getOriginDeltaorigin: Origin: Vector2

Parameters

• origin: Origin

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.

hit​

public hitposition: Vector2: nullNode

Try to find a node intersecting the given position.

Parameters

• position: Vector2

  The searched position.

insert​

public insertnode: ComponentChildrenindex: number = 0: this

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

Examples

Parameters

• node: ComponentChildren

  A node or an array of nodes to insert.

• index: number = 0

  An index at which to insert the node(s).

instantiate​

public instantiateprops: NodeProps = {}: this

Create an instance of this node's class.

Parameters

• props: NodeProps = {}

  Properties to pass to the constructor.

isLayoutRoot​

public isLayoutRoot(): boolean

layoutEnabled​

public layoutEnabled(): boolean

Get the resolved layout mode of this node.

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

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

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.

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

lockSize​

public lockSize(): void

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.

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.

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.

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.

moveOffset​

public moveOffsetoffset: Vector2: void

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

Parameters

• offset: Vector2

  The new offset.

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.

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.

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.

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.

parentAs​

public parentAs(): nullT

Get the parent cast to the specified type.

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.

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.

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

• customProps: NodeState = {}

  Properties to override.

releaseSize​

public releaseSize(): void

remove​

public remove(): this

Remove this node from the tree.

removeChildren​

public removeChildren(): this

Remove all children of this node.

render​

public rendercontext: CanvasRenderingContext2D: void

Render this node onto the given canvas.

Parameters

• context: CanvasRenderingContext2D

  The context to draw with.

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

• newParent: Node

  The new parent of this node.

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

ripple​

public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany

Parameters

• duration: number = 1

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.

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

• customProps: NodeState = {}

  Properties to override.

toPromise​

public toPromise(): PromiseTxt

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.

view​

public view(): View2D

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

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.

b​

static public bprops: TxtProps: Txt

Create a bold text node.

This is a shortcut for

<Txt fontWeight={700} />

Parameters

• props: TxtProps

  Additional text properties.

i​

static public iprops: TxtProps: Txt

Create an italic text node.

This is a shortcut for

<Txt fontStyle={'italic'} />

Parameters

• props: TxtProps

  Additional text properties.