Class TextObject

Hierarchy (View Summary)

SceneObject
- TextObject

Implements

TextLike

Index

Constructors

Properties

[OBJECT_KIND] label? transform

Accessors

[toStringTag] anchor charCount font layout lineHeight parent style text width

Constructors

constructor

new TextObject(options: TextOptions): TextObject
Parameters
- options: TextOptions
Returns TextObject
Overrides SceneObject.constructor
- Defined in scene/text.ts:93

Properties

[OBJECT_KIND]

"[OBJECT_KIND]": ObjectKind = ObjectKind.OBJECT

`Optional`label

label?: string

`Readonly`transform

transform: LocalTransform2D = ...

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
- Defined in scene/text.ts:89

anchor

get anchor(): ReadonlyVec2
Returns ReadonlyVec2
Implementation of TextLike.anchor
- Defined in scene/text.ts:82
set anchor(anchor: Vec2): void
Parameters
- anchor: Vec2
Returns void
Implementation of TextLike.anchor
- Defined in scene/text.ts:85

charCount

get charCount(): number
Returns number
- Defined in scene/text.ts:43

font

get font(): Font
Returns Font
Implementation of TextLike.font
- Defined in scene/text.ts:56
set font(font: Font): void
Parameters
- font: Font
Returns void
Implementation of TextLike.font
- Defined in scene/text.ts:59

layout

get layout(): TextLayout
Returns TextLayout
Implementation of TextLike.layout
- Defined in scene/text.ts:69

lineHeight

get lineHeight(): number
Returns number
- Defined in scene/text.ts:65

parent

get parent(): undefined | Group
Returns undefined | Group
Inherited from SceneObject.parent
- Defined in scene/graph/base.ts:32
set parent(parent: undefined | Group): void
Parameters
- parent: undefined | Group
Returns void
Inherited from SceneObject.parent
- Defined in scene/graph/base.ts:36

style

get style(): TextStyle
Returns TextStyle
Implementation of TextLike.style
- Defined in scene/text.ts:47
set style(style: Partial<TextStyle>): void
Parameters
- style: Partial<TextStyle>
Returns void
Implementation of TextLike.style
- Defined in scene/text.ts:50

text

get text(): string
Returns string
- Defined in scene/text.ts:33
set text(s: string): void
Parameters
- s: string
Returns void
- Defined in scene/text.ts:36

width

get width(): number
Returns number
- Defined in scene/text.ts:73
set width(width: number): void
Parameters
- width: number
Returns void
- Defined in scene/text.ts:76