API Reference / Stage

# Class: Stage

# Hierarchy

# Table of contents

# Constructors

# Properties

# Accessors

# Methods

# Constructors

# constructor

new Stage(canvas?)

# Parameters

Name Type
canvas? HTMLCanvasElement

# Overrides

Layer.constructor

# Defined in

display/Stage.ts:33 (opens new window)

# Properties

# $activated

Protected $activated: boolean = false

# Defined in

display/Stage.ts:21 (opens new window)


# $alpha

Protected $alpha: number = 1

# Inherited from

Layer.$alpha

# Defined in

display/Layer.ts:29 (opens new window)


# $anchorX

Protected $anchorX: number = 0

# Inherited from

Layer.$anchorX

# Defined in

display/Layer.ts:22 (opens new window)


# $anchorY

Protected $anchorY: number = 0

# Inherited from

Layer.$anchorY

# Defined in

display/Layer.ts:23 (opens new window)


# $background

Protected $background: string = null

# Inherited from

Layer.$background

# Defined in

display/Layer.ts:32 (opens new window)


# $boundResizeViewportCanvas

Protected Readonly $boundResizeViewportCanvas: () => void

# Type declaration

▸ (): void

# Returns

void

# Defined in

display/Stage.ts:31 (opens new window)


# $canvas

Protected Readonly $canvas: HTMLCanvasElement

# Inherited from

Layer.$canvas

# Defined in

display/Layer.ts:39 (opens new window)


# $children

Protected $children: Layer[] = []

# Inherited from

Layer.$children

# Defined in

display/Layer.ts:35 (opens new window)


# $context

Protected Readonly $context: CanvasRenderingContext2D

# Inherited from

Layer.$context

# Defined in

display/Layer.ts:40 (opens new window)


# $dirty

Protected $dirty: boolean = true

# Inherited from

Layer.$dirty

# Defined in

display/Layer.ts:36 (opens new window)


# $drawCalls

Protected $drawCalls: number = 0

# Defined in

display/Stage.ts:20 (opens new window)


# $elementEvents

Protected Readonly $elementEvents: ElementEvent[]

# Defined in

display/Stage.ts:27 (opens new window)


# $emittingType

Protected $emittingType: string = null

# Inherited from

Layer.$emittingType

# Defined in

event/EventEmitter.ts:6 (opens new window)


# $events

Protected $events: Object = {}

# Inherited from

Layer.$events

# Defined in

event/EventEmitter.ts:5 (opens new window)


# $height

Protected $height: number = 0

# Inherited from

Layer.$height

# Defined in

display/Layer.ts:21 (opens new window)


# $parent

Protected $parent: Layer = null

# Inherited from

Layer.$parent

# Defined in

display/Layer.ts:34 (opens new window)


# $removedListeners

Protected $removedListeners: Listener[] = []

# Inherited from

Layer.$removedListeners

# Defined in

event/EventEmitter.ts:7 (opens new window)


# $renderBounds

Protected Readonly $renderBounds: Rectangle

# Defined in

display/Stage.ts:30 (opens new window)


# $rotation

Protected $rotation: number = 0

# Inherited from

Layer.$rotation

# Defined in

display/Layer.ts:28 (opens new window)


# $scaleMode

Protected $scaleMode: string = Stage.SHOW_ALL

# Defined in

display/Stage.ts:22 (opens new window)


# $scaleX

Protected $scaleX: number = 1

# Inherited from

Layer.$scaleX

# Defined in

display/Layer.ts:26 (opens new window)


# $scaleY

Protected $scaleY: number = 1

# Inherited from

Layer.$scaleY

# Defined in

display/Layer.ts:27 (opens new window)


# $shouldEmitTap

Protected $shouldEmitTap: boolean = true

# Inherited from

Layer.$shouldEmitTap

# Defined in

display/Layer.ts:37 (opens new window)


# $skewX

Protected $skewX: number = 0

# Inherited from

Layer.$skewX

# Defined in

display/Layer.ts:24 (opens new window)


# $skewY

Protected $skewY: number = 0

# Inherited from

Layer.$skewY

# Defined in

display/Layer.ts:25 (opens new window)


# $smoothing

Protected $smoothing: boolean = true

# Inherited from

Layer.$smoothing

# Defined in

display/Layer.ts:31 (opens new window)


# $stage

Protected $stage: Stage = null

# Inherited from

Layer.$stage

# Defined in

display/Layer.ts:33 (opens new window)


# $ticker

Protected Readonly $ticker: Ticker

# Defined in

display/Stage.ts:26 (opens new window)


# $touches

Protected $touches: boolean[] = []

# Inherited from

Layer.$touches

# Defined in

display/Layer.ts:38 (opens new window)


# $viewportBackground

Protected $viewportBackground: string = null

# Defined in

display/Stage.ts:25 (opens new window)


# $viewportCanvas

Protected Readonly $viewportCanvas: HTMLCanvasElement

# Defined in

display/Stage.ts:28 (opens new window)


# $viewportContext

Protected Readonly $viewportContext: CanvasRenderingContext2D

# Defined in

display/Stage.ts:29 (opens new window)


# $viewportHeight

Protected $viewportHeight: number = 0

# Defined in

display/Stage.ts:24 (opens new window)


# $viewportWidth

Protected $viewportWidth: number = 0

# Defined in

display/Stage.ts:23 (opens new window)


# $visible

Protected $visible: boolean = true

# Inherited from

Layer.$visible

# Defined in

display/Layer.ts:30 (opens new window)


# $width

Protected $width: number = 0

# Inherited from

Layer.$width

# Defined in

display/Layer.ts:20 (opens new window)


# $x

Protected $x: number = 0

# Inherited from

Layer.$x

# Defined in

display/Layer.ts:18 (opens new window)


# $y

Protected $y: number = 0

# Inherited from

Layer.$y

# Defined in

display/Layer.ts:19 (opens new window)


# name

name: string = ''

# Inherited from

Layer.name

# Defined in

display/Layer.ts:14 (opens new window)


# tag

tag: string = ''

# Inherited from

Layer.tag

# Defined in

display/Layer.ts:15 (opens new window)


# touchable

touchable: boolean = true

# Inherited from

Layer.touchable

# Defined in

display/Layer.ts:16 (opens new window)


# EXACT_FIT

Static Readonly EXACT_FIT: string = 'exactFit'

# Defined in

display/Stage.ts:12 (opens new window)


# FIXED_HEIGHT

Static Readonly FIXED_HEIGHT: string = 'fixedHeight'

# Defined in

display/Stage.ts:18 (opens new window)


# FIXED_NARROW

Static Readonly FIXED_NARROW: string = 'fixedNarrow'

# Defined in

display/Stage.ts:16 (opens new window)


# FIXED_WIDE

Static Readonly FIXED_WIDE: string = 'fixedWide'

# Defined in

display/Stage.ts:15 (opens new window)


# FIXED_WIDTH

Static Readonly FIXED_WIDTH: string = 'fixedWidth'

# Defined in

display/Stage.ts:17 (opens new window)


# NO_BORDER

Static Readonly NO_BORDER: string = 'noBorder'

# Defined in

display/Stage.ts:14 (opens new window)


# NO_SCALE

Static Readonly NO_SCALE: string = 'noScale'

# Defined in

display/Stage.ts:13 (opens new window)


# SHOW_ALL

Static Readonly SHOW_ALL: string = 'showAll'

# Defined in

display/Stage.ts:11 (opens new window)


# pixelRatio

Static pixelRatio: number

# Inherited from

Layer.pixelRatio

# Defined in

display/Layer.ts:12 (opens new window)

# Accessors

# activated

get activated(): boolean

# Returns

boolean

# Defined in

display/Stage.ts:81 (opens new window)


# 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)


# 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)


# canvas

get canvas(): HTMLCanvasElement

# Returns

HTMLCanvasElement

# Inherited from

Layer.canvas

# Defined in

display/Layer.ts:227 (opens new window)


# drawCalls

get drawCalls(): number

# Returns

number

# Defined in

display/Stage.ts:77 (opens new window)


# fps

get fps(): number

# Returns

number

# Defined in

display/Stage.ts:73 (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)


# numChildren

get numChildren(): number

# Returns

number

# Inherited from

Layer.numChildren

# Defined in

display/Layer.ts:219 (opens new window)


# parent

get parent(): Layer

# Returns

Layer

# 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)


# scaleMode

get scaleMode(): string

# Returns

string

# Defined in

display/Stage.ts:85 (opens new window)

set scaleMode(scaleMode): void

# Parameters

Name Type
scaleMode string

# Returns

void

# Defined in

display/Stage.ts:89 (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

Stage

# Inherited from

Layer.stage

# Defined in

display/Layer.ts:211 (opens new window)


# ticker

get ticker(): Ticker

# Returns

Ticker

# Overrides

Layer.ticker

# Defined in

display/Stage.ts:69 (opens new window)


# viewportBackground

get viewportBackground(): string

# Returns

string

# Defined in

display/Stage.ts:122 (opens new window)

set viewportBackground(viewportBackground): void

# Parameters

Name Type
viewportBackground string

# Returns

void

# Defined in

display/Stage.ts:126 (opens new window)


# viewportCanvas

get viewportCanvas(): HTMLCanvasElement

# Returns

HTMLCanvasElement

# Defined in

display/Stage.ts:96 (opens new window)


# viewportHeight

get viewportHeight(): number

# Returns

number

# Defined in

display/Stage.ts:111 (opens new window)

set viewportHeight(height): void

# Parameters

Name Type
height number

# Returns

void

# Defined in

display/Stage.ts:115 (opens new window)


# viewportWidth

get viewportWidth(): number

# Returns

number

# Defined in

display/Stage.ts:100 (opens new window)

set viewportWidth(width): void

# Parameters

Name Type
width number

# Returns

void

# Defined in

display/Stage.ts:104 (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

# Overrides

Layer.x

# Defined in

display/Stage.ts:53 (opens new window)

set x(x): void

# Parameters

Name Type
x number

# Returns

void

# Overrides

Layer.x

# Defined in

display/Stage.ts:57 (opens new window)


# y

get y(): number

# Returns

number

# Overrides

Layer.y

# Defined in

display/Stage.ts:61 (opens new window)

set y(y): void

# Parameters

Name Type
y number

# Returns

void

# Overrides

Layer.y

# Defined in

display/Stage.ts:65 (opens new window)

# Methods

# $addElementEvent

Protected $addElementEvent(target, type, listener, options?): void

# Parameters

Name Type
target EventTarget
type string
listener (event: any) => void
options? boolean | AddEventListenerOptions

# Returns

void

# Defined in

display/Stage.ts:183 (opens new window)


# $addTouchEventListeners

Protected $addTouchEventListeners(): void

# Returns

void

# Defined in

display/Stage.ts:196 (opens new window)


# $calculateRenderBounds

Protected $calculateRenderBounds(): void

# Returns

void

# Defined in

display/Stage.ts:275 (opens new window)


# $dispatchTouchEvent

Protected $dispatchTouchEvent(type, pageX, pageY, identifier): void

# Parameters

Name Type
type string
pageX number
pageY number
identifier number

# Returns

void

# Defined in

display/Stage.ts:245 (opens new window)


# $dispatchTouches

Protected $dispatchTouches(type, event): void

# Parameters

Name Type
type string
event any

# Returns

void

# Defined in

display/Stage.ts:237 (opens new window)


# $drawChild

Protected $drawChild(child): number

# Parameters

Name Type
child Layer

# Returns

number

# Inherited from

Layer.$drawChild

# Defined in

display/Layer.ts:605 (opens new window)


# $emitAdded

Protected $emitAdded(parent): void

# Parameters

Name Type
parent Layer

# Returns

void

# Inherited from

Layer.$emitAdded

# Defined in

display/Layer.ts:543 (opens new window)


# $emitAddedToStage

Protected $emitAddedToStage(stage): void

# Parameters

Name Type
stage Stage

# Returns

void

# Inherited from

Layer.$emitAddedToStage

# Defined in

display/Layer.ts:561 (opens new window)


# $emitRemoved

Protected $emitRemoved(): void

# Returns

void

# Inherited from

Layer.$emitRemoved

# Defined in

display/Layer.ts:552 (opens new window)


# $emitRemovedFromStage

Protected $emitRemovedFromStage(): void

# Returns

void

# Inherited from

Layer.$emitRemovedFromStage

# 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

Layer.$emitTouchEvent

# Defined in

display/Layer.ts:495 (opens new window)


# $getChildBounds

Protected $getChildBounds(child): Rectangle

# Parameters

Name Type
child Layer

# Returns

Rectangle

# Inherited from

Layer.$getChildBounds

# Defined in

display/Layer.ts:449 (opens new window)


# $getChildTransform

Protected $getChildTransform(child): Matrix

# Parameters

Name Type
child Layer

# Returns

Matrix

# Inherited from

Layer.$getChildTransform

# Defined in

display/Layer.ts:445 (opens new window)


# $getContentBounds

Protected $getContentBounds(): Rectangle

# Returns

Rectangle

# Inherited from

Layer.$getContentBounds

# Defined in

display/Layer.ts:474 (opens new window)


# $getTransform

Protected $getTransform(): Matrix

# Returns

Matrix

# Inherited from

Layer.$getTransform

# Defined in

display/Layer.ts:434 (opens new window)


# $initEvents

Protected $initEvents(): void

# Returns

void

# Defined in

display/Stage.ts:151 (opens new window)


# $isChildVisible

Protected $isChildVisible(child): boolean

# Parameters

Name Type
child Layer

# Returns

boolean

# Inherited from

Layer.$isChildVisible

# Defined in

display/Layer.ts:591 (opens new window)


# $localHitTest

Protected $localHitTest(vector): boolean

# Parameters

Name Type
vector Vector

# Returns

boolean

# Inherited from

Layer.$localHitTest

# Defined in

display/Layer.ts:587 (opens new window)


# $markDirty

Protected $markDirty(sizeDirty?): void

# Parameters

Name Type
sizeDirty? boolean

# Returns

void

# Inherited from

Layer.$markDirty

# Defined in

display/Layer.ts:389 (opens new window)


# $markParentDirty

Protected $markParentDirty(): void

# Returns

void

# Inherited from

Layer.$markParentDirty

# Defined in

display/Layer.ts:398 (opens new window)


# $removeElementEvents

Protected $removeElementEvents(): void

# Returns

void

# Defined in

display/Stage.ts:188 (opens new window)


# $render

Protected $render(): number

# Returns

number

# Overrides

Layer.$render

# Defined in

display/Stage.ts:367 (opens new window)


# $resizeCanvas

Protected $resizeCanvas(): void

# Returns

void

# Overrides

Layer.$resizeCanvas

# Defined in

display/Stage.ts:344 (opens new window)


# $resizeParentCanvas

Protected $resizeParentCanvas(): void

# Returns

void

# Inherited from

Layer.$resizeParentCanvas

# Defined in

display/Layer.ts:428 (opens new window)


# $resizeViewportCanvas

Protected $resizeViewportCanvas(): void

# Returns

void

# Defined in

display/Stage.ts:349 (opens new window)


# addChild

addChild(child): Stage

# Parameters

Name Type
child Layer

# Returns

Stage

# Inherited from

Layer.addChild

# Defined in

display/Layer.ts:231 (opens new window)


# addChildAt

addChildAt(child, index): Stage

# Parameters

Name Type
child Layer
index number

# Returns

Stage

# Inherited from

Layer.addChildAt

# Defined in

display/Layer.ts:235 (opens new window)


# createResourceManager

createResourceManager(list, options?): ResourceManager

# Parameters

Name Type
list ResourceInfo[]
options? ResourceManagerOption

# Returns

ResourceManager

# Defined in

display/Stage.ts:131 (opens new window)


# emit

emit(event): boolean

# Parameters

Name Type
event Event

# Returns

boolean

# Inherited from

Layer.emit

# Defined in

event/EventEmitter.ts:42 (opens new window)

emit(type, ...args): boolean

# Parameters

Name Type
type string
...args any[]

# Returns

boolean

# Inherited from

Layer.emit

# Defined in

event/EventEmitter.ts:43 (opens new window)


# getChildAt

getChildAt(index): Layer

# Parameters

Name Type
index number

# Returns

Layer

# Inherited from

Layer.getChildAt

# Defined in

display/Layer.ts:277 (opens new window)


# getChildByName

getChildByName(name): Layer

# Parameters

Name Type
name string

# Returns

Layer

# Inherited from

Layer.getChildByName

# Defined in

display/Layer.ts:256 (opens new window)


# getChildIndex

getChildIndex(child): number

# Parameters

Name Type
child Layer

# Returns

number

# Inherited from

Layer.getChildIndex

# Defined in

display/Layer.ts:281 (opens new window)


# getChildrenByTag

getChildrenByTag(tag): Layer[]

# Parameters

Name Type
tag string

# Returns

Layer[]

# Inherited from

Layer.getChildrenByTag

# Defined in

display/Layer.ts:266 (opens new window)


# hasChild

hasChild(child): boolean

# Parameters

Name Type
child Layer

# Returns

boolean

# Inherited from

Layer.hasChild

# Defined in

display/Layer.ts:285 (opens new window)


# hasEventListener

hasEventListener(type): boolean

# Parameters

Name Type
type string

# Returns

boolean

# Inherited from

Layer.hasEventListener

# Defined in

event/EventEmitter.ts:80 (opens new window)


# off

off(type, listener?): Stage

# Parameters

Name Type
type string
listener? (...args: any[]) => void

# Returns

Stage

# Inherited from

Layer.off

# Defined in

display/Layer.ts:684 (opens new window)


# on

on(type, listener): Stage

# Parameters

Name Type
type string
listener (...args: any[]) => void

# Returns

Stage

# Inherited from

Layer.on

# Defined in

display/Layer.ts:668 (opens new window)


# once

once(type, listener): Stage

# Parameters

Name Type
type string
listener Listener

# Returns

Stage

# Inherited from

Layer.once

# Defined in

event/EventEmitter.ts:33 (opens new window)


# removeAllChildren

removeAllChildren(): Stage

# Returns

Stage

# Inherited from

Layer.removeAllChildren

# Defined in

display/Layer.ts:372 (opens new window)


# removeAllListeners

removeAllListeners(): Stage

# Returns

Stage

# Inherited from

Layer.removeAllListeners

# Defined in

event/EventEmitter.ts:85 (opens new window)


# removeChild

removeChild(child): Stage

# Parameters

Name Type
child Layer

# Returns

Stage

# Inherited from

Layer.removeChild

# Defined in

display/Layer.ts:333 (opens new window)


# removeChildAt

removeChildAt(index): Stage

# Parameters

Name Type
index number

# Returns

Stage

# Inherited from

Layer.removeChildAt

# Defined in

display/Layer.ts:338 (opens new window)


# removeChildByName

removeChildByName(name): Stage

# Parameters

Name Type
name string

# Returns

Stage

# Inherited from

Layer.removeChildByName

# Defined in

display/Layer.ts:349 (opens new window)


# removeChildrenByTag

removeChildrenByTag(tag): Stage

# Parameters

Name Type
tag string

# Returns

Stage

# Inherited from

Layer.removeChildrenByTag

# Defined in

display/Layer.ts:361 (opens new window)


# removeSelf

removeSelf(): Stage

# Returns

Stage

# Overrides

Layer.removeSelf

# Defined in

display/Stage.ts:135 (opens new window)


# replaceChild

replaceChild(oldChild, newChild): Stage

# Parameters

Name Type
oldChild Layer
newChild Layer

# Returns

Stage

# Inherited from

Layer.replaceChild

# Defined in

display/Layer.ts:249 (opens new window)


# setChildIndex

setChildIndex(child, index): Stage

# Parameters

Name Type
child Layer
index number

# Returns

Stage

# Inherited from

Layer.setChildIndex

# Defined in

display/Layer.ts:309 (opens new window)


# swapChildren

swapChildren(child1, child2): Stage

# Parameters

Name Type
child1 Layer
child2 Layer

# Returns

Stage

# Inherited from

Layer.swapChildren

# Defined in

display/Layer.ts:289 (opens new window)


# swapChildrenAt

swapChildrenAt(index1, index2): Stage

# Parameters

Name Type
index1 number
index2 number

# Returns

Stage

# Inherited from

Layer.swapChildrenAt

# Defined in

display/Layer.ts:298 (opens new window)