PanelNode
Defined in: ui/src/UIPanel.ts:77
Internal panel node used by both root UIPanel (Component) and nested child panels. Manages a Yoga container node, a PixiJS Container, optional background, and an ordered list of UIElement children.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PanelNode(
opts):PanelNode
Defined in: ui/src/UIPanel.ts:100
Parameters
Section titled “Parameters”Returns
Section titled “Returns”PanelNode
Properties
Section titled “Properties”container
Section titled “container”
readonlycontainer:Container
Defined in: ui/src/UIPanel.ts:78
yogaNode
Section titled “yogaNode”
readonlyyogaNode:Node
Defined in: ui/src/UIPanel.ts:79
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”children
Section titled “children”Get Signature
Section titled “Get Signature”get children(): readonly
UIElement[]
Defined in: ui/src/UIPanel.ts:113
Returns
Section titled “Returns”readonly UIElement[]
Implementation of
Section titled “Implementation of”displayObject
Section titled “displayObject”Get Signature
Section titled “Get Signature”get displayObject():
Container
Defined in: ui/src/UIPanel.ts:81
Returns
Section titled “Returns”Container
Implementation of
Section titled “Implementation of”UIContainerElement.displayObject
visible
Section titled “visible”Get Signature
Section titled “Get Signature”get visible():
boolean
Defined in: ui/src/UIPanel.ts:188
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set visible(
v):void
Defined in: ui/src/UIPanel.ts:192
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”addElement()
Section titled “addElement()”addElement(
child):void
Defined in: ui/src/UIPanel.ts:117
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”applyLayout()
Section titled “applyLayout()”applyLayout():
void
Defined in: ui/src/UIPanel.ts:205
Recursively apply Yoga computed layout to PixiJS positions. Call this after yogaNode.calculateLayout() on the root.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”UIContainerElement.applyLayout
button()
Section titled “button()”button(
label,opts):UIButton
Defined in: ui/src/UIPanel.ts:164
Add a button element.
Parameters
Section titled “Parameters”string
Omit<UIButtonProps, "children">
Returns
Section titled “Returns”destroy()
Section titled “destroy()”destroy():
void
Defined in: ui/src/UIPanel.ts:321
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”insertElementBefore()
Section titled “insertElementBefore()”insertElementBefore(
child,before):void
Defined in: ui/src/UIPanel.ts:131
Parameters
Section titled “Parameters”before
Section titled “before”Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”UIContainerElement.insertElementBefore
panel()
Section titled “panel()”panel(
opts?):PanelNode
Defined in: ui/src/UIPanel.ts:171
Add a nested child panel.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”PanelNode
removeElement()
Section titled “removeElement()”removeElement(
child):void
Defined in: ui/src/UIPanel.ts:123
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”UIContainerElement.removeElement
scrollView()
Section titled “scrollView()”scrollView(
opts?):ScrollViewNode
Defined in: ui/src/UIPanel.ts:178
Add a nested scrollable viewport.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”text()
Section titled “text()”text(
content,style?):UIText
Defined in: ui/src/UIPanel.ts:155
Add a text element.
Parameters
Section titled “Parameters”content
Section titled “content”string
style?
Section titled “style?”Partial<TextStyleOptions>
Returns
Section titled “Returns”update()
Section titled “update()”update(
props):void
Defined in: ui/src/UIPanel.ts:233
Parameters
Section titled “Parameters”Partial<PanelProps>
Returns
Section titled “Returns”void