Skip to main content

Txt

class Txt extends Shape

A paragraph of text. A nested Txt is a span of its root's paragraph.

A nested Txt does not lay itself out, and ignores its width, height and padding. Its size() is the extent of the pieces it owns in the root's placement, from the first line's top to the last line's bottom, in its own space, and its cacheBBox() is that box around its text. Its position() is the offset its own x and y give from its parent's center, as for any node outside a flex layout. Its text queries read the root's placement: textLines() from the top left of its extent, and the units of textWords() and split() in its own space.

Constructors​

constructor​

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

Parameters

Overwrites Shape.constructor

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.

Deprecated

Use position.abs instead.

Inherited from Shape.absolutePosition

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.

Deprecated

Use rotation.abs instead.

Inherited from Shape.absoluteRotation

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.

Deprecated

Use scale.abs instead.

Inherited from Shape.absoluteScale

alignContent​

readonly public alignContent: SimpleSignalFlexContentTxt
Inherited from Shape.alignContent

alignItems​

readonly public alignItems: SimpleSignalFlexItemsTxt
Inherited from Shape.alignItems

alignSelf​

readonly public alignSelf: SimpleSignalFlexItemsTxt
Inherited from Shape.alignSelf

anchor​

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

antialiased​

readonly public antialiased: SimpleSignalbooleanTxt
Inherited from Shape.antialiased

autoSize​

readonly public autoSize: SimpleSignalbooleanTxt

Automatically shrink the font to fit the configured width and height.

When true, the rendered font size is the largest whole pixel size at or below fontSize whose layout fits the configured box. Requires both width and height to resolve to concrete pixel numbers; falls back to the raw fontSize otherwise.

Examples

basis​

readonly public basis: SimpleSignalFlexBasisTxt
Inherited from Shape.basis

bottom​

readonly public bottom: LayoutPositionSignalTxt

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

bottomLeft​

readonly public bottomLeft: LayoutPositionSignalTxt

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

bottomRight​

readonly public bottomRight: LayoutPositionSignalTxt

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

bowing​

readonly public bowing: SimpleSignalnumberTxt

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

cache​

readonly public cache: SimpleSignalbooleanTxt
Inherited from Shape.cache

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.

Inherited from Shape.cachePadding

children​

readonly public children: SignalComponentChildrenNode[]Txt
Inherited from Shape.children

clip​

readonly public clip: SimpleSignalbooleanTxt
Inherited from Shape.clip

composite​

readonly public composite: SimpleSignalbooleanTxt
Inherited from Shape.composite

compositeOperation​

readonly public compositeOperation: SimpleSignalGlobalCompositeOperationTxt
Inherited from Shape.compositeOperation

creationStack​

readonly public creationStack?: string
Inherited from Shape.creationStack

direction​

readonly public direction: SimpleSignalFlexDirectionTxt
Inherited from Shape.direction

exclusions​

readonly public exclusions: SimpleSignalTextExclusion[]Txt

Shapes that text should flow around (CSS shape-outside-style obstacles), in Txt-local center-origin coordinates. A node exclusion reads its shape from a live Node and follows that node's transform and size.

Each line is broken against the free segment its own line box leaves, so a taller run or a tall inline element flows around the same shape correctly. A flex layout may place the text, the node, or both: the layout repeats its pass until the text agrees with the boxes it placed. A node the same pass places blocks its box, or the ellipse in it for a full Circle. When the text's size moves the node (a flex sibling after a text that shrinks, a root that grows around its center), the passes may find no such boxes; the layout then keeps the boxes that give the text the least height, and of those the widest: the text flows around the node where those boxes put it, and the node paints where the text's size then moves it. A tween through such states can jitter, because each frame keeps the best boxes its own passes reach. autoSize fits the text to the boxes the layout keeps. A node this text's own flow places throws, because its place needs the lines it would shape.

Examples

fill​

readonly public fill: CanvasStyleSignalTxt
Inherited from Shape.fill

fillShaders​

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

filters​

readonly public filters: FiltersSignalTxt
Inherited from Shape.filters

fontFamily​

readonly public fontFamily: SimpleSignalstringTxt
Inherited from Shape.fontFamily

fontSize​

readonly public fontSize: SimpleSignalnumberTxt
Inherited from Shape.fontSize

fontStyle​

readonly public fontStyle: SimpleSignalstringTxt
Inherited from Shape.fontStyle

fontWeight​

readonly public fontWeight: SimpleSignalnumberTxt
Inherited from Shape.fontWeight

gap​

readonly public gap: Vector2LengthSignalTxt
Inherited from Shape.gap

grow​

readonly public grow: SimpleSignalnumberTxt
Inherited from Shape.grow

hyphenate​

readonly public hyphenate: SimpleSignalHyphenateFnnullTxt

Word-level hyphenator. Receives a single word and returns an array of syllable-like pieces; pieces are rejoined with U+00AD (soft hyphen), which the line breaker treats as optional break points.

No bundled dictionary — wire in your own (Hyphenopoly, hypher, etc.) or leave this null to disable hyphenation.

Signals treat raw function values as reactive getters, so set this via a thunk: hyphenate={() => myHyphenator} (JSX) or txt.hyphenate(() => myHyphenator) (imperative). Calling txt.hyphenate() then returns the hyphenator.

isClass​

public isClass: boolean
Inherited from Shape.isClass

justifyContent​

readonly public justifyContent: SimpleSignalFlexContentTxt
Inherited from Shape.justifyContent

key​

readonly public key: string
Inherited from Shape.key

layout​

readonly public layout: SimpleSignalLayoutModeTxt
Inherited from Shape.layout

layoutChildren​

readonly public layoutChildren: SimpleSignalLayoutModeTxt

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

Inherited from Shape.layoutChildren

layoutSelf​

readonly public layoutSelf: SimpleSignalLayoutModeTxt

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

Inherited from Shape.layoutSelf

left​

readonly public left: LayoutPositionSignalTxt

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

letterSpacing​

readonly public letterSpacing: SimpleSignalnumberTxt
Inherited from Shape.letterSpacing

lineCap​

readonly public lineCap: SimpleSignalCanvasLineCapTxt
Inherited from Shape.lineCap

lineDash​

readonly public lineDash: SimpleSignalnumber[]Txt
Inherited from Shape.lineDash

lineDashOffset​

readonly public lineDashOffset: SimpleSignalnumberTxt
Inherited from Shape.lineDashOffset

lineHeight​

readonly public lineHeight: SimpleSignalLengthTxt
Inherited from Shape.lineHeight

lineJoin​

readonly public lineJoin: SimpleSignalCanvasLineJoinTxt
Inherited from Shape.lineJoin

lineWidth​

readonly public lineWidth: SimpleSignalnumberTxt
Inherited from Shape.lineWidth

margin​

readonly public margin: SpacingSignalTxt
Inherited from Shape.margin

maxHeight​

readonly public maxHeight: SimpleSignalLengthLimitTxt
Inherited from Shape.maxHeight

maxWidth​

readonly public maxWidth: SimpleSignalLengthLimitTxt
Inherited from Shape.maxWidth

middle​

readonly public middle: LayoutPositionSignalTxt

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

minHeight​

readonly public minHeight: SimpleSignalLengthLimitTxt
Inherited from Shape.minHeight

minWidth​

readonly public minWidth: SimpleSignalLengthLimitTxt

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

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.

Inherited from Shape.opacity

overflowWrap​

readonly public overflowWrap: SimpleSignalOverflowWrapModeTxt

What a word wider than the line may do, as CSS overflow-wrap.

  • 'normal' (default) — the word stays whole and overflows the box. A break the word offers of its own (a dash, a soft hyphen) is still taken.
  • 'anywhere' — the word breaks at a grapheme so the line fits.

Examples

padding​

readonly public padding: SpacingSignalTxt
Inherited from Shape.padding

parent​

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

pathAlign​

readonly public pathAlign: SimpleSignalPathAlignTxt

Where each glyph rides textPath across the curve — baseline (default), top / middle / bottom, smooth, or a number in [-1, 1].

Anchoring to the outside of a turn keeps glyphs from crowding on the inside of a corner. smooth does this automatically, biasing each glyph toward the outside in proportion to how hard the path turns under it. The numeric form (-1 top, 0 middle, 1 bottom) is continuous, so it tweens cleanly — prefer it over switching keyword states mid-animation.

Examples

pathOffset​

readonly public pathOffset: SimpleSignalnumberTxt

Distance in pixels to slide the text along textPath from its anchored start. Animate this for a marquee-style crawl along the curve. On a closed path the offset wraps around the loop.

Examples

pathSmoothness​

readonly public pathSmoothness: SimpleSignalnumberTxt

How hard pathAlign 'smooth' leans into a turn — the gain mapping a vertex's signed turn (radians) to the [-1, 1] anchor.

At the default 1.4 a ~64° corner saturates to a full top/bottom anchor; raise it to reach the edge on gentler turns, lower it for a subtler lean. No effect unless pathAlign is 'smooth'.

pathSplit​

readonly public pathSplit: SimpleSignalPathSplitTxt

Unit the text breaks into along textPath — grapheme (default) for the tightest curve following, or word to keep contextual shaping and ligatures (e.g. Arabic) by painting each word as one run.

Per-glyph rendering paints each grapheme in isolation, which drops cross-glyph shaping; word trades some curve fidelity (words stay rigid through a bend) for correct shaping.

position​

readonly public position: PositionSignalTxt

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

Examples

Inherited from Shape.position

properties​

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

ratio​

readonly public ratio: SimpleSignalnumbernullTxt
Inherited from Shape.ratio
readonly public right: LayoutPositionSignalTxt

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

rotation​

readonly public rotation: RotationSignalTxt

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

Inherited from Shape.rotation

rough​

readonly public rough: SimpleSignalbooleanTxt

Enable rough.js rendering.

Inherited from Shape.rough

roughDisableMultiStroke​

readonly public roughDisableMultiStroke: SimpleSignalbooleanTxt

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

roughDisableMultiStrokeFill​

readonly public roughDisableMultiStrokeFill: SimpleSignalbooleanTxt

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

roughFillStyle​

readonly public roughFillStyle: SimpleSignalRoughFillStyleTxt

Fill style for the shape.

Inherited from Shape.roughFillStyle

roughFillWeight​

readonly public roughFillWeight: SimpleSignalnumberundefinedTxt

Thickness of the lines used for filling.

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

Inherited from Shape.roughFillWeight

roughHachureAngle​

readonly public roughHachureAngle: SimpleSignalnumberTxt

Angle of the hachure lines in degrees.

Only applicable for hachure and cross-hatch fill styles.

Inherited from Shape.roughHachureAngle

roughHachureGap​

readonly public roughHachureGap: SimpleSignalnumberTxt

Gap between hachure lines in pixels.

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

Inherited from Shape.roughHachureGap

roughness​

readonly public roughness: SimpleSignalnumberTxt

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

roughSeed​

readonly public roughSeed: SimpleSignalnumberundefinedTxt

Seed for the random number generator.

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

Inherited from Shape.roughSeed

scale​

readonly public scale: ScaleSignalTxt

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

Examples

Inherited from Shape.scale

shaders​

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

shadowBlur​

readonly public shadowBlur: SimpleSignalnumberTxt
Inherited from Shape.shadowBlur

shadowColor​

readonly public shadowColor: ColorSignalTxt
Inherited from Shape.shadowColor

shadowOffset​

readonly public shadowOffset: Vector2SignalTxt
Inherited from Shape.shadowOffset

shrink​

readonly public shrink: SimpleSignalnumberTxt
Inherited from Shape.shrink

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 nearest ancestor that has a size or a layout, which is the entire scene when no other ancestor does.

Examples

Inherited from Shape.size

skew​

readonly public skew: Vector2SignalTxt

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

Examples

Inherited from Shape.skew

stroke​

readonly public stroke: CanvasStyleSignalTxt
Inherited from Shape.stroke

strokeFirst​

readonly public strokeFirst: SimpleSignalbooleanTxt
Inherited from Shape.strokeFirst

strokeShaders​

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

text​

readonly public text: SimpleSignalstringTxt

textAlign​

readonly public textAlign: SimpleSignalTextAlignTxt
Inherited from Shape.textAlign

textDirection​

readonly public textDirection: SimpleSignalCanvasDirectionTxt
Inherited from Shape.textDirection

textPath​

readonly public textPath: SimpleSignalTxtPathnullTxt

Lay the text out along a curve instead of a straight baseline.

Accepts SVG path data, a CurveProfile, or a live Curve node. Strings and profiles are read in this node's local (center-origin) space; a Curve node is sampled in its own space and mapped into this node's automatically, so the two may sit at different transforms. Only translation, rotation, and uniform scale map correctly — non-uniform scale or shear between the two distorts spacing.

Setting a path forces a single line (wrapping, autoSize, and embedded newlines are ignored) and disables split / textWords and friends. On an open path, glyphs whose advance falls outside it are clipped, not piled at the ends. On a closed path (start and end meet), the text wraps around the loop. pathOffset slides the run along the arc. textAlign anchors it. Reverse the path to flip the text onto the other side (the tangent reverses, so glyphs read upside down along it). Per-glyph rendering drops cross-glyph shaping — set pathSplit to word for scripts that need it.

Prefer smooth curves. Like SVG <textPath>, a sharp corner crowds glyphs on the inside of the turn — each glyph orients to the chord across its advance, which softens the bend but cannot space glyphs evenly past a hard vertex. pathAlign 'smooth' leans glyphs to the outside of each turn.

Pass a live Curve node to animate the curve itself — the text re-samples it every frame:

Examples

textWrap​

readonly public textWrap: SimpleSignalTextWrapTxt
Inherited from Shape.textWrap

top​

readonly public top: LayoutPositionSignalTxt

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

topLeft​

readonly public topLeft: LayoutPositionSignalTxt

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

topRight​

readonly public topRight: LayoutPositionSignalTxt

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

translate​

readonly public translate: Vector2SignalTxt

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

Inherited from Shape.translate

verticalAlign​

readonly public verticalAlign: SimpleSignalVerticalAlignTxt
Inherited from Shape.verticalAlign

wordBreak​

readonly public wordBreak: SimpleSignalWordBreakTxt
Inherited from Shape.wordBreak

wrap​

readonly public wrap: SimpleSignalFlexWrapTxt
Inherited from Shape.wrap

wrapMode​

readonly public wrapMode: SimpleSignalTxtWrapModeTxt

Line-breaking algorithm.

  • 'greedy' (default) — first-fit, one line at a time. Fast.
  • 'knuth-plass' — dynamic-programming search for an optimal break sequence that minimizes a badness score (justification ratio, rivers, tight lines, soft-hyphen breaks). Each line is scored against the free segment its own exclusions bands leave.

Named wrapMode rather than wrap to avoid clashing with the wrap: FlexWrap flex signal inherited from Layout.

Examples

yogaNode​

public yogaNode: Node
Inherited from Shape.yogaNode

zIndex​

readonly public zIndex: SimpleSignalnumberTxt
Inherited from Shape.zIndex

Accessors​

columnGap​

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

height​

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

rowGap​

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

width​

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

x​

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

y​

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

Methods​

[iterator]​

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

absoluteOpacity​

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

anchorPosition​

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

balancedWidth​

public balancedWidthtargetLineCount?: number: number

Binary search for a balanced text width where lines are roughly equal.

Examples

Parameters

  • targetLineCount?: number

    Optional target line count. If not provided, uses the natural (single-line) layout count.

cacheBBox​

public cacheBBox(): BBox

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

Inherited from Shape.cacheBBox

canLayoutChildren​

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

Overwrites Shape.canLayoutChildren

canvasFont​

public override canvasFont(): string
Overwrites Shape.canvasFont

cardinalPoint​

public cardinalPointorigin: OriginDirection: LayoutPositionSignalTxt

Get the cardinal point corresponding to the given origin.

Parameters

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

childrenAs​

public childrenAs(): T[]

Get the children array cast to the specified type.

Inherited from Shape.childrenAs

clone​

public clonecustomProps: NodeState = {}: this

Create a copy of this node.

Parameters

Inherited from Shape.clone

compositeToLocal​

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

computedPosition​

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

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 Shape.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 Shape.editLayout

effectiveFontSize​

public effectiveFontSize(): number

Effective font size used for rendering this text block.

Equals fontSize unless autoSize is enabled with concrete width and height — in which case it is fitFontSize.

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 Shape.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 Shape.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 Shape.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 Shape.findLast

fitFontSize​

public fitFontSizemaxWidth: numbermaxHeight: number: number

Largest whole-pixel font size at or below fontSize whose layout fits the given box, or 1 when nothing fits.

Reads each leaf at its raw (unscaled) size, so this method is safe to call from inside effectiveFontSize without creating a dependency cycle. The size returned is always one a real layout accepted, so the answer depends only on the current state.

Examples

Parameters

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 Shape.freezeLayout

getOriginDelta​

public getOriginDeltaorigin: Origin: Vector2

Parameters

Inherited from Shape.getOriginDelta

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

hit​

public hitposition: Vector2: Nodenull

Try to find a node intersecting the given position.

Parameters

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

isLayoutRoot​

public isLayoutRoot(): boolean
Inherited from Shape.isLayoutRoot

layoutEnabled​

public override layoutEnabled(): boolean

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

Overwrites Shape.layoutEnabled

lineCount​

public lineCount(): number

Get the number of lines in the current text layout.

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

parentAs​

public parentAs(): Tnull

Get the parent cast to the specified type.

Inherited from Shape.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 Shape.parentToWorld

pathArcLength​

public pathArcLength(): number

Arc length of the resolved textPath in this node's local pixels, or 0 when no path is set.

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

releaseLayout​

public releaseLayout(): void

Decrement the layout lock counter.

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

removeChildren​

public removeChildren(): this

Remove all children of this node.

Inherited from Shape.removeChildren

render​

public rendercontext: CanvasRenderingContext2D: void

Render this node onto the given canvas.

Parameters

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

resolvedLineHeight​

public override resolvedLineHeight(): number
Overwrites Shape.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 Shape.restore

ripple​

public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany

Parameters

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

shrinkWrapWidth​

public shrinkWrapWidth(): number

Find the tightest container width that still fits all the text.

Examples

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

split​

public splitgranularity: SegmentGranularity = 'grapheme': Txt[]

Explode this text into one standalone Txt per unit, each positioned to reproduce the source render exactly so the pieces can be animated independently.

Each piece is a center-anchored Txt in this node's local space carrying its run's font and paint. Mount them under a node that shares this node's transform, then hide the source:

const pieces = label().split('word');
view.add(
  <Node
    position={label().position()}
    rotation={label().rotation()}
    scale={label().scale()}
  >
    {pieces}
  </Node>,
);
label().opacity(0);

Returns an empty array in headless environments without a 2D canvas (e.g. jsdom). Caveats: grapheme splitting breaks ligature shaping; 'sentence' on justified lines is sub-pixel-approximate; per-node filters, shadow*, and cache on the source are not transferred.

Parameters

  • granularity: SegmentGranularity = 'grapheme'

    'grapheme' (default), 'word', or 'sentence'.

textGlyphs​

public textGlyphs(): TextUnit[]

Grapheme-level layout info. One entry per Unicode grapheme cluster, with its center position and width.

Operates at the grapheme level (via Intl.Segmenter), not at the rendered-glyph level — rendered ligatures (e.g. fi shaped as one glyph) still produce two entries.

textLines​

public textLines(): TextLayoutResult

Get the computed lines of the text layout.

Useful for querying word positions, line counts, and other layout data.

textSentences​

public textSentences(): TextUnit[]

Sentence-level layout info. One entry per sentence span, in reading order.

textWords​

public textWords(): TextUnit[]

Word-level layout info. Each entry is one word with its center position (Txt-local), width, and line index. Whitespace runs are skipped.

textGlyphs and textSentences mirror this at grapheme and sentence granularity.

Examples

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 Shape.thawLayout

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.

Inherited from Shape.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 Shape.transitionTo

view​

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

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.