Winter Cardinal UI - v0.457.0 / DDynamicTextStyle

Class: DDynamicTextStyle

Hierarchy

• EventEmitter

  ↳ DDynamicTextStyle

Table of contents

Constructors

• constructor

Properties

• _clipping
• _fill
• _fillApproved
• _fitting
• _fontFamily
• _fontId
• _fontIdApproved
• _fontIdFontSize
• _fontIdId
• _fontSize
• _fontSizeFitted
• _fontStyle
• _fontVariant
• _fontWeight
• _id
• _idApproved
• _isFontFitted
• _lineHeight
• _lineHeightFitted
• _wordWrap

Accessors

• clipping
• fill
• fillApproved
• fitting
• fontFamily
• fontId
• fontIdApproved
• fontIdFontSize
• fontSize
• fontSizeFitted
• fontStyle
• fontVariant
• fontWeight
• id
• idApproved
• isFontFitted
• lineHeight
• lineHeightFitted
• wordWrap

Methods

• addListener
• approve
• emit
• eventNames
• fit
• listenerCount
• listeners
• off
• on
• onChange
• once
• removeAllListeners
• removeListener
• toFontId
• unfit
• update

Constructors

constructor

• new DDynamicTextStyle(parent, theme, options?): DDynamicTextStyle

Parameters

Name	Type
parent	DDynamicTextStyleParent
theme	DThemeDynamicTextStyle
options?	DDynamicTextStyleOptions

Returns

DDynamicTextStyle

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:60

Properties

_clipping

• Protected _clipping: boolean

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:54

---

_fill

• Protected _fill: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:52

---

_fillApproved

• Protected _fillApproved: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:53

---

_fitting

• Protected _fitting: boolean

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:55

---

_fontFamily

• Protected _fontFamily: string

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:45

---

_fontId

• Protected _fontId: string

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:42

---

_fontIdApproved

• Protected _fontIdApproved: string

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:43

---

_fontIdFontSize

• Protected _fontIdFontSize: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:44

---

_fontIdId

• Protected _fontIdId: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:41

---

_fontSize

• Protected _fontSize: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:46

---

_fontSizeFitted

• Protected _fontSizeFitted: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:47

---

_fontStyle

• Protected _fontStyle: DFontStyle

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:49

---

_fontVariant

• Protected _fontVariant: DFontVariant

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:50

---

_fontWeight

• Protected _fontWeight: DFontWeight

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:51

---

_id

• Protected _id: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:39

---

_idApproved

• Protected _idApproved: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:40

---

_isFontFitted

• Protected _isFontFitted: boolean

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:48

---

_lineHeight

• Protected _lineHeight: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:57

---

_lineHeightFitted

• Protected _lineHeightFitted: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:58

---

_wordWrap

• Protected _wordWrap: DDynamicTextStyleWordWrap

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:56

Accessors

clipping

• get clipping(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:233

• set clipping(clipping): void

Parameters

Name	Type
clipping	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:237

---

fill

• get fill(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:127

• set fill(fill): void

Parameters

Name	Type
fill	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:131

---

fillApproved

• get fillApproved(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:143

---

fitting

• get fitting(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:244

• set fitting(fitting): void

Parameters

Name	Type
fitting	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:248

---

fontFamily

• get fontFamily(): string

Returns

string

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:154

• set fontFamily(fontFamily): void

Parameters

Name	Type
fontFamily	string

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:158

---

fontId

• get fontId(): string

Returns

string

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:113

---

fontIdApproved

• get fontIdApproved(): string

Returns

string

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:123

---

fontIdFontSize

• get fontIdFontSize(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:118

---

fontSize

• get fontSize(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:165

• set fontSize(fontSize): void

Parameters

Name	Type
fontSize	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:169

---

fontSizeFitted

• get fontSizeFitted(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:179

---

fontStyle

• get fontStyle(): DFontStyle

Returns

DFontStyle

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:187

• set fontStyle(fontStyle): void

Parameters

Name	Type
fontStyle	DFontStyle

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:191

---

fontVariant

• get fontVariant(): DFontVariant

Returns

DFontVariant

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:198

• set fontVariant(fontVariant): void

Parameters

Name	Type
fontVariant	DFontVariant

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:202

---

fontWeight

• get fontWeight(): DFontWeight

Returns

DFontWeight

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:209

• set fontWeight(fontWeight): void

Parameters

Name	Type
fontWeight	DFontWeight

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:213

---

id

• get id(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:105

---

idApproved

• get idApproved(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:109

---

isFontFitted

• get isFontFitted(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:183

---

lineHeight

• get lineHeight(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:266

• set lineHeight(lineHeight): void

Parameters

Name	Type
lineHeight	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:270

---

lineHeightFitted

• get lineHeightFitted(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:280

• set lineHeightFitted(lineHeightFitted): void

Parameters

Name	Type
lineHeightFitted	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:284

---

wordWrap

• get wordWrap(): DDynamicTextStyleWordWrap

Returns

DDynamicTextStyleWordWrap

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:255

• set wordWrap(wordWrap): void

Parameters

Name	Type
wordWrap	DDynamicTextStyleWordWrap

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:259

Methods

addListener

▸ addListener(event, fn, context?): this

Alias method for on

Parameters

Name	Type
event	string | symbol
fn	Function
context?	any

Returns

this

Inherited from

utils.EventEmitter.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25495

---

approve

▸ approve(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:147

---

emit

▸ emit(event, ...args): boolean

Calls each of the listeners registered for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
...args	any[]	Arguments that are passed to registered listeners

Returns

boolean

true if the event had listeners, else false.

Inherited from

utils.EventEmitter.emit

Defined in

node_modules/pixi.js/pixi.js.d.ts:25441

---

eventNames

▸ eventNames(): (string | symbol)[]

Return an array listing the events for which the emitter has registered listeners.

Returns

(string | symbol)[]

Inherited from

utils.EventEmitter.eventNames

Defined in

node_modules/pixi.js/pixi.js.d.ts:25415

---

fit

▸ fit(fontSize, lineHeight): boolean

Parameters

Name	Type
fontSize	number
lineHeight	number

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:291

---

listenerCount

▸ listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.

Returns

number

Inherited from

utils.EventEmitter.listenerCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:25432

---

listeners

▸ listeners(event): Function[]

Return the listeners registered for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.

Returns

Function[]

Inherited from

utils.EventEmitter.listeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25424

---

off

▸ off(event, fn?, context?, once?): this

Alias method for removeListener

Parameters

Name	Type
event	string | symbol
fn?	Function
context?	any
once?	boolean

Returns

this

Inherited from

utils.EventEmitter.off

Defined in

node_modules/pixi.js/pixi.js.d.ts:25489

---

on

▸ on(event, fn, context?): this

Add a listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Inherited from

utils.EventEmitter.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25452

---

onChange

▸ onChange(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:138

---

once

▸ once(event, fn, context?): this

Add a one-time listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Inherited from

utils.EventEmitter.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25463

---

removeAllListeners

▸ removeAllListeners(event?): this

Remove all listeners, or those of the specified event.

Parameters

Name	Type	Description
event?	string | symbol	The event name.

Returns

this

this.

Inherited from

utils.EventEmitter.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25483

---

removeListener

▸ removeListener(event, fn?, context?, once?): this

Remove the listeners of a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn?	Function	Only remove the listeners that match this function.
context?	any	Only remove the listeners that have this context.
once?	boolean	Only remove one-time listeners.

Returns

this

this.

Inherited from

utils.EventEmitter.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25475

---

toFontId

▸ toFontId(fontSize): string

Parameters

Name	Type
fontSize	number

Returns

string

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:229

---

unfit

▸ unfit(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:311

---

update

▸ update(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-style.ts:220

Edit this page.