On this page

Label

Billboard text label.

Constructor

new Label(optionsopt)

Parameters:

Name Type Attributes Description

options

Object

<optional>

Label options:

Properties

Name	Type	Attributes	Description
`position`	Vec3 \| Array.<number>	<optional>	Billboard spatial position.
`rotation`	number	<optional>	Screen angle rotation.
`color`	Vec4 \| string \| Array.<number>	<optional>	Billboard color.
`alignedAxis`	Vec3 \| Array.<number>	<optional>	Billboard aligned vector.
`offset`	Vec3 \| Array.<number>	<optional>	Billboard center screen offset.
`visibility`	boolean	<optional>	Visibility.
`text`	string	<optional>	Text string.
`face`	string	<optional>	HTML5 font face.
`size`	number	<optional>	Font size in pixels.
`style`	string	<optional>	HTML5 font style. Example 'normal', 'italic'.
`weight`	string	<optional>	HTML5 font weight. Example 'normal', 'bold'.
`outline`	number	<optional>	Text outline size. 0 - no outline, 1 - maximum outline. Default 0.58.
`outlineColor`	Vec4 \| string \| Array.<number>	<optional>	Outline color.
`align`	string	<optional>	Text horizontal align: "left", "right" and "center".

Source: entity/Label.ts, line 37

Extends

BaseBillboard

Methods

assignFontAtlas(fontAtlas)

Assigns font atlas and update.

Parameters:

Name	Type	Description
`fontAtlas`	FontAtlas	Font atlas.

Source: entity/Label.ts, line 400

getAlign() → {string}

Gets label text current alignment.

Source: entity/Label.ts, line 219

Returns:

Type:: string

getAlignedAxis() → {Vec3}

Returns aligned vector.

Overrides: BaseBillboard#getAlignedAxis
Source: entity/BaseBillboard.ts, line 365

Returns:

Type:: Vec3

getColor() → {Vec4}

Returns RGBA color.

Overrides: BaseBillboard#getColor
Source: entity/BaseBillboard.ts, line 304

Returns:

Type:: Vec4

getFace() → {string}

Gets current font face.

Source: entity/Label.ts, line 238

Returns:

Type:: string

getLetterSpacing(spacing)

Returns label text letter spacing.

Parameters:

Name	Type	Description
`spacing`	number	Letter spacing.

Source: entity/Label.ts, line 175

getOffset() → {Vec3}

Returns billboard screen space offset size.

Overrides: BaseBillboard#getOffset
Source: entity/BaseBillboard.ts, line 214

Returns:

Type:: Vec3

getOutline() → {number}

Gets text current outline size.

Source: entity/Label.ts, line 286

Returns:

Type:: number

getOutlineColor() → {Vec4}

Gets outline color vector.

Source: entity/Label.ts, line 345

Returns:

Type:: Vec4

getOutlineOpacity() → {number}

Gets outline opacity value.

Source: entity/Label.ts, line 370

Returns:

Type:: number

getPosition() → {Vec3}

Returns billboard position.

Overrides: BaseBillboard#getPosition
Source: entity/BaseBillboard.ts, line 178

Returns:

Type:: Vec3

getRotation() → {number}

Gets screen space rotation.

Overrides: BaseBillboard#getRotation
Source: entity/BaseBillboard.ts, line 239

Returns:

Type:: number

getSize() → {number}

Gets label size in pixels.

Source: entity/Label.ts, line 263

Returns:

Type:: number

getText() → {string}

Gets current text string.

Source: entity/Label.ts, line 196

Returns:

Type:: string

getVisibility() → {boolean}

Returns billboard visibility.

Overrides: BaseBillboard#getVisibility
Source: entity/BaseBillboard.ts, line 329

Returns:

Type:: boolean

remove()

Removes billboard from handler.

Overrides: BaseBillboard#remove
Source: entity/BaseBillboard.ts, line 374

setAlign(align)

Sets label text align. Could be center, left or right. Left is default.

Parameters:

Name	Type	Description
`align`	string	Text align.

Source: entity/Label.ts, line 205

setAlignedAxis(x, y, z)

Sets billboard cartesian aligned vector.

Parameters:

Name	Type	Description
`x`	number	Aligned vector X coordinate.
`y`	number	Aligned vector Y coordinate.
`z`	number	Aligned vector Z coordinate.

Overrides: BaseBillboard#setAlignedAxis
Source: entity/BaseBillboard.ts, line 338

setAlignedAxis3v(alignedAxis)

Sets billboard aligned vector.

Parameters:

Name	Type	Description
`alignedAxis`	Vec3	Align direction.

Overrides: BaseBillboard#setAlignedAxis3v
Source: entity/BaseBillboard.ts, line 356

setColor(r, g, b, a)

Sets RGBA color. Each channel from 0.0 to 1.0.

Parameters:

Name	Type	Description
`r`	number	Red.
`g`	number	Green.
`b`	number	Blue.
`a`	number	Alpha.

Overrides: BaseBillboard#setColor
Source: entity/BaseBillboard.ts, line 264

setColor4v(color)

Sets RGBA color. Each channel from 0.0 to 1.0.

Parameters:

Name	Type	Description
`color`	Vec4	RGBA vector.

Overrides: BaseBillboard#setColor4v
Source: entity/BaseBillboard.ts, line 286

setColorHTML(color)

Sets billboard color.

Parameters:

Name	Type	Description
`color`	string	HTML style color.

Overrides: BaseBillboard#setColorHTML
Source: entity/BaseBillboard.ts, line 295

setFace(face)

Sets font face family.

Parameters:

Name	Type	Description
`face`	string	Font face family.

Source: entity/Label.ts, line 228

setLetterSpacing(spacing)

Set text letter spacing.

Parameters:

Name	Type	Description
`spacing`	number	Letter spacing.

Source: entity/Label.ts, line 163

setOffset(x, y, zopt)

Sets screen space offset.

Parameters:

Name	Type	Attributes	Description
`x`	number		X offset.
`y`	number		Y offset.
`z`	number	<optional>	Z offset.

Overrides: BaseBillboard#setOffset
Source: entity/BaseBillboard.ts, line 187

setOffset3v(offset)

Sets screen space offset.

Parameters:

Name	Type	Description
`offset`	Vec2	Offset size.

Overrides: BaseBillboard#setOffset3v
Source: entity/BaseBillboard.ts, line 205

setOpacity(a)

Sets label opacity.

Parameters:

Name	Type	Description
`a`	number	Label opacity.

Overrides: BaseBillboard#setOpacity
Source: entity/Label.ts, line 295

setOutline(outline)

Sets text outline border size. Where 0 - is no outline, and 1 - is the maximum outline size.

Parameters:

Name	Type	Description
`outline`	number	Text outline size.

Source: entity/Label.ts, line 272

setOutlineColor(r, g, b, a)

Sets text outline color.

Parameters:

Name	Type	Description
`r`	number	Red.
`g`	number	Green.
`b`	number	Blue.
`a`	number	Alpha.

Source: entity/Label.ts, line 305

setOutlineColor4v(rgba)

Sets text outline color.

Parameters:

Name	Type	Description
`rgba`	Vec4	Color vector.

Source: entity/Label.ts, line 327

setOutlineColorHTML(color)

Sets text outline color HTML string.

Parameters:

Name	Type	Description
`color`	string	HTML string color.

Source: entity/Label.ts, line 336

setOutlineOpacity(opacity)

Sets outline opacity. Actually outline color alpha value.

Parameters:

Name	Type	Description
`opacity`	number	Outline opacity.

Source: entity/Label.ts, line 354

setPickingColor3v(color)

Sets billboard picking color.

Parameters:

Name	Type	Description
`color`	Vec3	Picking color.

Overrides: BaseBillboard#setPickingColor3v
Source: entity/BaseBillboard.ts, line 383

setPosition(x, y, z)

Sets billboard position.

Parameters:

Name	Type	Description
`x`	number	X coordinate.
`y`	number	Y coordinate.
`z`	number	Z coordinate.

Overrides: BaseBillboard#setPosition
Source: entity/BaseBillboard.ts, line 142

setPosition3v(position)

Sets billboard position.

Parameters:

Name	Type	Description
`position`	Vec3	Cartesian coordinates.

Overrides: BaseBillboard#setPosition3v
Source: entity/BaseBillboard.ts, line 161

setRotation(rotation)

Sets billboard screen space rotation in radians.

Parameters:

Name	Type	Description
`rotation`	number	Screen space rotation in radians.

Overrides: BaseBillboard#setRotation
Source: entity/BaseBillboard.ts, line 223

setRtl(isRTL)

Change text direction.

Parameters:

Name	Type	Description
`isRTL`	boolean	Text string.

Source: entity/Label.ts, line 184

setSize(size)

Sets label font size in pixels.

Parameters:

Name	Type	Description
`size`	number	Label size in pixels.

Source: entity/Label.ts, line 247

setText(text)

Set label text.

Parameters:

Name	Type	Description
`text`	string	Text string. It can't be bigger than maximum labelHandler _maxLetters value.

Source: entity/Label.ts, line 150

setVisibility(visibility)

Sets billboard visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Visibility flag.

Overrides: BaseBillboard#setVisibility
Source: entity/BaseBillboard.ts, line 313

(async) update()

Updates label parameters.

Source: entity/Label.ts, line 379