Character

Represents a styled character

Hierarchy

Shape
- Character

Index

Constructors

constructor

Properties

Constructors

constructor

new Character(character: string, style: {}, index?: number): Character

Overrides Shape.__constructor
- Defined in src/Character.ts:27
Parameters
- character: string
- style: {}
- Default value index: number = null
Returns Character

Properties

_font

_font: Font

_glyph

_glyph: Glyph

alpha

alpha: number

bitmapCache

bitmapCache: BitmapCache

cacheCanvas

cacheCanvas: HTMLCanvasElement | Object

cacheID

cacheID: number

character: string = ""

characterCase

characterCase: Case = null

characterCaseOffset

characterCaseOffset: number = 0

characterCode

characterCode: number = null

compositeOperation

compositeOperation: string

cursor

cursor: string

fillColor

fillColor: string = null

filters

filters: Filter[]

font

font: string = null

graphics

graphics: Graphics

hPosition

hPosition: number = null

hitArea

hitArea: DisplayObject

id

id: number

index

index: number = null

mask

mask: Shape

measuredHeight

measuredHeight: number = null

measuredWidth

measuredWidth: number = null

missing

missing: boolean = false

mouseEnabled

mouseEnabled: boolean

name

name: string

parent

parent: Container

regX

regX: number

regY

regY: number

rotation

rotation: number

scaleX

scaleX: number

scaleY

scaleY: number

shadow

shadow: Shadow

size

size: number = null

skewX

skewX: number

skewY

skewY: number

snapToPixel

snapToPixel: boolean

stage

stage: Stage

strokeColor

strokeColor: string = null

strokeWidth

strokeWidth: number = null

tickEnabled

tickEnabled: boolean

tracking

tracking: number = null

transformMatrix

transformMatrix: Matrix2D

visible

visible: boolean

x

x: number

y

y: number

Static suppressCrossDomainErrors

suppressCrossDomainErrors: boolean

Methods

addEventListener

addEventListener(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): Function
addEventListener(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): Function
addEventListener(type: string, listener: { handleEvent: (eventObj: Object) => boolean }, useCapture?: boolean): Object
addEventListener(type: string, listener: { handleEvent: (eventObj: Object) => void }, useCapture?: boolean): Object

Inherited from Character.addEventListener
- Defined in node_modules/@types/createjs-lib/index.d.ts:69
Parameters
- type: string
- listener: (eventObj: Object) => boolean
  - - (eventObj: Object): boolean
    - Parameters
      - eventObj: Object
      Returns boolean
- Optional useCapture: boolean
Returns Function
Inherited from Character.addEventListener
- Defined in node_modules/@types/createjs-lib/index.d.ts:70
Parameters
- type: string
- listener: (eventObj: Object) => void
  - - (eventObj: Object): void
    - Parameters
      - eventObj: Object
      Returns void
- Optional useCapture: boolean
Returns Function
Inherited from Character.addEventListener
- Defined in node_modules/@types/createjs-lib/index.d.ts:71
Parameters
- type: string
- listener: { handleEvent: (eventObj: Object) => boolean }
  - handleEvent: (eventObj: Object) => boolean
    - - (eventObj: Object): boolean
      - Parameters
        
        eventObj: Object
        
        Returns boolean
- Optional useCapture: boolean
Returns Object
Inherited from Character.addEventListener
- Defined in node_modules/@types/createjs-lib/index.d.ts:72
Parameters
- type: string
- listener: { handleEvent: (eventObj: Object) => void }
  - handleEvent: (eventObj: Object) => void
    - - (eventObj: Object): void
      - Parameters
        
        eventObj: Object
        
        Returns void
- Optional useCapture: boolean
Returns Object

cache

cache(x: number, y: number, width: number, height: number, scale?: number): void

Inherited from Character.cache
- Defined in node_modules/@types/easeljs/index.d.ts:260
Parameters
- x: number
- y: number
- width: number
- height: number
- Optional scale: number
Returns void

clone

clone(recursive?: boolean): Shape

Inherited from Character.clone

Overrides DisplayObject.clone
- Defined in node_modules/@types/easeljs/index.d.ts:785
Parameters
- Optional recursive: boolean
Returns Shape

dispatchEvent

dispatchEvent(eventObj: Object, target?: Object): boolean
dispatchEvent(eventObj: string, target?: Object): boolean
dispatchEvent(eventObj: Event, target?: Object): boolean

Inherited from Character.dispatchEvent
- Defined in node_modules/@types/createjs-lib/index.d.ts:73
Parameters
- eventObj: Object
- Optional target: Object
Returns boolean
Inherited from Character.dispatchEvent
- Defined in node_modules/@types/createjs-lib/index.d.ts:74
Parameters
- eventObj: string
- Optional target: Object
Returns boolean
Inherited from Character.dispatchEvent
- Defined in node_modules/@types/createjs-lib/index.d.ts:75
Parameters
- eventObj: Event
- Optional target: Object
Returns boolean

draw

draw(ctx: CanvasRenderingContext2D): boolean

Overrides Word.draw
- Defined in src/Character.ts:133
Parameters
- ctx: CanvasRenderingContext2D
Returns boolean

getBounds

getBounds(): Rectangle

Inherited from Character.getBounds
- Defined in node_modules/@types/easeljs/index.d.ts:263
Returns Rectangle

getCacheDataURL

getCacheDataURL(): string

Inherited from Character.getCacheDataURL
- Defined in node_modules/@types/easeljs/index.d.ts:264
Returns string

getConcatenatedDisplayProps

getConcatenatedDisplayProps(props?: DisplayProps): DisplayProps

Inherited from Character.getConcatenatedDisplayProps
- Defined in node_modules/@types/easeljs/index.d.ts:265
Parameters
- Optional props: DisplayProps
Returns DisplayProps

getConcatenatedMatrix

getConcatenatedMatrix(mtx?: Matrix2D): Matrix2D

Inherited from Character.getConcatenatedMatrix
- Defined in node_modules/@types/easeljs/index.d.ts:266
Parameters
- Optional mtx: Matrix2D
Returns Matrix2D

getMatrix

getMatrix(matrix?: Matrix2D): Matrix2D

Inherited from Character.getMatrix
- Defined in node_modules/@types/easeljs/index.d.ts:267
Parameters
- Optional matrix: Matrix2D
Returns Matrix2D

getStage

getStage(): Stage

Inherited from Character.getStage
- Defined in node_modules/@types/easeljs/index.d.ts:271
deprecated

Returns Stage

getTransformedBounds

getTransformedBounds(): Rectangle

Inherited from Character.getTransformedBounds
- Defined in node_modules/@types/easeljs/index.d.ts:272
Returns Rectangle

getWidth

getWidth(): number

- Defined in src/Character.ts:141
Returns number

globalToLocal

globalToLocal(x: number, y: number, pt?: Point | Object): Point

Inherited from Character.globalToLocal
- Defined in node_modules/@types/easeljs/index.d.ts:273
Parameters
- x: number
- y: number
- Optional pt: Point | Object
Returns Point

hasEventListener

hasEventListener(type: string): boolean

Inherited from Character.hasEventListener
- Defined in node_modules/@types/createjs-lib/index.d.ts:76
Parameters
- type: string
Returns boolean

hitTest

hitTest(x: number, y: number): boolean

Inherited from Character.hitTest
- Defined in node_modules/@types/easeljs/index.d.ts:274
Parameters
- x: number
- y: number
Returns boolean

isVisible

isVisible(): boolean

Inherited from Character.isVisible
- Defined in node_modules/@types/easeljs/index.d.ts:275
Returns boolean

localToGlobal

localToGlobal(x: number, y: number, pt?: Point | Object): Point

Inherited from Character.localToGlobal
- Defined in node_modules/@types/easeljs/index.d.ts:276
Parameters
- x: number
- y: number
- Optional pt: Point | Object
Returns Point

localToLocal

localToLocal(x: number, y: number, target: DisplayObject, pt?: Point | Object): Point

Inherited from Character.localToLocal
- Defined in node_modules/@types/easeljs/index.d.ts:277
Parameters
- x: number
- y: number
- target: DisplayObject
- Optional pt: Point | Object
Returns Point

off

off(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): void
off(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): void
off(type: string, listener: { handleEvent: (eventObj: Object) => boolean }, useCapture?: boolean): void
off(type: string, listener: { handleEvent: (eventObj: Object) => void }, useCapture?: boolean): void
off(type: string, listener: Function, useCapture?: boolean): void

Inherited from Character.off
- Defined in node_modules/@types/createjs-lib/index.d.ts:78
Parameters
- type: string
- listener: (eventObj: Object) => boolean
  - - (eventObj: Object): boolean
    - Parameters
      - eventObj: Object
      Returns boolean
- Optional useCapture: boolean
Returns void
Inherited from Character.off
- Defined in node_modules/@types/createjs-lib/index.d.ts:79
Parameters
- type: string
- listener: (eventObj: Object) => void
  - - (eventObj: Object): void
    - Parameters
      - eventObj: Object
      Returns void
- Optional useCapture: boolean
Returns void
Inherited from Character.off
- Defined in node_modules/@types/createjs-lib/index.d.ts:80
Parameters
- type: string
- listener: { handleEvent: (eventObj: Object) => boolean }
  - handleEvent: (eventObj: Object) => boolean
    - - (eventObj: Object): boolean
      - Parameters
        
        eventObj: Object
        
        Returns boolean
- Optional useCapture: boolean
Returns void
Inherited from Character.off
- Defined in node_modules/@types/createjs-lib/index.d.ts:81
Parameters
- type: string
- listener: { handleEvent: (eventObj: Object) => void }
  - handleEvent: (eventObj: Object) => void
    - - (eventObj: Object): void
      - Parameters
        
        eventObj: Object
        
        Returns void
- Optional useCapture: boolean
Returns void
Inherited from Character.off
- Defined in node_modules/@types/createjs-lib/index.d.ts:82
Parameters
- type: string
- listener: Function
- Optional useCapture: boolean
Returns void

on

on(type: string, listener: (eventObj: Object) => boolean, scope?: Object, once?: boolean, data?: any, useCapture?: boolean): Function
on(type: string, listener: (eventObj: Object) => void, scope?: Object, once?: boolean, data?: any, useCapture?: boolean): Function
on(type: string, listener: { handleEvent: (eventObj: Object) => boolean }, scope?: Object, once?: boolean, data?: any, useCapture?: boolean): Object
on(type: string, listener: { handleEvent: (eventObj: Object) => void }, scope?: Object, once?: boolean, data?: any, useCapture?: boolean): Object

Inherited from Character.on
- Defined in node_modules/@types/createjs-lib/index.d.ts:83
Parameters
- type: string
- listener: (eventObj: Object) => boolean
  - - (eventObj: Object): boolean
    - Parameters
      - eventObj: Object
      Returns boolean
- Optional scope: Object
- Optional once: boolean
- Optional data: any
- Optional useCapture: boolean
Returns Function
Inherited from Character.on
- Defined in node_modules/@types/createjs-lib/index.d.ts:84
Parameters
- type: string
- listener: (eventObj: Object) => void
  - - (eventObj: Object): void
    - Parameters
      - eventObj: Object
      Returns void
- Optional scope: Object
- Optional once: boolean
- Optional data: any
- Optional useCapture: boolean
Returns Function
Inherited from Character.on
- Defined in node_modules/@types/createjs-lib/index.d.ts:85
Parameters
- type: string
- listener: { handleEvent: (eventObj: Object) => boolean }
  - handleEvent: (eventObj: Object) => boolean
    - - (eventObj: Object): boolean
      - Parameters
        
        eventObj: Object
        
        Returns boolean
- Optional scope: Object
- Optional once: boolean
- Optional data: any
- Optional useCapture: boolean
Returns Object
Inherited from Character.on
- Defined in node_modules/@types/createjs-lib/index.d.ts:86
Parameters
- type: string
- listener: { handleEvent: (eventObj: Object) => void }
  - handleEvent: (eventObj: Object) => void
    - - (eventObj: Object): void
      - Parameters
        
        eventObj: Object
        
        Returns void
- Optional scope: Object
- Optional once: boolean
- Optional data: any
- Optional useCapture: boolean
Returns Object

removeAllEventListeners

removeAllEventListeners(type?: string): void

Inherited from Character.removeAllEventListeners
- Defined in node_modules/@types/createjs-lib/index.d.ts:87
Parameters
- Optional type: string
Returns void

removeEventListener

removeEventListener(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): void
removeEventListener(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): void
removeEventListener(type: string, listener: { handleEvent: (eventObj: Object) => boolean }, useCapture?: boolean): void
removeEventListener(type: string, listener: { handleEvent: (eventObj: Object) => void }, useCapture?: boolean): void
removeEventListener(type: string, listener: Function, useCapture?: boolean): void

Inherited from Character.removeEventListener
- Defined in node_modules/@types/createjs-lib/index.d.ts:88
Parameters
- type: string
- listener: (eventObj: Object) => boolean
  - - (eventObj: Object): boolean
    - Parameters
      - eventObj: Object
      Returns boolean
- Optional useCapture: boolean
Returns void
Inherited from Character.removeEventListener
- Defined in node_modules/@types/createjs-lib/index.d.ts:89
Parameters
- type: string
- listener: (eventObj: Object) => void
  - - (eventObj: Object): void
    - Parameters
      - eventObj: Object
      Returns void
- Optional useCapture: boolean
Returns void
Inherited from Character.removeEventListener
- Defined in node_modules/@types/createjs-lib/index.d.ts:90
Parameters
- type: string
- listener: { handleEvent: (eventObj: Object) => boolean }
  - handleEvent: (eventObj: Object) => boolean
    - - (eventObj: Object): boolean
      - Parameters
        
        eventObj: Object
        
        Returns boolean
- Optional useCapture: boolean
Returns void
Inherited from Character.removeEventListener
- Defined in node_modules/@types/createjs-lib/index.d.ts:91
Parameters
- type: string
- listener: { handleEvent: (eventObj: Object) => void }
  - handleEvent: (eventObj: Object) => void
    - - (eventObj: Object): void
      - Parameters
        
        eventObj: Object
        
        Returns void
- Optional useCapture: boolean
Returns void
Inherited from Character.removeEventListener
- Defined in node_modules/@types/createjs-lib/index.d.ts:92
Parameters
- type: string
- listener: Function
- Optional useCapture: boolean
Returns void

set

set(props: Object): Shape

Inherited from Character.set

Overrides Word.set
- Defined in node_modules/@types/easeljs/index.d.ts:786
Parameters
- props: Object
Returns Shape

setBounds

setBounds(x: number, y: number, width: number, height: number): void

Inherited from Character.setBounds
- Defined in node_modules/@types/easeljs/index.d.ts:279
Parameters
- x: number
- y: number
- width: number
- height: number
Returns void

setGlyph

setGlyph(glyph: Glyph): void

- Defined in src/Character.ts:124
Parameters
- glyph: Glyph
Returns void

setTransform

setTransform(x?: number, y?: number, scaleX?: number, scaleY?: number, rotation?: number, skewX?: number, skewY?: number, regX?: number, regY?: number): Shape

Inherited from Character.setTransform

Overrides Word.setTransform
- Defined in node_modules/@types/easeljs/index.d.ts:787
Parameters
- Optional x: number
- Optional y: number
- Optional scaleX: number
- Optional scaleY: number
- Optional rotation: number
- Optional skewX: number
- Optional skewY: number
- Optional regX: number
- Optional regY: number
Returns Shape

toString

toString(): string

Inherited from Character.toString
- Defined in node_modules/@types/createjs-lib/index.d.ts:93
Returns string

trackingOffset

trackingOffset(): number

- Defined in src/Character.ts:129
Returns number

uncache

uncache(): void

Inherited from Character.uncache
- Defined in node_modules/@types/easeljs/index.d.ts:281
Returns void

updateCache

updateCache(compositeOperation?: string): void

Inherited from Character.updateCache
- Defined in node_modules/@types/easeljs/index.d.ts:282
Parameters
- Optional compositeOperation: string
Returns void

updateContext

updateContext(ctx: CanvasRenderingContext2D): void

Inherited from Character.updateContext
- Defined in node_modules/@types/easeljs/index.d.ts:283
Parameters
- ctx: CanvasRenderingContext2D
Returns void

willTrigger

willTrigger(type: string): boolean

Inherited from Character.willTrigger
- Defined in node_modules/@types/createjs-lib/index.d.ts:94
Parameters
- type: string
Returns boolean

Static initialize

initialize(target: Object): void

Inherited from Character.initialize
- Defined in node_modules/@types/createjs-lib/index.d.ts:77
Parameters
- target: Object
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

character: string

style: {}

Default value index: number = null

Returns Character

Properties

_font

_glyph

alpha

bitmapCache

cacheCanvas

cacheID

character

characterCase

characterCaseOffset

characterCode

compositeOperation

cursor

fillColor

filters

font

graphics

hPosition

hitArea

id

index

mask

measuredHeight

measuredWidth

missing

mouseEnabled

name

parent

regX

regY

rotation

scaleX

scaleY

shadow

size

skewX

skewY

snapToPixel

stage

strokeColor

strokeWidth

tickEnabled

tracking

transformMatrix

visible

x

y

Static suppressCrossDomainErrors

Methods

addEventListener

Parameters

type: string

listener: (eventObj: Object) => boolean

Parameters

eventObj: Object

Returns boolean

Optional useCapture: boolean

Returns Function

Parameters

type: string

listener: (eventObj: Object) => void

Parameters

eventObj: Object

Returns void

Optional useCapture: boolean

Returns Function

Parameters

type: string