API Reference / Text
# Class: Text
# Hierarchy
-
↳
Text
# Table of contents
# Constructors
# Properties
- $alpha
- $anchorX
- $anchorY
- $autoFitSize
- $background
- $breakWord
- $canvas
- $children
- $color
- $context
- $dirty
- $emittingType
- $events
- $explicitSize
- $fontFamily
- $fontSize
- $fontStyle
- $fontWeight
- $height
- $lineHeight
- $lines
- $minFontSize
- $multiline
- $parent
- $removedListeners
- $rotation
- $scaleX
- $scaleY
- $shouldEmitTap
- $skewX
- $skewY
- $smoothing
- $stage
- $strokeColor
- $strokeSize
- $text
- $textAlign
- $touches
- $verticalAlign
- $visible
- $width
- $x
- $y
- name
- tag
- touchable
- boundaryRe
- defaultFontSize
- pixelRatio
- wordRe
# Accessors
- alpha
- anchorX
- anchorY
- autoFitSize
- background
- breakWord
- canvas
- color
- fontFamily
- fontSize
- fontStyle
- fontWeight
- height
- lineHeight
- minFontSize
- multiline
- numChildren
- parent
- rotation
- scaleX
- scaleY
- skewX
- skewY
- smoothing
- stage
- strokeColor
- strokeSize
- text
- textAlign
- ticker
- verticalAlign
- visible
- width
- x
- y
# Methods
- $divideLines
- $divideUnits
- $drawChild
- $emitAdded
- $emitAddedToStage
- $emitRemoved
- $emitRemovedFromStage
- $emitTouchEvent
- $getChildBounds
- $getChildTransform
- $getContentBounds
- $getTransform
- $isChildVisible
- $localHitTest
- $markDirty
- $markParentDirty
- $render
- $resizeCanvas
- $resizeParentCanvas
- $updateContext
- addChild
- addChildAt
- emit
- getChildAt
- getChildByName
- getChildIndex
- getChildrenByTag
- hasChild
- hasEventListener
- off
- on
- once
- removeAllChildren
- removeAllListeners
- removeChild
- removeChildAt
- removeChildByName
- removeChildrenByTag
- removeSelf
- replaceChild
- setChildIndex
- swapChildren
- swapChildrenAt
# Constructors
# constructor
• new Text(text?, options?)
# Parameters
| Name | Type |
|---|---|
text? | string |
options | TextOption |
# Overrides
# Defined in
display/Text.ts:29 (opens new window)
# Properties
# $alpha
• Protected $alpha: number = 1
# Inherited from
# Defined in
display/Layer.ts:29 (opens new window)
# $anchorX
• Protected $anchorX: number = 0
# Inherited from
# Defined in
display/Layer.ts:22 (opens new window)
# $anchorY
• Protected $anchorY: number = 0
# Inherited from
# Defined in
display/Layer.ts:23 (opens new window)
# $autoFitSize
• Protected $autoFitSize: boolean = false
# Defined in
display/Text.ts:24 (opens new window)
# $background
• Protected $background: string = null
# Inherited from
# Defined in
display/Layer.ts:32 (opens new window)
# $breakWord
• Protected $breakWord: boolean = false
# Defined in
display/Text.ts:23 (opens new window)
# $canvas
• Protected Readonly $canvas: HTMLCanvasElement
# Inherited from
# Defined in
display/Layer.ts:39 (opens new window)
# $children
• Protected $children: Layer[] = []
# Inherited from
# Defined in
display/Layer.ts:35 (opens new window)
# $color
• Protected $color: string = 'black'
# Defined in
display/Text.ts:12 (opens new window)
# $context
• Protected Readonly $context: CanvasRenderingContext2D
# Inherited from
# Defined in
display/Layer.ts:40 (opens new window)
# $dirty
• Protected $dirty: boolean = true
# Inherited from
# Defined in
display/Layer.ts:36 (opens new window)
# $emittingType
• Protected $emittingType: string = null
# Inherited from
# Defined in
event/EventEmitter.ts:6 (opens new window)
# $events
• Protected $events: Object = {}
# Inherited from
# Defined in
event/EventEmitter.ts:5 (opens new window)
# $explicitSize
• Protected $explicitSize: number = 0
# Defined in
display/Text.ts:26 (opens new window)
# $fontFamily
• Protected $fontFamily: string = 'Helvetica'
# Defined in
display/Text.ts:21 (opens new window)
# $fontSize
• Protected $fontSize: number = Text.defaultFontSize
# Defined in
display/Text.ts:13 (opens new window)
# $fontStyle
• Protected $fontStyle: FontStyle = 'normal'
# Defined in
display/Text.ts:14 (opens new window)
# $fontWeight
• Protected $fontWeight: FontWeight = 'normal'
# Defined in
display/Text.ts:15 (opens new window)
# $height
• Protected $height: number = 0
# Inherited from
# Defined in
display/Layer.ts:21 (opens new window)
# $lineHeight
• Protected $lineHeight: number = 1.2
# Defined in
display/Text.ts:18 (opens new window)
# $lines
• Protected $lines: string[] = []
# Defined in
display/Text.ts:27 (opens new window)
# $minFontSize
• Protected $minFontSize: number = 0
# Defined in
display/Text.ts:25 (opens new window)
# $multiline
• Protected $multiline: boolean = false
# Defined in
display/Text.ts:22 (opens new window)
# $parent
• Protected $parent: Layer = null
# Inherited from
# Defined in
display/Layer.ts:34 (opens new window)
# $removedListeners
• Protected $removedListeners: Listener[] = []
# Inherited from
# Defined in
event/EventEmitter.ts:7 (opens new window)
# $rotation
• Protected $rotation: number = 0
# Inherited from
# Defined in
display/Layer.ts:28 (opens new window)
# $scaleX
• Protected $scaleX: number = 1
# Inherited from
# Defined in
display/Layer.ts:26 (opens new window)
# $scaleY
• Protected $scaleY: number = 1
# Inherited from
# Defined in
display/Layer.ts:27 (opens new window)
# $shouldEmitTap
• Protected $shouldEmitTap: boolean = true
# Inherited from
# Defined in
display/Layer.ts:37 (opens new window)
# $skewX
• Protected $skewX: number = 0
# Inherited from
# Defined in
display/Layer.ts:24 (opens new window)
# $skewY
• Protected $skewY: number = 0
# Inherited from
# Defined in
display/Layer.ts:25 (opens new window)
# $smoothing
• Protected $smoothing: boolean = true
# Inherited from
# Defined in
display/Layer.ts:31 (opens new window)
# $stage
• Protected $stage: Stage = null
# Inherited from
# Defined in
display/Layer.ts:33 (opens new window)
# $strokeColor
• Protected $strokeColor: string = null
# Defined in
display/Text.ts:20 (opens new window)
# $strokeSize
• Protected $strokeSize: number = 0
# Defined in
display/Text.ts:19 (opens new window)
# $text
• Protected $text: string = ''
# Defined in
display/Text.ts:11 (opens new window)
# $textAlign
• Protected $textAlign: TextAlign = 'left'
# Defined in
display/Text.ts:16 (opens new window)
# $touches
• Protected $touches: boolean[] = []
# Inherited from
# Defined in
display/Layer.ts:38 (opens new window)
# $verticalAlign
• Protected $verticalAlign: VerticalAlign = 'top'
# Defined in
display/Text.ts:17 (opens new window)
# $visible
• Protected $visible: boolean = true
# Inherited from
# Defined in
display/Layer.ts:30 (opens new window)
# $width
• Protected $width: number = 0
# Inherited from
# Defined in
display/Layer.ts:20 (opens new window)
# $x
• Protected $x: number = 0
# Inherited from
# Defined in
display/Layer.ts:18 (opens new window)
# $y
• Protected $y: number = 0
# Inherited from
# Defined in
display/Layer.ts:19 (opens new window)
# name
• name: string = ''
# Inherited from
# Defined in
display/Layer.ts:14 (opens new window)
# tag
• tag: string = ''
# Inherited from
# Defined in
display/Layer.ts:15 (opens new window)
# touchable
• touchable: boolean = true
# Inherited from
# Defined in
display/Layer.ts:16 (opens new window)
# boundaryRe
▪ Static Protected Readonly boundaryRe: RegExp
# Defined in
display/Text.ts:9 (opens new window)
# defaultFontSize
▪ Static defaultFontSize: number = 16
# Defined in
display/Text.ts:6 (opens new window)
# pixelRatio
▪ Static pixelRatio: number
# Inherited from
# Defined in
display/Layer.ts:12 (opens new window)
# wordRe
▪ Static Protected Readonly wordRe: RegExp
# Defined in
display/Text.ts:8 (opens new window)
# Accessors
# alpha
• get alpha(): number
# Returns
number
# Inherited from
Layer.alpha
# Defined in
display/Layer.ts:169 (opens new window)
• set alpha(alpha): void
# Parameters
| Name | Type |
|---|---|
alpha | number |
# Returns
void
# Inherited from
Layer.alpha
# Defined in
display/Layer.ts:173 (opens new window)
# anchorX
• get anchorX(): number
# Returns
number
# Inherited from
Layer.anchorX
# Defined in
display/Layer.ts:92 (opens new window)
• set anchorX(anchorX): void
# Parameters
| Name | Type |
|---|---|
anchorX | number |
# Returns
void
# Inherited from
Layer.anchorX
# Defined in
display/Layer.ts:96 (opens new window)
# anchorY
• get anchorY(): number
# Returns
number
# Inherited from
Layer.anchorY
# Defined in
display/Layer.ts:103 (opens new window)
• set anchorY(anchorY): void
# Parameters
| Name | Type |
|---|---|
anchorY | number |
# Returns
void
# Inherited from
Layer.anchorY
# Defined in
display/Layer.ts:107 (opens new window)
# autoFitSize
• get autoFitSize(): boolean
# Returns
boolean
# Defined in
display/Text.ts:166 (opens new window)
• set autoFitSize(autoFitSize): void
# Parameters
| Name | Type |
|---|---|
autoFitSize | boolean |
# Returns
void
# Defined in
display/Text.ts:170 (opens new window)
# background
• get background(): string
# Returns
string
# Inherited from
Layer.background
# Defined in
display/Layer.ts:200 (opens new window)
• set background(background): void
# Parameters
| Name | Type |
|---|---|
background | string |
# Returns
void
# Inherited from
Layer.background
# Defined in
display/Layer.ts:204 (opens new window)
# breakWord
• get breakWord(): boolean
# Returns
boolean
# Defined in
display/Text.ts:157 (opens new window)
• set breakWord(breakWord): void
# Parameters
| Name | Type |
|---|---|
breakWord | boolean |
# Returns
void
# Defined in
display/Text.ts:161 (opens new window)
# canvas
• get canvas(): HTMLCanvasElement
# Returns
HTMLCanvasElement
# Inherited from
Layer.canvas
# Defined in
display/Layer.ts:227 (opens new window)
# color
• get color(): string
# Returns
string
# Defined in
display/Text.ts:58 (opens new window)
• set color(color): void
# Parameters
| Name | Type |
|---|---|
color | string |
# Returns
void
# Defined in
display/Text.ts:62 (opens new window)
# fontFamily
• get fontFamily(): string
# Returns
string
# Defined in
display/Text.ts:139 (opens new window)
• set fontFamily(fontFamily): void
# Parameters
| Name | Type |
|---|---|
fontFamily | string |
# Returns
void
# Defined in
display/Text.ts:143 (opens new window)
# fontSize
• get fontSize(): number
# Returns
number
# Defined in
display/Text.ts:67 (opens new window)
• set fontSize(fontSize): void
# Parameters
| Name | Type |
|---|---|
fontSize | number |
# Returns
void
# Defined in
display/Text.ts:71 (opens new window)
# fontStyle
• get fontStyle(): FontStyle
# Returns
# Defined in
display/Text.ts:76 (opens new window)
• set fontStyle(fontStyle): void
# Parameters
| Name | Type |
|---|---|
fontStyle | FontStyle |
# Returns
void
# Defined in
display/Text.ts:80 (opens new window)
# fontWeight
• get fontWeight(): FontWeight
# Returns
# Defined in
display/Text.ts:85 (opens new window)
• set fontWeight(fontWeight): void
# Parameters
| Name | Type |
|---|---|
fontWeight | FontWeight |
# Returns
void
# Defined in
display/Text.ts:89 (opens new window)
# height
• get height(): number
# Returns
number
# Inherited from
Layer.height
# Defined in
display/Layer.ts:81 (opens new window)
• set height(height): void
# Parameters
| Name | Type |
|---|---|
height | number |
# Returns
void
# Inherited from
Layer.height
# Defined in
display/Layer.ts:85 (opens new window)
# lineHeight
• get lineHeight(): number
# Returns
number
# Defined in
display/Text.ts:112 (opens new window)
• set lineHeight(lineHeight): void
# Parameters
| Name | Type |
|---|---|
lineHeight | number |
# Returns
void
# Defined in
display/Text.ts:116 (opens new window)
# minFontSize
• get minFontSize(): number
# Returns
number
# Defined in
display/Text.ts:175 (opens new window)
• set minFontSize(minFontSize): void
# Parameters
| Name | Type |
|---|---|
minFontSize | number |
# Returns
void
# Defined in
display/Text.ts:179 (opens new window)
# multiline
• get multiline(): boolean
# Returns
boolean
# Defined in
display/Text.ts:148 (opens new window)
• set multiline(multiline): void
# Parameters
| Name | Type |
|---|---|
multiline | boolean |
# Returns
void
# Defined in
display/Text.ts:152 (opens new window)
# numChildren
• get numChildren(): number
# Returns
number
# Inherited from
Layer.numChildren
# Defined in
display/Layer.ts:219 (opens new window)
# parent
• get parent(): Layer
# Returns
# Inherited from
Layer.parent
# Defined in
display/Layer.ts:215 (opens new window)
# rotation
• get rotation(): number
# Returns
number
# Inherited from
Layer.rotation
# Defined in
display/Layer.ts:158 (opens new window)
• set rotation(rotation): void
# Parameters
| Name | Type |
|---|---|
rotation | number |
# Returns
void
# Inherited from
Layer.rotation
# Defined in
display/Layer.ts:162 (opens new window)
# scaleX
• get scaleX(): number
# Returns
number
# Inherited from
Layer.scaleX
# Defined in
display/Layer.ts:136 (opens new window)
• set scaleX(scaleX): void
# Parameters
| Name | Type |
|---|---|
scaleX | number |
# Returns
void
# Inherited from
Layer.scaleX
# Defined in
display/Layer.ts:140 (opens new window)
# scaleY
• get scaleY(): number
# Returns
number
# Inherited from
Layer.scaleY
# Defined in
display/Layer.ts:147 (opens new window)
• set scaleY(scaleY): void
# Parameters
| Name | Type |
|---|---|
scaleY | number |
# Returns
void
# Inherited from
Layer.scaleY
# Defined in
display/Layer.ts:151 (opens new window)
# skewX
• get skewX(): number
# Returns
number
# Inherited from
Layer.skewX
# Defined in
display/Layer.ts:114 (opens new window)
• set skewX(skewX): void
# Parameters
| Name | Type |
|---|---|
skewX | number |
# Returns
void
# Inherited from
Layer.skewX
# Defined in
display/Layer.ts:118 (opens new window)
# skewY
• get skewY(): number
# Returns
number
# Inherited from
Layer.skewY
# Defined in
display/Layer.ts:125 (opens new window)
• set skewY(skewY): void
# Parameters
| Name | Type |
|---|---|
skewY | number |
# Returns
void
# Inherited from
Layer.skewY
# Defined in
display/Layer.ts:129 (opens new window)
# smoothing
• get smoothing(): boolean
# Returns
boolean
# Inherited from
Layer.smoothing
# Defined in
display/Layer.ts:191 (opens new window)
• set smoothing(smoothing): void
# Parameters
| Name | Type |
|---|---|
smoothing | boolean |
# Returns
void
# Inherited from
Layer.smoothing
# Defined in
display/Layer.ts:195 (opens new window)
# stage
• get stage(): Stage
# Returns
# Inherited from
Layer.stage
# Defined in
display/Layer.ts:211 (opens new window)
# strokeColor
• get strokeColor(): string
# Returns
string
# Defined in
display/Text.ts:130 (opens new window)
• set strokeColor(strokeColor): void
# Parameters
| Name | Type |
|---|---|
strokeColor | string |
# Returns
void
# Defined in
display/Text.ts:134 (opens new window)
# strokeSize
• get strokeSize(): number
# Returns
number
# Defined in
display/Text.ts:121 (opens new window)
• set strokeSize(strokeSize): void
# Parameters
| Name | Type |
|---|---|
strokeSize | number |
# Returns
void
# Defined in
display/Text.ts:125 (opens new window)
# text
• get text(): string
# Returns
string
# Defined in
display/Text.ts:49 (opens new window)
• set text(text): void
# Parameters
| Name | Type |
|---|---|
text | string |
# Returns
void
# Defined in
display/Text.ts:53 (opens new window)
# textAlign
• get textAlign(): TextAlign
# Returns
# Defined in
display/Text.ts:94 (opens new window)
• set textAlign(textAlign): void
# Parameters
| Name | Type |
|---|---|
textAlign | TextAlign |
# Returns
void
# Defined in
display/Text.ts:98 (opens new window)
# ticker
• get ticker(): Ticker
# Returns
# Inherited from
Layer.ticker
# Defined in
display/Layer.ts:223 (opens new window)
# verticalAlign
• get verticalAlign(): VerticalAlign
# Returns
# Defined in
display/Text.ts:103 (opens new window)
• set verticalAlign(verticalAlign): void
# Parameters
| Name | Type |
|---|---|
verticalAlign | VerticalAlign |
# Returns
void
# Defined in
display/Text.ts:107 (opens new window)
# visible
• get visible(): boolean
# Returns
boolean
# Inherited from
Layer.visible
# Defined in
display/Layer.ts:180 (opens new window)
• set visible(visible): void
# Parameters
| Name | Type |
|---|---|
visible | boolean |
# Returns
void
# Inherited from
Layer.visible
# Defined in
display/Layer.ts:184 (opens new window)
# width
• get width(): number
# Returns
number
# Inherited from
Layer.width
# Defined in
display/Layer.ts:70 (opens new window)
• set width(width): void
# Parameters
| Name | Type |
|---|---|
width | number |
# Returns
void
# Inherited from
Layer.width
# Defined in
display/Layer.ts:74 (opens new window)
# x
• get x(): number
# Returns
number
# Inherited from
Layer.x
# Defined in
display/Layer.ts:48 (opens new window)
• set x(x): void
# Parameters
| Name | Type |
|---|---|
x | number |
# Returns
void
# Inherited from
Layer.x
# Defined in
display/Layer.ts:52 (opens new window)
# y
• get y(): number
# Returns
number
# Inherited from
Layer.y
# Defined in
display/Layer.ts:59 (opens new window)
• set y(y): void
# Parameters
| Name | Type |
|---|---|
y | number |
# Returns
void
# Inherited from
Layer.y
# Defined in
display/Layer.ts:63 (opens new window)
# Methods
# $divideLines
▸ Protected $divideLines(): void
# Returns
void
# Defined in
display/Text.ts:221 (opens new window)
# $divideUnits
▸ Protected $divideUnits(): string[]
# Returns
string[]
# Defined in
display/Text.ts:199 (opens new window)
# $drawChild
▸ Protected $drawChild(child): number
# Parameters
| Name | Type |
|---|---|
child | Layer |
# Returns
number
# Inherited from
# Defined in
display/Layer.ts:605 (opens new window)
# $emitAdded
▸ Protected $emitAdded(parent): void
# Parameters
| Name | Type |
|---|---|
parent | Layer |
# Returns
void
# Inherited from
# Defined in
display/Layer.ts:543 (opens new window)
# $emitAddedToStage
▸ Protected $emitAddedToStage(stage): void
# Parameters
| Name | Type |
|---|---|
stage | Stage |
# Returns
void
# Inherited from
# Defined in
display/Layer.ts:561 (opens new window)
# $emitRemoved
▸ Protected $emitRemoved(): void
# Returns
void
# Inherited from
# Defined in
display/Layer.ts:552 (opens new window)
# $emitRemovedFromStage
▸ Protected $emitRemovedFromStage(): void
# Returns
void
# Inherited from
# Defined in
display/Layer.ts:574 (opens new window)
# $emitTouchEvent
▸ Protected $emitTouchEvent(event, inside): boolean
# Parameters
| Name | Type |
|---|---|
event | TouchEvent |
inside | boolean |
# Returns
boolean
# Inherited from
# Defined in
display/Layer.ts:495 (opens new window)
# $getChildBounds
▸ Protected $getChildBounds(child): Rectangle
# Parameters
| Name | Type |
|---|---|
child | Layer |
# Returns
# Inherited from
# Defined in
display/Layer.ts:449 (opens new window)
# $getChildTransform
▸ Protected $getChildTransform(child): Matrix
# Parameters
| Name | Type |
|---|---|
child | Layer |
# Returns
# Inherited from
# Defined in
display/Layer.ts:445 (opens new window)
# $getContentBounds
▸ Protected $getContentBounds(): Rectangle
# Returns
# Overrides
# Defined in
display/Text.ts:273 (opens new window)
# $getTransform
▸ Protected $getTransform(): Matrix
# Returns
# Inherited from
# Defined in
display/Layer.ts:434 (opens new window)
# $isChildVisible
▸ Protected $isChildVisible(child): boolean
# Parameters
| Name | Type |
|---|---|
child | Layer |
# Returns
boolean
# Inherited from
# Defined in
display/Layer.ts:591 (opens new window)
# $localHitTest
▸ Protected $localHitTest(vector): boolean
# Parameters
| Name | Type |
|---|---|
vector | Vector |
# Returns
boolean
# Inherited from
# Defined in
display/Layer.ts:587 (opens new window)
# $markDirty
▸ Protected $markDirty(sizeDirty?): void
# Parameters
| Name | Type |
|---|---|
sizeDirty? | boolean |
# Returns
void
# Inherited from
# Defined in
display/Layer.ts:389 (opens new window)
# $markParentDirty
▸ Protected $markParentDirty(): void
# Returns
void
# Inherited from
# Defined in
display/Layer.ts:398 (opens new window)
# $render
▸ Protected $render(): number
# Returns
number
# Overrides
# Defined in
display/Text.ts:288 (opens new window)
# $resizeCanvas
▸ Protected $resizeCanvas(): void
# Returns
void
# Overrides
# Defined in
display/Text.ts:253 (opens new window)
# $resizeParentCanvas
▸ Protected $resizeParentCanvas(): void
# Returns
void
# Inherited from
# Defined in
display/Layer.ts:428 (opens new window)
# $updateContext
▸ Protected $updateContext(): void
# Returns
void
# Defined in
display/Text.ts:184 (opens new window)
# addChild
▸ addChild(child): Text
# Parameters
| Name | Type |
|---|---|
child | Layer |
# Returns
# Inherited from
# Defined in
display/Layer.ts:231 (opens new window)
# addChildAt
▸ addChildAt(child, index): Text
# Parameters
| Name | Type |
|---|---|
child | Layer |
index | number |
# Returns
# Inherited from
# Defined in
display/Layer.ts:235 (opens new window)
# emit
▸ emit(event): boolean
# Parameters
| Name | Type |
|---|---|
event | Event |
# Returns
boolean
# Inherited from
# Defined in
event/EventEmitter.ts:42 (opens new window)
▸ emit(type, ...args): boolean
# Parameters
| Name | Type |
|---|---|
type | string |
...args | any[] |
# Returns
boolean
# Inherited from
# Defined in
event/EventEmitter.ts:43 (opens new window)
# getChildAt
▸ getChildAt(index): Layer
# Parameters
| Name | Type |
|---|---|
index | number |
# Returns
# Inherited from
# Defined in
display/Layer.ts:277 (opens new window)
# getChildByName
▸ getChildByName(name): Layer
# Parameters
| Name | Type |
|---|---|
name | string |
# Returns
# Inherited from
# Defined in
display/Layer.ts:256 (opens new window)
# getChildIndex
▸ getChildIndex(child): number
# Parameters
| Name | Type |
|---|---|
child | Layer |
# Returns
number
# Inherited from
# Defined in
display/Layer.ts:281 (opens new window)
# getChildrenByTag
▸ getChildrenByTag(tag): Layer[]
# Parameters
| Name | Type |
|---|---|
tag | string |
# Returns
Layer[]
# Inherited from
# Defined in
display/Layer.ts:266 (opens new window)
# hasChild
▸ hasChild(child): boolean
# Parameters
| Name | Type |
|---|---|
child | Layer |
# Returns
boolean
# Inherited from
# Defined in
display/Layer.ts:285 (opens new window)
# hasEventListener
▸ hasEventListener(type): boolean
# Parameters
| Name | Type |
|---|---|
type | string |
# Returns
boolean
# Inherited from
# Defined in
event/EventEmitter.ts:80 (opens new window)
# off
▸ off(type, listener?): Text
# Parameters
| Name | Type |
|---|---|
type | string |
listener? | (...args: any[]) => void |
# Returns
# Inherited from
# Defined in
display/Layer.ts:684 (opens new window)
# on
▸ on(type, listener): Text
# Parameters
| Name | Type |
|---|---|
type | string |
listener | (...args: any[]) => void |
# Returns
# Inherited from
# Defined in
display/Layer.ts:668 (opens new window)
# once
▸ once(type, listener): Text
# Parameters
| Name | Type |
|---|---|
type | string |
listener | Listener |
# Returns
# Inherited from
# Defined in
event/EventEmitter.ts:33 (opens new window)
# removeAllChildren
▸ removeAllChildren(): Text
# Returns
# Inherited from
# Defined in
display/Layer.ts:372 (opens new window)
# removeAllListeners
▸ removeAllListeners(): Text
# Returns
# Inherited from
# Defined in
event/EventEmitter.ts:85 (opens new window)
# removeChild
▸ removeChild(child): Text
# Parameters
| Name | Type |
|---|---|
child | Layer |
# Returns
# Inherited from
# Defined in
display/Layer.ts:333 (opens new window)
# removeChildAt
▸ removeChildAt(index): Text
# Parameters
| Name | Type |
|---|---|
index | number |
# Returns
# Inherited from
# Defined in
display/Layer.ts:338 (opens new window)
# removeChildByName
▸ removeChildByName(name): Text
# Parameters
| Name | Type |
|---|---|
name | string |
# Returns
# Inherited from
# Defined in
display/Layer.ts:349 (opens new window)
# removeChildrenByTag
▸ removeChildrenByTag(tag): Text
# Parameters
| Name | Type |
|---|---|
tag | string |
# Returns
# Inherited from
# Defined in
display/Layer.ts:361 (opens new window)
# removeSelf
▸ removeSelf(): Text
# Returns
# Inherited from
# Defined in
display/Layer.ts:382 (opens new window)
# replaceChild
▸ replaceChild(oldChild, newChild): Text
# Parameters
| Name | Type |
|---|---|
oldChild | Layer |
newChild | Layer |
# Returns
# Inherited from
# Defined in
display/Layer.ts:249 (opens new window)
# setChildIndex
▸ setChildIndex(child, index): Text
# Parameters
| Name | Type |
|---|---|
child | Layer |
index | number |
# Returns
# Inherited from
# Defined in
display/Layer.ts:309 (opens new window)
# swapChildren
▸ swapChildren(child1, child2): Text
# Parameters
| Name | Type |
|---|---|
child1 | Layer |
child2 | Layer |
# Returns
# Inherited from
# Defined in
display/Layer.ts:289 (opens new window)
# swapChildrenAt
▸ swapChildrenAt(index1, index2): Text
# Parameters
| Name | Type |
|---|---|
index1 | number |
index2 | number |