Winter Cardinal UI - v0.457.0 / EShapeTextImpl

Class: EShapeTextImpl

Implements

• EShapeText

Table of contents

Constructors

• constructor

Properties

• _alpha
• _characters
• _clipping
• _color
• _direction
• _enable
• _family
• _fitting
• _length
• _nacharacters
• _parent
• _plength
• _size
• _style
• _value
• _weight
• align
• atlas
• offset
• outline
• padding
• spacing
• texture
• world

Accessors

• alpha
• characters
• clipping
• color
• direction
• enable
• family
• fitting
• length
• nacharacters
• plength
• size
• style
• value
• weight

Methods

• copy
• deserialize
• isCompatible
• serialize
• set
• toObject
• updateCharacters

Constructors

constructor

• new EShapeTextImpl(parent, value, color, alpha, family, size): EShapeTextImpl

Parameters

Name	Type
parent	EShapeTextImplParent
value	string
color	number
alpha	number
family	string
size	number

Returns

EShapeTextImpl

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:56

Properties

_alpha

• Protected _alpha: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:37

---

_characters

• Protected _characters: string[]

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:52

---

_clipping

• Protected _clipping: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:47

---

_color

• Protected _color: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:36

---

_direction

• Protected _direction: EShapeTextDirection

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:45

---

_enable

• Protected _enable: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:31

---

_family

• Protected _family: string

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:35

---

_fitting

• Protected _fitting: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:48

---

_length

• Protected _length: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:33

---

_nacharacters

• Protected _nacharacters: string[]

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:53

---

_parent

• Protected _parent: EShapeTextImplParent

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:30

---

_plength

• Protected _plength: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:34

---

_size

• Protected _size: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:38

---

_style

• Protected _style: EShapeTextStyle

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:42

---

_value

• Protected _value: string

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:32

---

_weight

• Protected _weight: EShapeTextWeight

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:39

---

align

• Readonly align: EShapeTextAlign

Implementation of

EShapeText.align

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:40

---

atlas

• Optional atlas: EShapeTextAtlas

Implementation of

EShapeText.atlas

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:51

---

offset

• Readonly offset: EShapeTextOffset

Implementation of

EShapeText.offset

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:41

---

outline

• Readonly outline: EShapeTextOutline

Implementation of

EShapeText.outline

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:43

---

padding

• Readonly padding: EShapeTextOffset

Implementation of

EShapeText.padding

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:46

---

spacing

• Readonly spacing: EShapeTextOffset

Implementation of

EShapeText.spacing

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:44

---

texture

• Optional texture: Texture

Implementation of

EShapeText.texture

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:50

---

world

• Optional world: number[]

Implementation of

EShapeText.world

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:54

Accessors

alpha

• get alpha(): number

Returns

number

Implementation of

EShapeText.alpha

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:242

• set alpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Implementation of

EShapeText.alpha

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:246

---

characters

• get characters(): string[]

Returns

string[]

Implementation of

EShapeText.characters

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:124

---

clipping

• get clipping(): boolean

Returns

boolean

Implementation of

EShapeText.clipping

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:297

• set clipping(clipping): void

Parameters

Name	Type
clipping	boolean

Returns

void

Implementation of

EShapeText.clipping

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:301

---

color

• get color(): number

Returns

number

Implementation of

EShapeText.color

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:231

• set color(color): void

Parameters

Name	Type
color	number

Returns

void

Implementation of

EShapeText.color

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:235

---

direction

• get direction(): EShapeTextDirection

Returns

EShapeTextDirection

Implementation of

EShapeText.direction

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:286

• set direction(direction): void

Parameters

Name	Type
direction	EShapeTextDirection

Returns

void

Implementation of

EShapeText.direction

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:290

---

enable

• get enable(): boolean

Returns

boolean

Implementation of

EShapeText.enable

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:91

• set enable(enable): void

Parameters

Name	Type
enable	boolean

Returns

void

Implementation of

EShapeText.enable

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:95

---

family

• get family(): string

Returns

string

Implementation of

EShapeText.family

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:220

• set family(family): void

Parameters

Name	Type
family	string

Returns

void

Implementation of

EShapeText.family

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:224

---

fitting

• get fitting(): boolean

Returns

boolean

Implementation of

EShapeText.fitting

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:308

• set fitting(fitting): void

Parameters

Name	Type
fitting	boolean

Returns

void

Implementation of

EShapeText.fitting

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:312

---

length

• get length(): number

Returns

number

Implementation of

EShapeText.length

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:212

---

nacharacters

• get nacharacters(): string[]

Returns

string[]

Implementation of

EShapeText.nacharacters

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:128

---

plength

• get plength(): number

Peak length

Returns

number

Implementation of

EShapeText.plength

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:216

---

size

• get size(): number

Returns

number

Implementation of

EShapeText.size

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:253

• set size(size): void

Parameters

Name	Type
size	number

Returns

void

Implementation of

EShapeText.size

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:257

---

style

• get style(): EShapeTextStyle

Returns

EShapeTextStyle

Implementation of

EShapeText.style

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:275

• set style(style): void

Parameters

Name	Type
style	EShapeTextStyle

Returns

void

Implementation of

EShapeText.style

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:279

---

value

• get value(): string

Returns

string

Implementation of

EShapeText.value

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:102

• set value(value): void

Parameters

Name	Type
value	string

Returns

void

Implementation of

EShapeText.value

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:106

---

weight

• get weight(): EShapeTextWeight

Returns

EShapeTextWeight

Implementation of

EShapeText.weight

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:264

• set weight(weight): void

Parameters

Name	Type
weight	EShapeTextWeight

Returns

void

Implementation of

EShapeText.weight

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:268

Methods

copy

▸ copy(target?): this

Parameters

Name	Type
target?	DeepPartial<EShapeTextLike>

Returns

this

Implementation of

EShapeText.copy

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:319

---

deserialize

▸ deserialize(target, manager): void

Parameters

Name	Type
target	number
manager	EShapeResourceManagerDeserialization

Returns

void

Implementation of

EShapeText.deserialize

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:464

---

isCompatible

▸ isCompatible(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:187

---

serialize

▸ serialize(manager): number

Parameters

Name	Type
manager	EShapeResourceManagerSerialization

Returns

number

Implementation of

EShapeText.serialize

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:447

---

set

▸ set(value?, color?, alpha?, family?, size?, weight?, style?, direction?, clipping?, fitting?): this

Parameters

Name	Type
value?	string
color?	number
alpha?	number
family?	string
size?	number
weight?	EShapeTextWeight
style?	EShapeTextStyle
direction?	EShapeTextDirection
clipping?	boolean
fitting?	boolean

Returns

this

Implementation of

EShapeText.set

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:342

---

toObject

▸ toObject(): EShapeTextLike

Returns

EShapeTextLike

Implementation of

EShapeText.toObject

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:427

---

updateCharacters

▸ updateCharacters(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-text-impl.ts:132

Edit this page.