# Class: Text

## Hierarchy

- [`Component`](Component)

  ↳ **`Text`**

## Table of contents

### Constructors

- constructor

### Events

- onAdd
- onRelease
- onRemove
- onTick
- onUpdate

### Properties

- priority
- schema
- EVENTS
- FillRenderData
- QueryGlyphs
- Typesetting

### Accessors

- el
- id
- scene
- version

### Methods

- getData
- setData
- setDataOne

## Constructors

### constructor

• **new Text**()

#### Inherited from

[Component](Component).[constructor](Component#constructor)

## Events

### onAdd

▸ **onAdd**(`parent`, `data`): `void`

所挂载的`element`被挂载到场景时触发的回调。

#### Parameters

| Name | Type |
| :------ | :------ |
| `parent` | [`Element`](Element) |
| `data` | [`ITextData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITextData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onAdd](Component#onAdd)

___

### onRelease

▸ **onRelease**(`data`): `void`

从被挂载的`element`上被移除，或是`element`被销毁时，触发的回调。
一般用于释放持有的资源。

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | [`ITextData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITextData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onRelease](Component#onRelease)

___

### onRemove

▸ **onRemove**(`parent`, `data`): `void`

所挂载的`element`从父节点`parent`被移除时，或者自己从`element`上被移除时，触发的回调。
一般用于消除功能的运作。
**如果一个组件的元素直接被销毁了，那这个组件就不会经历onRemove而是直接进入onRelease。**

#### Parameters

| Name | Type |
| :------ | :------ |
| `parent` | [`Element`](Element) |
| `data` | [`ITextData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITextData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onRemove](Component#onRemove)

___

### onTick

▸ **onTick**(`deltaTime`, `data`): `void`

渲染每帧触发的回调。

#### Parameters

| Name | Type |
| :------ | :------ |
| `deltaTime` | `number` |
| `data` | [`ITextData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITextData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onTick](Component#onTick)

___

### onUpdate

▸ **onUpdate**(`data`, `preData`): `void`

数据更新时触发的回调。

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | [`ITextData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITextData) |
| `preData` | [`ITextData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITextData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onUpdate](Component#onUpdate)

## Properties

### priority

• `Readonly` **priority**: `number` = `300`

自定义组件的更新优先级。

#### Overrides

[Component](Component).[priority](Component#priority)

___

### schema

• `Readonly` **schema**: [`IComponentSchema`](/miniprogram/dev/reference/xr-frame/api/interfaces/IComponentSchema)

自定义组件的`schema`。

#### Overrides

[Component](Component).[schema](Component#schema)

___

### EVENTS

▪ `Static` **EVENTS**: `string`[] = `[]`

#### Inherited from

[Component](Component).[EVENTS](Component#EVENTS)

___

### FillRenderData

▪ `Static` **FillRenderData**: (`vertexF32`: `Float32Array`, `indexU16`: `Uint16Array`, `batchArray`: `ICharacterData`[]) => `void`

#### Type declaration

▸ (`vertexF32`, `indexU16`, `batchArray`): `void`

##### Parameters

| Name | Type |
| :------ | :------ |
| `vertexF32` | `Float32Array` |
| `indexU16` | `Uint16Array` |
| `batchArray` | `ICharacterData`[] |

##### Returns

`void`

___

### QueryGlyphs

▪ `Static` **QueryGlyphs**: (`scene`: [`Scene`](Scene), `characters`: `string`, `italic`: `boolean`, `bold`: `boolean`, `fontSize`: `number`, `fontFamily`: `string`) => `IGlyph`[]

#### Type declaration

▸ (`scene`, `characters`, `italic`, `bold`, `fontSize`, `fontFamily`): `IGlyph`[]

多字客户端纹理请求接口

##### Parameters

| Name | Type |
| :------ | :------ |
| `scene` | [`Scene`](Scene) |
| `characters` | `string` |
| `italic` | `boolean` |
| `bold` | `boolean` |
| `fontSize` | `number` |
| `fontFamily` | `string` |

##### Returns

`IGlyph`[]

___

### Typesetting

▪ `Static` **Typesetting**: (`glyphs`: `IGlyph`[], `batchArrays`: `ICharacterData`[][], `batchIndexs`: `number`[], `wrapWidth`: `number`, `wrapHeight`: `number`, `lineHeight`: `number`, `anchor`: `number`[], `padding`: `number`[], `vertAlign`: `EVertAlignment`, `horzAlign`: `EHorzAlignment`) => `void`

#### Type declaration

▸ (`glyphs`, `batchArrays`, `batchIndexs`, `wrapWidth`, `wrapHeight`, `lineHeight`, `anchor`, `padding`, `vertAlign`, `horzAlign`): `void`

##### Parameters

| Name | Type |
| :------ | :------ |
| `glyphs` | `IGlyph`[] |
| `batchArrays` | `ICharacterData`[][] |
| `batchIndexs` | `number`[] |
| `wrapWidth` | `number` |
| `wrapHeight` | `number` |
| `lineHeight` | `number` |
| `anchor` | `number`[] |
| `padding` | `number`[] |
| `vertAlign` | `EVertAlignment` |
| `horzAlign` | `EHorzAlignment` |

##### Returns

`void`

## Accessors

### el

• `get` **el**(): [`Element`](Element)

挂载的元素。

#### Returns

[`Element`](Element)

___

### id

• `get` **id**(): `number`

#### Returns

`number`

___

### scene

• `get` **scene**(): [`Scene`](Scene)

当前场景。

#### Returns

[`Scene`](Scene)

___

### version

• `get` **version**(): `number`

当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。

#### Returns

`number`

## Methods

### getData

▸ **getData**(`key`): [`ITextData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITextData)[`T`]

获取一个当前值。

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends keyof [`ITextData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITextData) |

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `T` |

#### Returns

[`ITextData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITextData)[`T`]

#### Inherited from

[Component](Component).[getData](Component#getData)

___

### setData

▸ **setData**(`data`): `void`

不通过`xml`而是直接设置`data`，注意值的类型需要和`schema`中一致。

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | `Partial` |

#### Returns

`void`

#### Inherited from

[Component](Component).[setData](Component#setData)

___

### setDataOne

▸ **setDataOne**(`key`, `value`): `void`

设置一个数据。

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends keyof [`ITextData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITextData) |

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `T` |
| `value` | [`ITextData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITextData)[`T`] |

#### Returns

`void`

#### Inherited from

[Component](Component).[setDataOne](Component#setDataOne)