Render2DText
Defined in: client/api.d.ts:523
Native retained text region.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Render2DText():
Render2DText
Returns
Section titled “Returns”Render2DText
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”bringToFront()
Section titled “bringToFront()”bringToFront():
boolean
Defined in: client/api.d.ts:483
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:493
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:478
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:488
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:468
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:473
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:408
Owning canvas identifier.
Inherited from
Section titled “Inherited from”clipping
Section titled “clipping”clipping:
boolean
Defined in: client/api.d.ts:443
Node clipping state.
Inherited from
Section titled “Inherited from”clipRect
Section titled “clipRect”
readonlyclipRect:Render2DRect
Defined in: client/api.d.ts:463
Current normalized clipping rectangle.
Inherited from
Section titled “Inherited from”color:
Color
Defined in: client/api.d.ts:532
Normalized RGBA text color.
destroyed
Section titled “destroyed”
readonlydestroyed:boolean
Defined in: client/api.d.ts:423
Whether this handle is no longer valid.
Inherited from
Section titled “Inherited from”font:
string
Defined in: client/api.d.ts:537
Native font hash name.
fontHeight
Section titled “fontHeight”fontHeight:
number
Defined in: client/api.d.ts:547
Normalized font height.
fontScale
Section titled “fontScale”fontScale:
number
Defined in: client/api.d.ts:552
Font scale multiplier.
fontStyle
Section titled “fontStyle”fontStyle:
"bold"|"normal"|"italic"|"boldItalic"
Defined in: client/api.d.ts:542
Native font variant.
horizontalAlign
Section titled “horizontalAlign”horizontalAlign:
"left"|"center"|"right"
Defined in: client/api.d.ts:572
Horizontal alignment.
readonlyid:number
Defined in: client/api.d.ts:403
Opaque node identifier.
Inherited from
Section titled “Inherited from”kerning
Section titled “kerning”kerning:
boolean
Defined in: client/api.d.ts:567
Whether kerning is enabled.
nonOverlapGroup
Section titled “nonOverlapGroup”nonOverlapGroup:
number
Defined in: client/api.d.ts:458
Native non-overlap group.
Inherited from
Section titled “Inherited from”offset
Section titled “offset”offset:
Vector2
Defined in: client/api.d.ts:557
Text cursor offset.
parentId
Section titled “parentId”
readonlyparentId:number
Defined in: client/api.d.ts:413
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:448
Pixel clipping state.
Inherited from
Section titled “Inherited from”position
Section titled “position”position:
Vector2
Defined in: client/api.d.ts:433
Normalized position local to the parent.
Inherited from
Section titled “Inherited from”size:
Vector2
Defined in: client/api.d.ts:438
Normalized node size.
Inherited from
Section titled “Inherited from”text:
string
Defined in: client/api.d.ts:527
Displayed text.
readonlytype:"container"|"rectangle"|"text"|"texture"
Defined in: client/api.d.ts:418
Native node type.
Inherited from
Section titled “Inherited from”useAllMonitors
Section titled “useAllMonitors”useAllMonitors:
boolean
Defined in: client/api.d.ts:453
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:577
Vertical alignment.
visible
Section titled “visible”visible:
boolean
Defined in: client/api.d.ts:428
Node visibility.
Inherited from
Section titled “Inherited from”widthLimit
Section titled “widthLimit”widthLimit:
number|null
Defined in: client/api.d.ts:562
Normalized width limit, or null when disabled.