Class TextStyle<T>

文本样式

从pixi.js移植

See

https://github.com/pixijs/pixi.js/blob/dev/packages/text/src/TextStyle.js

Type Parameters

T extends TextStyleEventMap = TextStyleEventMap

Hierarchy

EventEmitter<T>
- TextStyle

Constructors

constructor

new TextStyle<T>(style?: Partial<TextStyle<TextStyleEventMap>>): TextStyle<T>
Type Parameters
- T extends TextStyleEventMap = TextStyleEventMap
Parameters
- Optional style: Partial<TextStyle<TextStyleEventMap>>
  
  样式参数
Returns TextStyle<T>
Overrides EventEmitter.constructor
- Defined in src/2d/text/TextStyle.ts:138

Properties

align

align: TextAlign = TextAlign.left

多行文本对齐方式。

breakWords

breakWords: boolean = false

能否把单词分多行。

dropShadow

dropShadow: boolean = false

是否为文本设置一个投影。

dropShadowAngle

dropShadowAngle: number = 30

投影角度。

dropShadowBlur

dropShadowBlur: number = 0

阴影模糊半径。

dropShadowColor

dropShadowColor: Color4 = ...

投影颜色。

dropShadowDistance

dropShadowDistance: number = 5

投影距离。

fill

fill: Color4 = ...

用于填充文本的颜色。

See

https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fillStyle

fillGradientStops

fillGradientStops: number[] = []

如果填充是一个颜色数组来创建渐变，这个数组可以设置停止点

fillGradientType

fillGradientType: TEXT_GRADIENT = TEXT_GRADIENT.LINEAR_VERTICAL

如果填充是一个创建渐变的颜色数组，这可以改变渐变的方向。

fontFamily

fontFamily: FontFamily = FontFamily.Arial

字体。

fontStyle

fontStyle: FontStyle = FontStyle.normal

字体样式。

fontVariant

fontVariant: FontVariant = FontVariant.normal

字体变体。

fontWeight

fontWeight: FontWeight = FontWeight.normal

字型粗细。

leading

leading: number = 0

行距。

letterSpacing

letterSpacing: number = 0

字母之间的间距，默认为0

lineHeight

lineHeight: number = 0

行高。

lineJoin

lineJoin: CanvasLineJoin = CanvasLineJoin.miter

lineJoin属性设置创建的角的类型，它可以解决带尖刺的文本问题。

miterLimit

miterLimit: number = 10

当使用“miter”lineJoin模式时，miter限制使用。这可以减少或增加呈现文本的尖锐性。

padding

padding: number = 0

内边距，用于文字被裁减问题。

stroke

stroke: Color4 = ...

将用于文本笔划的画布填充样式。

strokeThickness

strokeThickness: number = 0

一个表示笔画厚度的数字。

textBaseline

textBaseline: CanvasTextBaseline = CanvasTextBaseline.alphabetic

呈现文本的基线。

trim

trim: boolean = false

是否修剪透明边界。

whiteSpace

whiteSpace: WhiteSpaceHandle = WhiteSpaceHandle.pre

如何处理换行与空格。 Default is 'pre' (preserve, preserve).

value	New lines	Spaces
'normal'	Collapse	Collapse
'pre'	Preserve	Preserve
'pre-line'	Preserve	Collapse

wordWrap

wordWrap: boolean = false

是否应使用自动换行。

wordWrapWidth

wordWrapWidth: number = 100

文本的换行宽度。

Methods

broadcast

broadcast<K>(type: K, data?: T[K]): IEvent<T[K]>
将事件广播到下级对象中。

Returns
返回广播后的事件。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: T[K]
  
  事件携带的自定义数据。
Returns IEvent<T[K]>
Inherited from EventEmitter.broadcast
- Defined in src/event/EventEmitter.ts:176

bubbles

bubbles<K>(type: K, data?: T[K]): IEvent<T[K]>
将事件冒泡到上级对象中。

Returns
返回冒泡后的事件。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: T[K]
  
  事件携带的自定义数据。
Returns IEvent<T[K]>
Inherited from EventEmitter.bubbles
- Defined in src/event/EventEmitter.ts:189

dispose

dispose(): void
销毁

Returns void
Inherited from EventEmitter.dispose
- Defined in src/event/EventEmitter.ts:535

emit

emit<K>(type: K, data?: T[K], bubbles?: boolean, broadcast?: boolean, share?: boolean): IEvent<T[K]>
发射事件。

Returns
返回发射后的事件。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: T[K]
  
  事件携带的自定义数据。
- bubbles: boolean = false
  
  是否向上级报告事件。默认为false。
- broadcast: boolean = false
  
  是否向下级广播事件。默认为false。
- share: boolean = true
  
  是否向平级分享事件。默认为true。
Returns IEvent<T[K]>
Inherited from EventEmitter.emit
- Defined in src/event/EventEmitter.ts:145

emitEvent

emitEvent<K>(event: IEvent<T[K]>): IEvent<T[K]>
发射事件。

当事件重复流向一个对象时将不会被处理。

Returns
返回事件是否被处理
Type Parameters
- K extends string
Parameters
- event: IEvent<T[K]>
  
  事件对象
Returns IEvent<T[K]>
Inherited from EventEmitter.emitEvent
- Defined in src/event/EventEmitter.ts:110

eventNames

eventNames<K>(): K[]
返回监听的事件类型列表。
Type Parameters
- K extends string
Returns K[]
Inherited from EventEmitter.eventNames
- Defined in src/event/EventEmitter.ts:70

`Protected` handelEventBroadcast

handelEventBroadcast<K>(event: IEvent<T[K]>): void
向下级广播事件
Type Parameters
- K extends string
Parameters
- event: IEvent<T[K]>
  
  事件
Returns void
Inherited from EventEmitter.handelEventBroadcast
- Defined in src/event/EventEmitter.ts:506

`Protected` handelEventBubbles

handelEventBubbles<K>(event: IEvent<T[K]>): void
向上级报告事件
Type Parameters
- K extends string
Parameters
- event: IEvent<T[K]>
  
  事件
Returns void
Inherited from EventEmitter.handelEventBubbles
- Defined in src/event/EventEmitter.ts:475

`Protected` handelEventShare

handelEventShare<K>(event: IEvent<T[K]>): void
向平级分享事件
Type Parameters
- K extends string
Parameters
- event: IEvent<T[K]>
  
  事件
Returns void
Inherited from EventEmitter.handelEventShare
- Defined in src/event/EventEmitter.ts:451

`Protected` handleEvent

handleEvent<K>(e: IEvent<T[K]>): void
处理事件
Type Parameters
- K extends string
Parameters
- e: IEvent<T[K]>
  
  事件
Returns void
Inherited from EventEmitter.handleEvent
- Defined in src/event/EventEmitter.ts:389

has

has<K>(type: K): boolean
检查 Event 对象是否为特定事件类型注册了任何侦听器.

Returns
如果指定类型的侦听器已注册，则值为 true；否则，值为 false。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
Returns boolean
Inherited from EventEmitter.has
- Defined in src/event/EventEmitter.ts:200

invalidate

invalidate(): void
使数据失效

Returns void
- Defined in src/2d/text/TextStyle.ts:381

listenerCount

listenerCount<K>(type: K): number
返回指定事件类型的监听数量。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
Returns number
Inherited from EventEmitter.listenerCount
- Defined in src/event/EventEmitter.ts:82

off

off<K>(type?: K, listener?: ((event: IEvent<T[K]>) => void), thisObject?: any): TextStyle<T>
移除监听
Type Parameters
- K extends string
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
- Optional listener: ((event: IEvent<T[K]>) => void)
  
  要删除的监听器对象。可选。该值为空时所有指定类型的监听均将被移除。
  - - (event: IEvent<T[K]>): void
    - Parameters
      
      event: IEvent<T[K]>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns TextStyle<T>
Inherited from EventEmitter.off
- Defined in src/event/EventEmitter.ts:253

offAll

offAll<K>(type?: K): TextStyle<T>
移除所有监听
Type Parameters
- K extends string
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
Returns TextStyle<T>
Inherited from EventEmitter.offAll
- Defined in src/event/EventEmitter.ts:303

offAny

offAny<K>(listener?: ((event: IEvent<T[K]>) => void), thisObject?: any): TextStyle<T>
移除监听对象的任意事件。
Type Parameters
- K extends string
Parameters
- Optional listener: ((event: IEvent<T[K]>) => void)
  
  处理事件的监听器函数。
  - - (event: IEvent<T[K]>): void
    - Parameters
      
      event: IEvent<T[K]>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns TextStyle<T>
Inherited from EventEmitter.offAny
- Defined in src/event/EventEmitter.ts:353

on

on<K>(type: K, listener: ((event: IEvent<T[K]>) => void), thisObject?: any, priority?: number, once?: boolean): TextStyle<T>
为监听对象新增指定类型的事件监听。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
- listener: ((event: IEvent<T[K]>) => void)
  
  处理事件的监听器函数。
  - - (event: IEvent<T[K]>): void
    - Parameters
      
      event: IEvent<T[K]>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns TextStyle<T>
Inherited from EventEmitter.on
- Defined in src/event/EventEmitter.ts:214

onAny

onAny<K>(listener: ((event: IEvent<T[K]>) => void), thisObject?: any, priority?: number, once?: boolean): TextStyle<T>
监听对象的任意事件，该对象的任意事件都将触发该监听器的调用。
Type Parameters
- K extends string
Parameters
- listener: ((event: IEvent<T[K]>) => void)
  
  处理事件的监听器函数。
  - - (event: IEvent<T[K]>): void
    - Parameters
      
      event: IEvent<T[K]>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns TextStyle<T>
Inherited from EventEmitter.onAny
- Defined in src/event/EventEmitter.ts:318

once

once<K>(type: K, listener: ((event: IEvent<T[K]>) => void), thisObject?: any, priority?: number): TextStyle<T>
监听一次事件后将会被移除
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
- listener: ((event: IEvent<T[K]>) => void)
  
  处理事件的侦听器函数。
  - - (event: IEvent<T[K]>): void
    - Parameters
      
      event: IEvent<T[K]>
      
      Returns void
- Optional thisObject: any
  
  listener函数作用域
- priority: number = 0
  
  事件侦听器的优先级。数字越大，优先级越高。默认优先级为 0。
Returns TextStyle<T>
Inherited from EventEmitter.once
- Defined in src/event/EventEmitter.ts:95

toFontString

toFontString(): string
生成用于' TextMetrics.measureFont() '的字体样式字符串。

Returns string
- Defined in src/2d/text/TextStyle.ts:390

`Static` getEventEmitter

getEventEmitter(target: any): EventEmitter<any>
获取事件发射器
Parameters
- target: any
Returns EventEmitter<any>
Inherited from EventEmitter.getEventEmitter
- Defined in src/event/EventEmitter.ts:29

`Static` getOrCreateEventEmitter

getOrCreateEventEmitter(target: any): EventEmitter<any>
获取事件发射器，当没有找到对应发射器时，返回新建的事件发射器。
Parameters
- target: any
Returns EventEmitter<any>
Inherited from EventEmitter.getOrCreateEventEmitter
- Defined in src/event/EventEmitter.ts:44

Class TextStyle<T>

See

Type Parameters

T extends TextStyleEventMap = TextStyleEventMap

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends TextStyleEventMap = TextStyleEventMap

Parameters

Optional style: Partial<TextStyle<TextStyleEventMap>>

Returns TextStyle<T>

Properties

align

breakWords

dropShadow

dropShadowAngle

dropShadowBlur

dropShadowColor

dropShadowDistance

fill

See

fillGradientStops

fillGradientType

fontFamily

fontSize

fontStyle

fontVariant

fontWeight

leading

letterSpacing

lineHeight

lineJoin

miterLimit

padding

stroke

strokeThickness

textBaseline

trim

whiteSpace

wordWrap

wordWrapWidth

Methods

broadcast

Returns

Type Parameters

K extends string

Parameters

type: K

Optional data: T[K]

Returns IEvent<T[K]>

bubbles

Returns

Type Parameters

K extends string

Parameters

type: K

Optional data: T[K]

Returns IEvent<T[K]>

dispose

Returns void

emit

Returns

Type Parameters

K extends string

Parameters

type: K

Optional data: T[K]

bubbles: boolean = false

broadcast: boolean = false

share: boolean = true

Returns IEvent<T[K]>

emitEvent

Returns

Type Parameters

K extends string

`Optional` style: Partial<TextStyle<TextStyleEventMap>>

`Optional` data: T[K]

`Optional` data: T[K]

`Optional` data: T[K]

`Protected` handelEventBroadcast

`Protected` handelEventBubbles

`Protected` handelEventShare

`Protected` handleEvent

`Optional` type: K

`Optional` listener: ((event: IEvent<T[K]>) => void)

`Optional` thisObject: any

`Optional` type: K

`Optional` listener: ((event: IEvent<T[K]>) => void)