Class LayoutGroupComponentElement

The LayoutGroupComponentElement interface provides properties and methods for manipulating <pc-layoutgroup> elements. The LayoutGroupComponentElement interface also inherits the properties and methods of the HTMLElement interface.

Hierarchy (View Summary)

ComponentElement
- LayoutGroupComponentElement

Index

Accessors

alignment closestApp closestEntity component enabled heightFitting orientation padding reverseX reverseY spacing widthFitting wrap

Methods

_onReady ready

Accessors

alignment

get alignment(): Vec2
Gets the alignment of the child elements.

Returns Vec2
The alignment.
- Defined in src/components/layoutgroup-component.ts:145
set alignment(value: Vec2): void
Sets the horizontal and vertical alignment of the child elements (each component 0 to 1).
Parameters
- value: Vec2
  The alignment.
Returns void
- Defined in src/components/layoutgroup-component.ts:134

closestApp

get closestApp(): AppElement | null
The nearest ancestor <pc-app> element, or null if this element has no <pc-app> ancestor. The search starts at the parent, so an element never resolves to itself.

Returns AppElement | null
The closest app element, or null.
Inherited from ComponentElement.closestApp
- Defined in src/async-element.ts:28

closestEntity

get closestEntity(): EntityElement | null
The nearest ancestor <pc-entity> element, or null if this element has no <pc-entity> ancestor. The search starts at the parent, so an element never resolves to itself.

Returns EntityElement | null
The closest entity element, or null.
Inherited from ComponentElement.closestEntity
- Defined in src/async-element.ts:37

component

get component(): LayoutGroupComponent
Gets the underlying PlayCanvas layout group component.

Returns LayoutGroupComponent
The layout group component.
Overrides ComponentElement.component
- Defined in src/components/layoutgroup-component.ts:68

enabled

get enabled(): boolean
Gets the enabled state of the component.

Returns boolean
The enabled state of the component.
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:100
set enabled(value: boolean): void
Sets the enabled state of the component.
Parameters
- value: boolean
  The enabled state of the component.
Returns void
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:89

heightFitting

get heightFitting(): "none" | "stretch" | "shrink" | "both"
Gets the fitting mode along the vertical axis.

Returns "none" | "stretch" | "shrink" | "both"
The height fitting mode.
- Defined in src/components/layoutgroup-component.ts:223
set heightFitting(value: "none" | "stretch" | "shrink" | "both"): void
Sets the fitting mode along the vertical axis. Can be none, stretch, shrink or both. Defaults to none.
Parameters
- value: "none" | "stretch" | "shrink" | "both"
  The height fitting mode.
Returns void
- Defined in src/components/layoutgroup-component.ts:212

orientation

get orientation(): "horizontal" | "vertical"
Gets the orientation of the layout group.

Returns "horizontal" | "vertical"
The orientation.
- Defined in src/components/layoutgroup-component.ts:88
set orientation(value: "horizontal" | "vertical"): void
Sets the orientation of the layout group. Can be horizontal or vertical. Defaults to horizontal.
Parameters
- value: "horizontal" | "vertical"
  The orientation.
Returns void
- Defined in src/components/layoutgroup-component.ts:77

padding

get padding(): Vec4
Gets the padding around the layout group.

Returns Vec4
The padding.
- Defined in src/components/layoutgroup-component.ts:164
set padding(value: Vec4): void
Sets the padding around the layout group, as a Vec4 (left, bottom, right, top).
Parameters
- value: Vec4
  The padding.
Returns void
- Defined in src/components/layoutgroup-component.ts:153

reverseX

get reverseX(): boolean
Gets whether the order of children is reversed along the horizontal axis.

Returns boolean
Whether the horizontal order is reversed.
- Defined in src/components/layoutgroup-component.ts:107
set reverseX(value: boolean): void
Sets whether the order of children is reversed along the horizontal axis.
Parameters
- value: boolean
  Whether to reverse the horizontal order.
Returns void
- Defined in src/components/layoutgroup-component.ts:96

reverseY

get reverseY(): boolean
Gets whether the order of children is reversed along the vertical axis.

Returns boolean
Whether the vertical order is reversed.
- Defined in src/components/layoutgroup-component.ts:126
set reverseY(value: boolean): void
Sets whether the order of children is reversed along the vertical axis.
Parameters
- value: boolean
  Whether to reverse the vertical order.
Returns void
- Defined in src/components/layoutgroup-component.ts:115

spacing

get spacing(): Vec2
Gets the spacing between child elements.

Returns Vec2
The spacing.
- Defined in src/components/layoutgroup-component.ts:183
set spacing(value: Vec2): void
Sets the spacing between child elements, as a Vec2 (x, y).
Parameters
- value: Vec2
  The spacing.
Returns void
- Defined in src/components/layoutgroup-component.ts:172

widthFitting

get widthFitting(): "none" | "stretch" | "shrink" | "both"
Gets the fitting mode along the horizontal axis.

Returns "none" | "stretch" | "shrink" | "both"
The width fitting mode.
- Defined in src/components/layoutgroup-component.ts:203
set widthFitting(value: "none" | "stretch" | "shrink" | "both"): void
Sets the fitting mode along the horizontal axis. Can be none, stretch, shrink or both. Defaults to none.
Parameters
- value: "none" | "stretch" | "shrink" | "both"
  The width fitting mode.
Returns void
- Defined in src/components/layoutgroup-component.ts:192

wrap

get wrap(): boolean
Gets whether children wrap onto a new line/column when they overflow the group.

Returns boolean
Whether children wrap.
- Defined in src/components/layoutgroup-component.ts:242
set wrap(value: boolean): void
Sets whether children wrap onto a new line/column when they overflow the group.
Parameters
- value: boolean
  Whether to wrap children.
Returns void
- Defined in src/components/layoutgroup-component.ts:231

Methods

`Protected`_onReady

_onReady(): void
Called when the element is fully initialized and ready. Subclasses should call this when they're ready. Resolves the ready promise and dispatches a bubbling, composed ready event.

Returns void
Inherited from ComponentElement._onReady
- Defined in src/async-element.ts:46

ready

ready(): Promise<LayoutGroupComponentElement>
Returns a promise that resolves with this element when it's ready. This is the low-level primitive underlying whenReady, which is the recommended way to wait for elements.

Returns Promise<LayoutGroupComponentElement>
A promise that resolves with this element when it's ready.
Inherited from ComponentElement.ready
- Defined in src/async-element.ts:56

Class LayoutGroupComponentElement

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

alignment

Returns Vec2

Parameters

Returns void

closestApp

Returns AppElement | null

closestEntity

Returns EntityElement | null

component

Returns LayoutGroupComponent

enabled

Returns boolean

Parameters

Returns void

heightFitting

Returns "none" | "stretch" | "shrink" | "both"

Parameters

Returns void

orientation

Returns "horizontal" | "vertical"

Parameters

Returns void

padding

Returns Vec4

Parameters

Returns void

reverseX

Returns boolean

Parameters

Returns void

reverseY

Returns boolean

Parameters

Returns void

spacing

Returns Vec2

Parameters

Returns void

widthFitting

Returns "none" | "stretch" | "shrink" | "both"

Parameters

Returns void

wrap

Returns boolean

Parameters

Returns void

Methods

Protected_onReady

Returns void

ready

Returns Promise<LayoutGroupComponentElement>

Settings

On This Page

`Protected`_onReady