Class ElementComponentElement

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

Hierarchy (View Summary)

ComponentElement
- ElementComponentElement

Index

Accessors

anchor asset autoWidth color component enabled fontSize lineHeight pivot text type width wrapLines

Methods

_onReady ready

Accessors

anchor

get anchor(): Vec4
Gets the anchor of the element component.

Returns Vec4
The anchor.
- Defined in src/components/element-component.ts:86
set anchor(value: Vec4): void
Sets the anchor of the element component.
Parameters
- value: Vec4
  The anchor.
Returns void
- Defined in src/components/element-component.ts:75

asset

get asset(): string
Gets the id of the pc-asset to use for the font.

Returns string
The asset ID.
- Defined in src/components/element-component.ts:106
set asset(value: string): void
Sets the id of the pc-asset to use for the font.
Parameters
- value: string
  The asset ID.
Returns void
- Defined in src/components/element-component.ts:94

autoWidth

get autoWidth(): boolean
Gets whether the element component should automatically adjust its width.

Returns boolean
Whether to automatically adjust the width.
- Defined in src/components/element-component.ts:125
set autoWidth(value: boolean): void
Sets whether the element component should automatically adjust its width.
Parameters
- value: boolean
  Whether to automatically adjust the width.
Returns void
- Defined in src/components/element-component.ts:114

color

get color(): Color
Gets the color of the element component.

Returns Color
The color.
- Defined in src/components/element-component.ts:144
set color(value: Color): void
Sets the color of the element component.
Parameters
- value: Color
  The color.
Returns void
- Defined in src/components/element-component.ts:133

component

get component(): null | ElementComponent
Gets the underlying PlayCanvas element component.

Returns null | ElementComponent
The element component.
Overrides ComponentElement.component
- Defined in src/components/element-component.ts:67

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:80
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:69

get fontSize(): number
Gets the font size of the element component.

Returns number
The font size.
- Defined in src/components/element-component.ts:163
set fontSize(value: number): void
Sets the font size of the element component.
Parameters
- value: number
  The font size.
Returns void
- Defined in src/components/element-component.ts:152

lineHeight

get lineHeight(): number
Gets the line height of the element component.

Returns number
The line height.
- Defined in src/components/element-component.ts:182
set lineHeight(value: number): void
Sets the line height of the element component.
Parameters
- value: number
  The line height.
Returns void
- Defined in src/components/element-component.ts:171

pivot

get pivot(): Vec2
Gets the pivot of the element component.

Returns Vec2
The pivot.
- Defined in src/components/element-component.ts:201
set pivot(value: Vec2): void
Sets the pivot of the element component.
Parameters
- value: Vec2
  The pivot.
Returns void
- Defined in src/components/element-component.ts:190

text

get text(): string
Gets the text of the element component.

Returns string
The text.
- Defined in src/components/element-component.ts:220
set text(value: string): void
Sets the text of the element component.
Parameters
- value: string
  The text.
Returns void
- Defined in src/components/element-component.ts:209

type

get type(): "text" | "image" | "group"
Gets the type of the element component.

Returns "text" | "image" | "group"
The type.
- Defined in src/components/element-component.ts:239
set type(value: "text" | "image" | "group"): void
Sets the type of the element component.
Parameters
- value: "text" | "image" | "group"
  The type.
Returns void
- Defined in src/components/element-component.ts:228

width

get width(): number
Gets the width of the element component.

Returns number
The width.
- Defined in src/components/element-component.ts:258
set width(value: number): void
Sets the width of the element component.
Parameters
- value: number
  The width.
Returns void
- Defined in src/components/element-component.ts:247

wrapLines

get wrapLines(): boolean
Gets whether the element component should wrap lines.

Returns boolean
Whether to wrap lines.
- Defined in src/components/element-component.ts:277
set wrapLines(value: boolean): void
Sets whether the element component should wrap lines.
Parameters
- value: boolean
  Whether to wrap lines.
Returns void
- Defined in src/components/element-component.ts:266

Methods

`Protected`_onReady

_onReady(): void
Called when the element is fully initialized and ready. Subclasses should call this when they're ready.

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

ready

ready(): Promise<ElementComponentElement>
Returns a promise that resolves with this element when it's ready.

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

Class ElementComponentElement

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

anchor

Returns Vec4

Parameters

Returns void

asset

Returns string

Parameters

Returns void

autoWidth

Returns boolean

Parameters

Returns void

color

Returns Color

Parameters

Returns void

component

Returns null | ElementComponent

enabled

Returns boolean

Parameters

Returns void

fontSize

Returns number

Parameters

Returns void

lineHeight

Returns number

Parameters

Returns void

pivot

Returns Vec2

Parameters

Returns void

text

Returns string

Parameters

Returns void

type

Returns "text" | "image" | "group"

Parameters

Returns void

width

Returns number

Parameters

Returns void

wrapLines

Returns boolean

Parameters

Returns void

Methods

Protected_onReady

Returns void

ready

Returns Promise<ElementComponentElement>

Settings

On This Page

`Protected`_onReady