Render2DNode
Defined in: client/api.d.ts:399
Base handle for one resource-owned native Render2D object.
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Render2DNode():
Render2DNode
Returns
Section titled “Returns”Render2DNode
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
destroy()
Section titled “destroy()”destroy():
boolean
Defined in: client/api.d.ts:493
Destroys this node and all descendants.
Returns
Section titled “Returns”boolean
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”Render2DNode
Returns
Section titled “Returns”boolean
sendToBack()
Section titled “sendToBack()”sendToBack():
boolean
Defined in: client/api.d.ts:488
Moves this node behind its siblings.
Returns
Section titled “Returns”boolean
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
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
Properties
Section titled “Properties”canvasId
Section titled “canvasId”
readonlycanvasId:number
Defined in: client/api.d.ts:408
Owning canvas identifier.
clipping
Section titled “clipping”clipping:
boolean
Defined in: client/api.d.ts:443
Node clipping state.
clipRect
Section titled “clipRect”
readonlyclipRect:Render2DRect
Defined in: client/api.d.ts:463
Current normalized clipping rectangle.
destroyed
Section titled “destroyed”
readonlydestroyed:boolean
Defined in: client/api.d.ts:423
Whether this handle is no longer valid.
readonlyid:number
Defined in: client/api.d.ts:403
Opaque node identifier.
nonOverlapGroup
Section titled “nonOverlapGroup”nonOverlapGroup:
number
Defined in: client/api.d.ts:458
Native non-overlap group.
parentId
Section titled “parentId”
readonlyparentId:number
Defined in: client/api.d.ts:413
Parent node identifier, or zero for the canvas root.
pixelClipping
Section titled “pixelClipping”pixelClipping:
boolean
Defined in: client/api.d.ts:448
Pixel clipping state.
position
Section titled “position”position:
Vector2
Defined in: client/api.d.ts:433
Normalized position local to the parent.
size:
Vector2
Defined in: client/api.d.ts:438
Normalized node size.
readonlytype:"container"|"rectangle"|"text"|"texture"
Defined in: client/api.d.ts:418
Native node type.
useAllMonitors
Section titled “useAllMonitors”useAllMonitors:
boolean
Defined in: client/api.d.ts:453
Whether the node spans all monitors.
visible
Section titled “visible”visible:
boolean
Defined in: client/api.d.ts:428
Node visibility.