Render2DText
Defined in: client/api.d.ts:520
Native retained text region.
Extends
Section titled “Extends”Methods
Section titled “Methods”bringToFront()
Section titled “bringToFront()”bringToFront():
boolean
Defined in: client/api.d.ts:484
Moves this node to the front of its siblings.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy():
boolean
Defined in: client/api.d.ts:494
Destroys this node and all descendants.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”moveBefore()
Section titled “moveBefore()”moveBefore(
sibling):boolean
Defined in: client/api.d.ts:479
Moves this node before a sibling.
Parameters
Section titled “Parameters”sibling
Section titled “sibling”Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”sendToBack()
Section titled “sendToBack()”sendToBack():
boolean
Defined in: client/api.d.ts:489
Moves this node behind its siblings.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”setClipRect()
Section titled “setClipRect()”setClipRect(
left,top,right,bottom):boolean
Defined in: client/api.d.ts:469
Sets the normalized clipping rectangle.
Parameters
Section titled “Parameters”number
number
number
bottom
Section titled “bottom”number
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”setParent()
Section titled “setParent()”setParent(
parent):boolean
Defined in: client/api.d.ts:474
Moves this node under a container or the canvas root.
Parameters
Section titled “Parameters”parent
Section titled “parent”Render2DContainer | null
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”canvasId
Section titled “canvasId”
readonlycanvasId:number
Defined in: client/api.d.ts:409
Owning canvas identifier.
Inherited from
Section titled “Inherited from”clipping
Section titled “clipping”clipping:
boolean
Defined in: client/api.d.ts:444
Node clipping state.
Inherited from
Section titled “Inherited from”clipRect
Section titled “clipRect”
readonlyclipRect:Render2DRect
Defined in: client/api.d.ts:464
Current normalized clipping rectangle.
Inherited from
Section titled “Inherited from”color:
Color
Defined in: client/api.d.ts:529
Normalized RGBA text color.
destroyed
Section titled “destroyed”
readonlydestroyed:boolean
Defined in: client/api.d.ts:424
Whether this handle is no longer valid.
Inherited from
Section titled “Inherited from”font:
string
Defined in: client/api.d.ts:534
Native font hash name.
fontHeight
Section titled “fontHeight”fontHeight:
number
Defined in: client/api.d.ts:539
Normalized font height.
fontScale
Section titled “fontScale”fontScale:
number
Defined in: client/api.d.ts:544
Font scale multiplier.
horizontalAlign
Section titled “horizontalAlign”horizontalAlign:
"left"|"center"|"right"
Defined in: client/api.d.ts:564
Horizontal alignment.
readonlyid:number
Defined in: client/api.d.ts:404
Opaque node identifier.
Inherited from
Section titled “Inherited from”kerning
Section titled “kerning”kerning:
boolean
Defined in: client/api.d.ts:559
Whether kerning is enabled.
nonOverlapGroup
Section titled “nonOverlapGroup”nonOverlapGroup:
number
Defined in: client/api.d.ts:459
Native non-overlap group.
Inherited from
Section titled “Inherited from”offset
Section titled “offset”offset:
Vector2
Defined in: client/api.d.ts:549
Text cursor offset.
parentId
Section titled “parentId”
readonlyparentId:number
Defined in: client/api.d.ts:414
Parent node identifier, or zero for the canvas root.
Inherited from
Section titled “Inherited from”pixelClipping
Section titled “pixelClipping”pixelClipping:
boolean
Defined in: client/api.d.ts:449
Pixel clipping state.
Inherited from
Section titled “Inherited from”position
Section titled “position”position:
Vector2
Defined in: client/api.d.ts:434
Normalized position local to the parent.
Inherited from
Section titled “Inherited from”size:
Vector2
Defined in: client/api.d.ts:439
Normalized node size.
Inherited from
Section titled “Inherited from”text:
string
Defined in: client/api.d.ts:524
Displayed text.
readonlytype:"text"|"container"|"rectangle"|"texture"
Defined in: client/api.d.ts:419
Native node type.
Inherited from
Section titled “Inherited from”useAllMonitors
Section titled “useAllMonitors”useAllMonitors:
boolean
Defined in: client/api.d.ts:454
Whether the node spans all monitors.
Inherited from
Section titled “Inherited from”verticalAlign
Section titled “verticalAlign”verticalAlign:
"center"|"top"|"bottom"
Defined in: client/api.d.ts:569
Vertical alignment.
visible
Section titled “visible”visible:
boolean
Defined in: client/api.d.ts:429
Node visibility.
Inherited from
Section titled “Inherited from”widthLimit
Section titled “widthLimit”widthLimit:
number|null
Defined in: client/api.d.ts:554
Normalized width limit, or null when disabled.