class Layout extends Node
Extended by
Shape
Constructors
constructor
Parameters
props: LayoutProps
Node.constructorProperties
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.
Node.absolutePositionabsoluteRotation
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.
Inherited fromNode.absoluteRotationabsoluteScale
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.
Node.absoluteScalealignContent
readonly public alignContent: SimpleSignalFlexContentLayout
alignItems
readonly public alignItems: SimpleSignalFlexItemsLayout
alignSelf
readonly public alignSelf: SimpleSignalFlexItemsLayout
basis
readonly public basis: SimpleSignalFlexBasisLayout
bottom
readonly public bottom: SimpleVector2SignalLayout
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: SimpleVector2SignalLayout
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: SimpleVector2SignalLayout
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
Node.cachecachePadding
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.
Node.cachePaddingchildren
readonly public children: SignalComponentChildrenNode[]LayoutSignalContextComponentChildrenNode[]Layout
Node.childrenclip
readonly public clip: SimpleSignalbooleanLayout
composite
readonly public composite: SimpleSignalbooleanLayout
Node.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationLayout
Node.compositeOperationcreationStack
readonly public creationStack?: string
Node.creationStackdirection
readonly public direction: SimpleSignalFlexDirectionLayout
element
public element: HTMLElement
filters
readonly public filters: FiltersSignalLayout
Node.filtersfontFamily
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
Node.isClassjustifyContent
readonly public justifyContent: SimpleSignalFlexContentLayout
key
readonly public key: string
Node.keylayout
readonly public layout: SimpleSignalLayoutModeLayout
left
readonly public left: SimpleVector2SignalLayout
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: SimpleVector2SignalLayout
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: SimpleSignalLengthLimitLayout
minWidth
readonly public minWidth: SimpleSignalLengthLimitLayout
offset
readonly public offset: 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 offsets:
[-1, -1]- top left corner[1, -1]- top right corner[0, 1]- bottom edge[-1, 1]- bottom left corner
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 fromNode.opacitypadding
readonly public padding: SpacingSignalLayout