Type Alias ElementComponent

ElementComponent: {
    alignment: number[];
    anchor: number[];
    autoFitHeight: boolean;
    autoFitWidth: boolean;
    autoHeight: boolean;
    autoWidth: boolean;
    batchGroupId: number;
    color: number[];
    enabled: boolean;
    enableMarkup: boolean;
    fontAsset: number;
    fontSize: number;
    height: number;
    key: string;
    layers: number[];
    lineHeight: number;
    margin: number[];
    mask: boolean;
    materialAsset: number;
    maxFontSize: number;
    maxLines: number;
    minFontSize: number;
    opacity: number;
    outlineColor: number[];
    outlineThickness: number;
    pivot: number[];
    pixelsPerUnit: number;
    rect: number[];
    shadowColor: number[];
    shadowOffset: number[];
    spacing: number;
    spriteAsset: number;
    spriteFrame: number;
    text: string;
    textureAsset: number;
    type: string;
    useInput: boolean;
    width: number;
    wrapLines: boolean;
}

Element Component Properties.

Type declaration

alignment: number[]
An array of 2 numbers controlling the horizontal and vertical alignment of the text relative to its element transform.
Default
```
[0.5,0.5]
```
anchor: number[]
An array of 4 numbers controlling the left, bottom, right and top anchors of the element.
Default
```
[0.5,0.5,0.5,0.5]
```
autoFitHeight: boolean
If true then the font size of the element will scale automatically so that it fits the element's height.
Default
```
false
```
autoFitWidth: boolean
If true then the font size and the line height of the element will scale automatically so that it fits the element's width.
Default
```
false
```
autoHeight: boolean
Make the height of the element match the height of the text content automatically.
Default
```
false
```
autoWidth: boolean
Make the width of the element match the width of the text content automatically.
Default
```
false
```
batchGroupId: number
The batch group id that this element belongs to.
Default
```
null
```
color: number[]
An array of 3 numbers controlling the color of the element.
Default
```
[1,1,1]
```
enabled: boolean
Whether the component is enabled.
Default
```
true
```
enableMarkup: boolean
Flag for enabling markup processing. Only works for text types.
Default
```
false
```
fontAsset: number
The id of the font asset used by the element.
Default
```
null
```
fontSize: number
The size of the font used by the element.
Default
```
32
```
height: number
The height of the element.
Default
```
32
```
key: string
The localization key of the element.
Default
```
null
```
layers: number[]
An array of layer id's that this element belongs to.
Default
```
[4]
```
lineHeight: number
The height of each line of text.
Default
```
32
```
margin: number[]
An array of 4 numbers controlling the spacing between each edge of the element and the respective anchor.
Default
```
[-16,-16,-16,-16]
```
mask: boolean
Switch image element into a mask.
Default
```
false
```
materialAsset: number
The id of the material asset used by this element.
Default
```
null
```
maxFontSize: number
The maximum size of the font that the element can scale to when using autoFitWidth or autoFitHeight.
Default
```
32
```
maxLines: number
The maximum number of lines that this element can display.
Default
```
null
```
minFontSize: number
The minimum size of the font that the element can scale to when using autoFitWidth or autoFitHeight.
Default
```
8
```
opacity: number
The opacity of the element.
Default
```
1
```
outlineColor: number[]
An array of 4 numbers controlling the text outline effect color and opacity.
Default
```
[0,0,0,1]
```
outlineThickness: number
The text outline effect width. Ranges from 0 to 1. To disable outline effect set to 0.
Default
```
0
```
pivot: number[]
An array of 2 numbers controlling the origin of the element.
Default
```
[0.5,0.5]
```
pixelsPerUnit: number
The number of pixels that correspond to one PlayCanvas unit.
Default
```
null
```
rect: number[]
An array of 4 numbers controlling the u, v, width and height of the rectangle that represents the portion of the texture that this image maps to.
Default
```
[0,0,1,1]
```
shadowColor: number[]
An array of 4 numbers controlling the text shadow cast effect color and opacity.
Default
```
[0,0,0,1]
```
shadowOffset: number[]
An array of 2 numbers controlling the horizontal and vertical shift of the text shadow cast effect.
Default
```
[0,0]
```
spacing: number
The spacing between each letter of the text.
Default
```
1
```
spriteAsset: number
The id of the sprite asset to be used by the element.
Default
```
null
```
spriteFrame: number
The frame from the sprite asset to render.
Default
```
0
```
text: string
The text content of the element.
Default
```
""
```
textureAsset: number
The id of the texture asset to be used by the element.
Default
```
null
```
type: string
The type of the element. Can be: pc.ELEMENTTYPE_GROUP, pc.ELEMENTTYPE_IMAGE, pc.ELEMENTTYPE_TEXT.
Default
```
"text"
```
useInput: boolean
Enable this if you want the element to receive input events.
Default
```
false
```
width: number
The width of the element.
Default
```
32
```
wrapLines: boolean
Whether to automatically wrap lines based on the element width.
Default
```
true
```

Type Alias ElementComponent

Type declaration

alignment: number[]

Default

anchor: number[]

Default

autoFitHeight: boolean

Default

autoFitWidth: boolean

Default

autoHeight: boolean

Default

autoWidth: boolean

Default

batchGroupId: number

Default

color: number[]

Default

enabled: boolean

Default

enableMarkup: boolean

Default

fontAsset: number

Default

fontSize: number

Default

height: number

Default

key: string

Default

layers: number[]

Default

lineHeight: number

Default

margin: number[]

Default

mask: boolean

Default

materialAsset: number

Default

maxFontSize: number

Default

maxLines: number

Default

minFontSize: number

Default

opacity: number

Default

outlineColor: number[]

Default

outlineThickness: number

Default

pivot: number[]

Default

pixelsPerUnit: number

Default

rect: number[]

Default

shadowColor: number[]

Default

shadowOffset: number[]

Default

spacing: number

Default

spriteAsset: number

Default

spriteFrame: number

Default

text: string

Default

textureAsset: number

Default

type: string

Default

useInput: boolean

Default

width: number

Default

wrapLines: boolean

Default