API Reference / Layer
# Class: Layer
# Hierarchy
-
↳
Layer
# Table of contents
# Constructors
# Properties
- $alpha
- $anchorX
- $anchorY
- $background
- $canvas
- $children
- $context
- $dirty
- $emittingType
- $events
- $height
- $parent
- $removedListeners
- $rotation
- $scaleX
- $scaleY
- $shouldEmitTap
- $skewX
- $skewY
- $smoothing
- $stage
- $touches
- $visible
- $width
- $x
- $y
- name
- tag
- touchable
- pixelRatio
# Accessors
- alpha
- anchorX
- anchorY
- background
- canvas
- height
- numChildren
- parent
- rotation
- scaleX
- scaleY
- skewX
- skewY
- smoothing
- stage
- ticker
- visible
- width
- x
- y
# Methods
- $drawChild
- $emitAdded
- $emitAddedToStage
- $emitRemoved
- $emitRemovedFromStage
- $emitTouchEvent
- $getChildBounds
- $getChildTransform
- $getContentBounds
- $getTransform
- $isChildVisible
- $localHitTest
- $markDirty
- $markParentDirty
- $render
- $resizeCanvas
- $resizeParentCanvas
- 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 Layer()
# Overrides
# Defined in
display/Layer.ts:42 (opens new window)
# Properties
# $alpha
• Protected
$alpha: number
= 1
# Defined in
display/Layer.ts:29 (opens new window)
# $anchorX
• Protected
$anchorX: number
= 0
# Defined in
display/Layer.ts:22 (opens new window)
# $anchorY
• Protected
$anchorY: number
= 0
# Defined in
display/Layer.ts:23 (opens new window)
# $background
• Protected
$background: string
= null
# Defined in
display/Layer.ts:32 (opens new window)
# $canvas
• Protected
Readonly
$canvas: HTMLCanvasElement
# Defined in
display/Layer.ts:39 (opens new window)
# $children
• Protected
$children: Layer
[] = []
# Defined in
display/Layer.ts:35 (opens new window)
# $context
• Protected
Readonly
$context: CanvasRenderingContext2D
# Defined in
display/Layer.ts:40 (opens new window)
# $dirty
• Protected
$dirty: boolean
= true
# 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)
# $height
• Protected
$height: number
= 0
# Defined in
display/Layer.ts:21 (opens new window)
# $parent
• Protected
$parent: Layer
= null
# Defined in
display/Layer.ts:34 (opens new window)
# $removedListeners
• Protected
$removedListeners: Listener
[] = []
# Inherited from
EventEmitter.$removedListeners
# Defined in
event/EventEmitter.ts:7 (opens new window)
# $rotation
• Protected
$rotation: number
= 0
# Defined in
display/Layer.ts:28 (opens new window)
# $scaleX
• Protected
$scaleX: number
= 1
# Defined in
display/Layer.ts:26 (opens new window)
# $scaleY
• Protected
$scaleY: number
= 1
# Defined in
display/Layer.ts:27 (opens new window)
# $shouldEmitTap
• Protected
$shouldEmitTap: boolean
= true
# Defined in
display/Layer.ts:37 (opens new window)
# $skewX
• Protected
$skewX: number
= 0
# Defined in
display/Layer.ts:24 (opens new window)
# $skewY
• Protected
$skewY: number
= 0
# Defined in
display/Layer.ts:25 (opens new window)
# $smoothing
• Protected
$smoothing: boolean
= true
# Defined in
display/Layer.ts:31 (opens new window)
# $stage
• Protected
$stage: Stage
= null
# Defined in
display/Layer.ts:33 (opens new window)
# $touches
• Protected
$touches: boolean
[] = []
# Defined in
display/Layer.ts:38 (opens new window)
# $visible
• Protected
$visible: boolean
= true
# Defined in
display/Layer.ts:30 (opens new window)
# $width
• Protected
$width: number
= 0
# Defined in
display/Layer.ts:20 (opens new window)
# $x
• Protected
$x: number
= 0
# Defined in
display/Layer.ts:18 (opens new window)
# $y
• Protected
$y: number
= 0
# Defined in
display/Layer.ts:19 (opens new window)
# name
• name: string
= ''
# Defined in
display/Layer.ts:14 (opens new window)
# tag
• tag: string
= ''
# Defined in
display/Layer.ts:15 (opens new window)
# touchable
• touchable: boolean
= true
# Defined in
display/Layer.ts:16 (opens new window)
# pixelRatio
▪ Static
pixelRatio: number
# Defined in
display/Layer.ts:12 (opens new window)
# Accessors
# alpha
• get
alpha(): number
# Returns
number
# Defined in
display/Layer.ts:169 (opens new window)
• set
alpha(alpha
): void
# Parameters
Name | Type |
---|---|
alpha | number |
# Returns
void
# Defined in
display/Layer.ts:173 (opens new window)
# anchorX
• get
anchorX(): number
# Returns
number
# Defined in
display/Layer.ts:92 (opens new window)
• set
anchorX(anchorX
): void
# Parameters
Name | Type |
---|---|
anchorX | number |
# Returns
void
# Defined in
display/Layer.ts:96 (opens new window)
# anchorY
• get
anchorY(): number
# Returns
number
# Defined in
display/Layer.ts:103 (opens new window)
• set
anchorY(anchorY
): void
# Parameters
Name | Type |
---|---|
anchorY | number |
# Returns
void
# Defined in
display/Layer.ts:107 (opens new window)
# background
• get
background(): string
# Returns
string
# Defined in
display/Layer.ts:200 (opens new window)
• set
background(background
): void
# Parameters
Name | Type |
---|---|
background | string |
# Returns
void
# Defined in
display/Layer.ts:204 (opens new window)
# canvas
• get
canvas(): HTMLCanvasElement
# Returns
HTMLCanvasElement
# Defined in
display/Layer.ts:227 (opens new window)
# height
• get
height(): number
# Returns
number
# Defined in
display/Layer.ts:81 (opens new window)
• set
height(height
): void
# Parameters
Name | Type |
---|---|
height | number |
# Returns
void
# Defined in
display/Layer.ts:85 (opens new window)
# numChildren
• get
numChildren(): number
# Returns
number
# Defined in
display/Layer.ts:219 (opens new window)
# parent
• get
parent(): Layer
# Returns
# Defined in
display/Layer.ts:215 (opens new window)
# rotation
• get
rotation(): number
# Returns
number
# Defined in
display/Layer.ts:158 (opens new window)
• set
rotation(rotation
): void
# Parameters
Name | Type |
---|---|
rotation | number |
# Returns
void
# Defined in
display/Layer.ts:162 (opens new window)
# scaleX
• get
scaleX(): number
# Returns
number
# Defined in
display/Layer.ts:136 (opens new window)
• set
scaleX(scaleX
): void
# Parameters
Name | Type |
---|---|
scaleX | number |
# Returns
void
# Defined in
display/Layer.ts:140 (opens new window)
# scaleY
• get
scaleY(): number
# Returns
number
# Defined in
display/Layer.ts:147 (opens new window)
• set
scaleY(scaleY
): void
# Parameters
Name | Type |
---|---|
scaleY | number |
# Returns
void
# Defined in
display/Layer.ts:151 (opens new window)
# skewX
• get
skewX(): number
# Returns
number
# Defined in
display/Layer.ts:114 (opens new window)
• set
skewX(skewX
): void
# Parameters
Name | Type |
---|---|
skewX | number |
# Returns
void
# Defined in
display/Layer.ts:118 (opens new window)
# skewY
• get
skewY(): number
# Returns
number
# Defined in
display/Layer.ts:125 (opens new window)
• set
skewY(skewY
): void
# Parameters
Name | Type |
---|---|
skewY | number |
# Returns
void
# Defined in
display/Layer.ts:129 (opens new window)
# smoothing
• get
smoothing(): boolean
# Returns
boolean
# Defined in
display/Layer.ts:191 (opens new window)
• set
smoothing(smoothing
): void
# Parameters
Name | Type |
---|---|
smoothing | boolean |
# Returns
void
# Defined in
display/Layer.ts:195 (opens new window)
# stage
• get
stage(): Stage
# Returns
# Defined in
display/Layer.ts:211 (opens new window)
# ticker
• get
ticker(): Ticker
# Returns
# Defined in
display/Layer.ts:223 (opens new window)
# visible
• get
visible(): boolean
# Returns
boolean
# Defined in
display/Layer.ts:180 (opens new window)
• set
visible(visible
): void
# Parameters
Name | Type |
---|---|
visible | boolean |
# Returns
void
# Defined in
display/Layer.ts:184 (opens new window)
# width
• get
width(): number
# Returns
number
# Defined in
display/Layer.ts:70 (opens new window)
• set
width(width
): void
# Parameters
Name | Type |
---|---|
width | number |
# Returns
void
# Defined in
display/Layer.ts:74 (opens new window)
# x
• get
x(): number
# Returns
number
# Defined in
display/Layer.ts:48 (opens new window)
• set
x(x
): void
# Parameters
Name | Type |
---|---|
x | number |
# Returns
void
# Defined in
display/Layer.ts:52 (opens new window)
# y
• get
y(): number
# Returns
number
# Defined in
display/Layer.ts:59 (opens new window)
• set
y(y
): void
# Parameters
Name | Type |
---|---|
y | number |
# Returns
void
# Defined in
display/Layer.ts:63 (opens new window)
# Methods
# $drawChild
▸ Protected
$drawChild(child
): number
# Parameters
Name | Type |
---|---|
child | Layer |
# Returns
number
# Defined in
display/Layer.ts:605 (opens new window)
# $emitAdded
▸ Protected
$emitAdded(parent
): void
# Parameters
Name | Type |
---|---|
parent | Layer |
# Returns
void
# Defined in
display/Layer.ts:543 (opens new window)
# $emitAddedToStage
▸ Protected
$emitAddedToStage(stage
): void
# Parameters
Name | Type |
---|---|
stage | Stage |
# Returns
void
# Defined in
display/Layer.ts:561 (opens new window)
# $emitRemoved
▸ Protected
$emitRemoved(): void
# Returns
void
# Defined in
display/Layer.ts:552 (opens new window)
# $emitRemovedFromStage
▸ Protected
$emitRemovedFromStage(): void
# Returns
void
# Defined in
display/Layer.ts:574 (opens new window)
# $emitTouchEvent
▸ Protected
$emitTouchEvent(event
, inside
): boolean
# Parameters
Name | Type |
---|---|
event | TouchEvent |
inside | boolean |
# Returns
boolean
# Defined in
display/Layer.ts:495 (opens new window)
# $getChildBounds
▸ Protected
$getChildBounds(child
): Rectangle
# Parameters
Name | Type |
---|---|
child | Layer |
# Returns
# Defined in
display/Layer.ts:449 (opens new window)
# $getChildTransform
▸ Protected
$getChildTransform(child
): Matrix
# Parameters
Name | Type |
---|---|
child | Layer |
# Returns
# Defined in
display/Layer.ts:445 (opens new window)
# $getContentBounds
▸ Protected
$getContentBounds(): Rectangle
# Returns
# Defined in
display/Layer.ts:474 (opens new window)
# $getTransform
▸ Protected
$getTransform(): Matrix
# Returns
# Defined in
display/Layer.ts:434 (opens new window)
# $isChildVisible
▸ Protected
$isChildVisible(child
): boolean
# Parameters
Name | Type |
---|---|
child | Layer |
# Returns
boolean
# Defined in
display/Layer.ts:591 (opens new window)
# $localHitTest
▸ Protected
$localHitTest(vector
): boolean
# Parameters
Name | Type |
---|---|
vector | Vector |
# Returns
boolean
# Defined in
display/Layer.ts:587 (opens new window)
# $markDirty
▸ Protected
$markDirty(sizeDirty?
): void
# Parameters
Name | Type |
---|---|
sizeDirty? | boolean |
# Returns
void
# Defined in
display/Layer.ts:389 (opens new window)
# $markParentDirty
▸ Protected
$markParentDirty(): void
# Returns
void
# Defined in
display/Layer.ts:398 (opens new window)
# $render
▸ Protected
$render(): number
# Returns
number
# Defined in
display/Layer.ts:636 (opens new window)
# $resizeCanvas
▸ Protected
$resizeCanvas(): void
# Returns
void
# Defined in
display/Layer.ts:404 (opens new window)
# $resizeParentCanvas
▸ Protected
$resizeParentCanvas(): void
# Returns
void
# Defined in
display/Layer.ts:428 (opens new window)
# addChild
▸ addChild(child
): Layer
# Parameters
Name | Type |
---|---|
child | Layer |
# Returns
# Defined in
display/Layer.ts:231 (opens new window)
# addChildAt
▸ addChildAt(child
, index
): Layer
# Parameters
Name | Type |
---|---|
child | Layer |
index | number |
# Returns
# 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
# Defined in
display/Layer.ts:277 (opens new window)
# getChildByName
▸ getChildByName(name
): Layer
# Parameters
Name | Type |
---|---|
name | string |
# Returns
# Defined in
display/Layer.ts:256 (opens new window)
# getChildIndex
▸ getChildIndex(child
): number
# Parameters
Name | Type |
---|---|
child | Layer |
# Returns
number
# Defined in
display/Layer.ts:281 (opens new window)
# getChildrenByTag
▸ getChildrenByTag(tag
): Layer
[]
# Parameters
Name | Type |
---|---|
tag | string |
# Returns
Layer
[]
# Defined in
display/Layer.ts:266 (opens new window)
# hasChild
▸ hasChild(child
): boolean
# Parameters
Name | Type |
---|---|
child | Layer |
# Returns
boolean
# 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?
): Layer
# Parameters
Name | Type |
---|---|
type | string |
listener? | (...args : any []) => void |
# Returns
# Overrides
# Defined in
display/Layer.ts:684 (opens new window)
# on
▸ on(type
, listener
): Layer
# Parameters
Name | Type |
---|---|
type | string |
listener | (...args : any []) => void |
# Returns
# Overrides
# Defined in
display/Layer.ts:668 (opens new window)
# once
▸ once(type
, listener
): Layer
# Parameters
Name | Type |
---|---|
type | string |
listener | Listener |
# Returns
# Inherited from
# Defined in
event/EventEmitter.ts:33 (opens new window)
# removeAllChildren
▸ removeAllChildren(): Layer
# Returns
# Defined in
display/Layer.ts:372 (opens new window)
# removeAllListeners
▸ removeAllListeners(): Layer
# Returns
# Inherited from
EventEmitter.removeAllListeners
# Defined in
event/EventEmitter.ts:85 (opens new window)
# removeChild
▸ removeChild(child
): Layer
# Parameters
Name | Type |
---|---|
child | Layer |
# Returns
# Defined in
display/Layer.ts:333 (opens new window)
# removeChildAt
▸ removeChildAt(index
): Layer
# Parameters
Name | Type |
---|---|
index | number |
# Returns
# Defined in
display/Layer.ts:338 (opens new window)
# removeChildByName
▸ removeChildByName(name
): Layer
# Parameters
Name | Type |
---|---|
name | string |
# Returns
# Defined in
display/Layer.ts:349 (opens new window)
# removeChildrenByTag
▸ removeChildrenByTag(tag
): Layer
# Parameters
Name | Type |
---|---|
tag | string |
# Returns
# Defined in
display/Layer.ts:361 (opens new window)
# removeSelf
▸ removeSelf(): Layer
# Returns
# Defined in
display/Layer.ts:382 (opens new window)
# replaceChild
▸ replaceChild(oldChild
, newChild
): Layer
# Parameters
Name | Type |
---|---|
oldChild | Layer |
newChild | Layer |
# Returns
# Defined in
display/Layer.ts:249 (opens new window)
# setChildIndex
▸ setChildIndex(child
, index
): Layer
# Parameters
Name | Type |
---|---|
child | Layer |
index | number |
# Returns
# Defined in
display/Layer.ts:309 (opens new window)
# swapChildren
▸ swapChildren(child1
, child2
): Layer
# Parameters
Name | Type |
---|---|
child1 | Layer |
child2 | Layer |
# Returns
# Defined in
display/Layer.ts:289 (opens new window)
# swapChildrenAt
▸ swapChildrenAt(index1
, index2
): Layer
# Parameters
Name | Type |
---|---|
index1 | number |
index2 | number |