Class: UIElement ​

WebSG.UIElement

Class representing a user interface element.

Implements the CSS Flexbox layout model. https://css-tricks.com/snippets/css/a-guide-to-flexbox/

Hierarchy ​

• UIElement

  ↳ UIText

Table of contents ​

Constructors ​

• constructor

Properties ​

• backgroundColor
• borderColor
• borderRadius
• borderWidth
• margin
• padding

Accessors ​

• alignContent
• alignItems
• alignSelf
• bottom
• flexBasis
• flexDirection
• flexGrow
• flexShrink
• flexWrap
• height
• justifyContent
• left
• maxHeight
• maxWidth
• minHeight
• minWidth
• parent
• position
• right
• top
• type
• width

Methods ​

• addChild
• children
• getChild
• removeChild

Constructors ​

constructor ​

• new UIElement()

Properties ​

backgroundColor ​

• Readonly backgroundColor: RGBA

Readonly RGBA object representing the background color of the UI element.

Defined in ​

websg.d.ts:1708

borderColor ​

• Readonly borderColor: RGBA

Readonly RGBA object representing the border color of the UI element.

Defined in ​

websg.d.ts:1713

borderRadius ​

• Readonly borderRadius: Vector4

Readonly Vector4 object representing the border radius of the UI element.

Defined in ​

websg.d.ts:1733

borderWidth ​

• Readonly borderWidth: Vector4

Readonly Vector4 object representing the border width of the UI element.

Defined in ​

websg.d.ts:1728

margin ​

• Readonly margin: Vector4

Readonly Vector4 object representing the margin of the UI element.

Defined in ​

websg.d.ts:1723

padding ​

• Readonly padding: Vector4

Readonly Vector4 object representing the padding of the UI element.

Defined in ​

websg.d.ts:1718

Accessors ​

alignContent ​

• get alignContent(): FlexAlign

Gets the align-content property of the UI element.

Returns ​

FlexAlign

Defined in ​

websg.d.ts:1510

• set alignContent(value): void

Sets the align-content property of the UI element.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1516

alignItems ​

• get alignItems(): FlexAlign

Gets the align-items property of the UI element.

Returns ​

FlexAlign

Defined in ​

websg.d.ts:1521

• set alignItems(value): void

Sets the align-items property of the UI element.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1527

alignSelf ​

• get alignSelf(): FlexAlign

Gets the align-self property of the UI element.

Returns ​

FlexAlign

Defined in ​

websg.d.ts:1532

• set alignSelf(value): void

Sets the align-self property of the UI element.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1538

bottom ​

• get bottom(): number

Gets the bottom position of the UI element in pixels.

Returns ​

number

Defined in ​

websg.d.ts:1488

• set bottom(value): void

Sets the bottom position of the UI element in pixels.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1494

flexBasis ​

• get flexBasis(): number

Gets the flex basis property of the UI element in pixels.

Returns ​

number

Defined in ​

websg.d.ts:1565

• set flexBasis(value): void

Sets the flex basis property of the UI element in pixels.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1571

flexDirection ​

• get flexDirection(): FlexDirection

Gets the flex-direction property of the UI element.

Returns ​

FlexDirection

Defined in ​

websg.d.ts:1543

• set flexDirection(value): void

Sets the flex-direction property of the UI element.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1549

flexGrow ​

• get flexGrow(): number

Gets the flex grow property of the UI element.

Returns ​

number

Defined in ​

websg.d.ts:1576

• set flexGrow(value): void

Sets the flex grow property of the UI element.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1582

flexShrink ​

• get flexShrink(): number

Gets the flex shrink property of the UI element.

Returns ​

number

Defined in ​

websg.d.ts:1587

• set flexShrink(value): void

Sets the flex shrink property of the UI element.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1593

flexWrap ​

• get flexWrap(): FlexWrap

Gets the flex wrap property of the UI element.

Returns ​

FlexWrap

Defined in ​

websg.d.ts:1554

• set flexWrap(value): void

Sets the flex wrap property of the UI element.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1560

height ​

• get height(): number

Gets the height of the UI element in pixels.

Returns ​

number

Defined in ​

websg.d.ts:1620

• set height(value): void

Sets the height of the UI element in pixels.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1626

justifyContent ​

• get justifyContent(): FlexJustify

Gets the justify content property of the UI element.

Returns ​

FlexJustify

Defined in ​

websg.d.ts:1598

• set justifyContent(value): void

Sets the justify content property of the UI element.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1604

left ​

• get left(): number

Gets the left position of the UI element in pixels.

Returns ​

number

Defined in ​

websg.d.ts:1499

• set left(value): void

Sets the left position of the UI element in pixels.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1505

maxHeight ​

• get maxHeight(): number

Gets the maximum height of the UI element in pixels.

Returns ​

number

Defined in ​

websg.d.ts:1664

• set maxHeight(value): void

Sets the maximum height of the UI element in pixels.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1670

maxWidth ​

• get maxWidth(): number

Gets the maximum width of the UI element.

Returns ​

number

Defined in ​

websg.d.ts:1653

• set maxWidth(value): void

Sets the maximum width of the UI element in pixels.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1659

minHeight ​

• get minHeight(): number

Gets the minimum height of the UI element in pixels.

Returns ​

number

Defined in ​

websg.d.ts:1642

• set minHeight(value): void

Sets the minimum height of the UI element.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1648

minWidth ​

• get minWidth(): number

Gets the minimum width of the UI element in pixels.

Returns ​

number

Defined in ​

websg.d.ts:1631

• set minWidth(value): void

Sets the minimum width of the UI element in pixels.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1637

parent ​

• get parent(): undefined | UIElement

Gets the parent UI element of the current element or undefined if the element has no parent.

Returns ​

undefined | UIElement

Defined in ​

websg.d.ts:1698

position ​

• get position(): ElementPositionType

Gets the position of the UI element.

Returns ​

ElementPositionType

Defined in ​

websg.d.ts:1455

• set position(value): void

Sets the position of the UI element.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1461

right ​

• get right(): number

Gets the right position of the UI element in pixels.

Returns ​

number

Defined in ​

websg.d.ts:1477

• set right(value): void

Sets the right position of the UI element in pixels.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1483

top ​

• get top(): number

Gets the top position of the UI element in pixels.

Returns ​

number

Defined in ​

websg.d.ts:1466

• set top(value): void

Sets the top position of the UI element in pixels.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1472

type ​

• get type(): ElementType

Gets the type of the UI element.

Returns ​

ElementType

Defined in ​

websg.d.ts:1703

width ​

• get width(): number

Gets the width of the UI element in pixels.

Returns ​

number

Defined in ​

websg.d.ts:1609

• set width(value): void

Sets the width of the UI element in pixels.

Parameters ​

Returns ​

void

Defined in ​

websg.d.ts:1615

Methods ​

addChild ​

▸ addChild(element): UIElement

Adds a child UI element to the current element.

Parameters ​

Returns ​

UIElement

Defined in ​

websg.d.ts:1676

children ​

▸ children(): UIElementIterator

Returns an iterator for the children of the current UI element.

Returns ​

UIElementIterator

Defined in ​

websg.d.ts:1693

getChild ​

▸ getChild(index): undefined | UIElement

Gets the child UI element at the specified index or undefined if the index is out of bounds.

Parameters ​

Returns ​

undefined | UIElement

Defined in ​

websg.d.ts:1688

removeChild ​

▸ removeChild(element): UIElement

Removes a child UI element from the current element.

Parameters ​

Returns ​

UIElement

Defined in ​

websg.d.ts:1682