class Txt extends Shape
Constructors
constructor
Parameters
{...}: TxtProps
Shape.constructorProperties
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.
Shape.absolutePositionabsoluteRotation
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.
Inherited fromShape.absoluteRotationabsoluteScale
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.
Shape.absoluteScalealignContent
readonly public alignContent: SimpleSignalFlexContentTxt
Shape.alignContentalignItems
readonly public alignItems: SimpleSignalFlexItemsTxt
Shape.alignItemsalignSelf
readonly public alignSelf: SimpleSignalFlexItemsTxt
Shape.alignSelfantialiased
readonly public antialiased: SimpleSignalbooleanTxt
Shape.antialiasedbasis
readonly public basis: SimpleSignalFlexBasisTxt
Shape.basisbottom
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.
Inherited fromShape.bottombottomLeft
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.
Inherited fromShape.bottomLeftbottomRight
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.
Inherited fromShape.bottomRightcache
readonly public cache: SimpleSignalbooleanTxt
Shape.cachecachePadding
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.
Shape.cachePaddingchildren
readonly public children: SignalComponentChildrenNode[]TxtSignalContextComponentChildrenNode[]Txt
Shape.childrenclip
readonly public clip: SimpleSignalbooleanTxt
Shape.clipcomposite
readonly public composite: SimpleSignalbooleanTxt
Shape.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationTxt
Shape.compositeOperationcreationStack
readonly public creationStack?: string
Shape.creationStackdirection
readonly public direction: SimpleSignalFlexDirectionTxt
Shape.directionelement
public element: HTMLElement
Shape.elementfill
readonly public fill: CanvasStyleSignalTxt
Shape.fillfilters
readonly public filters: FiltersSignalTxt
Shape.filtersfontFamily
readonly public fontFamily: SimpleSignalstringTxt
Shape.fontFamilyfontSize
readonly public fontSize: SimpleSignalnumberTxt
Shape.fontSizefontStyle
readonly public fontStyle: SimpleSignalstringTxt
Shape.fontStylefontWeight
readonly public fontWeight: SimpleSignalnumberTxt
Shape.fontWeightgap
readonly public gap: Vector2LengthSignalTxt
Shape.gapgrow
readonly public grow: SimpleSignalnumberTxt
Shape.growisClass
public isClass: boolean
Shape.isClassjustifyContent
readonly public justifyContent: SimpleSignalFlexContentTxt
Shape.justifyContentkey
readonly public key: string
Shape.keylayout
readonly public layout: SimpleSignalLayoutModeTxt
Shape.layoutleft
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.
Inherited fromShape.leftletterSpacing
readonly public letterSpacing: SimpleSignalnumberTxt
Shape.letterSpacinglineCap
readonly public lineCap: SimpleSignalCanvasLineCapTxt
Shape.lineCaplineDash
readonly public lineDash: SimpleSignalnumber[]Txt
Shape.lineDashlineDashOffset
readonly public lineDashOffset: SimpleSignalnumberTxt
Shape.lineDashOffsetlineHeight
readonly public lineHeight: SimpleSignalLengthTxt
Shape.lineHeightlineJoin
readonly public lineJoin: SimpleSignalCanvasLineJoinTxt
Shape.lineJoinlineWidth
readonly public lineWidth: SimpleSignalnumberTxt
Shape.lineWidthmargin
readonly public margin: SpacingSignalTxt
Shape.marginmaxHeight
readonly public maxHeight: SimpleSignalLengthLimitTxt
Shape.maxHeightmaxWidth
readonly public maxWidth: SimpleSignalLengthLimitTxt
Shape.maxWidthmiddle
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.
Inherited fromShape.middleminHeight
readonly public minHeight: SimpleSignalLengthLimitTxt
Shape.minHeightminWidth
readonly public minWidth: SimpleSignalLengthLimitTxt
Shape.minWidthoffset
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
Shape.offsetopacity
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 fromShape.opacitypadding
readonly public padding: SpacingSignalTxt
Shape.paddingparent
readonly public parent: SimpleSignalnullNodevoid = ...
Shape.parentposition
readonly public position: Vector2SignalTxt
Represents the position of this node in local space of its parent.
Examples
Inherited fromShape.positionproperties
readonly public properties: RecordstringPropertyMetadataany = ...
Shape.propertiesratio
readonly public ratio: SimpleSignalnullnumberTxt
Shape.ratioright
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.
Inherited fromShape.rightrotation
readonly public rotation: SimpleSignalnumberTxt
Represents the rotation (in degrees) of this node relative to its parent.
Inherited fromShape.rotationscale
readonly public scale: Vector2SignalTxt
Represents the scale of this node in local space of its parent.
Examples
Inherited fromShape.scaleshaders
readonly public shaders: SignalPossibleShaderConfigShaderConfig[]TxtSignalContextPossibleShaderConfigShaderConfig[]Txt
Shape.shadersshadowBlur
readonly public shadowBlur: SimpleSignalnumberTxt
Shape.shadowBlurshadowColor
readonly public shadowColor: ColorSignalTxt
Shape.shadowColorshadowOffset
readonly public shadowOffset: Vector2SignalTxt
Shape.shadowOffsetshrink
readonly public shrink: SimpleSignalnumberTxt
Shape.shrinksize
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 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
Inherited fromShape.sizeskew
readonly public skew: Vector2SignalTxt
Represents the skew of this node in local space of its parent.
Examples
Inherited fromShape.skewstroke
readonly public stroke: CanvasStyleSignalTxt
Shape.strokestrokeFirst
readonly public strokeFirst: SimpleSignalbooleanTxt
Shape.strokeFirststyles
public styles: CSSStyleDeclaration
Shape.stylestext
readonly public text: SimpleSignalstringTxt
textAlign
readonly public textAlign: SimpleSignalCanvasTextAlignTxt
Shape.textAligntextDirection
readonly public textDirection: SimpleSignalCanvasDirectionTxt
Shape.textDirectiontextWrap
readonly public textWrap: SimpleSignalTextWrapTxt
Shape.textWraptop
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.
Inherited fromShape.toptopLeft
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.
Inherited fromShape.topLefttopRight
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.
Inherited fromShape.topRightwrap
readonly public wrap: SimpleSignalFlexWrapTxt
Shape.wrapzIndex
readonly public zIndex: SimpleSignalnumberTxt
Shape.zIndexAccessors
columnGap
public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Shape.columnGapheight
public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
Shape.heightrowGap
public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Shape.rowGapwidth
public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
Shape.widthx
public get x(): SimpleSignalnumberthis
Shape.xy
public get y(): SimpleSignalnumberthis
Shape.yMethods
[iterator]
public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidunknown
Shape.[iterator]absoluteOpacity
public absoluteOpacity(): number
Shape.absoluteOpacityadd
public addnode: ComponentChildren: Txt
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: ComponentChildrenA node or an array of nodes to append.
Shape.addanchorPosition
public anchorPosition(): Vector2
Shape.anchorPositionapplyState
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: NodeStateThe state to apply to the node.
Shape.applyStatecacheBBox
public cacheBBox(): BBox
Get a bounding box for the contents rendered by this node as well as its children.
Inherited fromShape.cacheBBoxcardinalPoint
public cardinalPointorigin: OriginDirection: SimpleVector2SignalTxt
Get the cardinal point corresponding to the given origin.
Parameters
Inherited fromShape.cardinalPointchildAs
Get the nth children cast to the specified type.
Type Parameters
Parameters
index: numberThe index of the child to retrieve.
Shape.childAschildrenAs
Get the children array cast to the specified type.
Type Parameters
Inherited fromShape.childrenAsclone
public clonecustomProps: NodeState = {}: Txt
Create a copy of this node.
Parameters
customProps: NodeState = {}Properties to override.
Shape.clonecompositeToLocal
public compositeToLocal(): DOMMatrix
Shape.compositeToLocalcompositeToWorld
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 fromShape.compositeToWorldcomputedPosition
public computedPosition(): Vector2
Shape.computedPositiondispose
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 fromShape.dispose