API Reference / Scroller

# Class: Scroller

# Hierarchy

Layer

↳ Scroller

# Table of contents

# Constructors

constructor

# Properties

# Accessors

# Methods

# Constructors

# constructor

• new Scroller()

# Overrides

Layer.constructor

# Defined in

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

# Properties

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

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

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

# $inertiaTween

• Protected $inertiaTween: Tween = null

# Defined in

display/Scroller.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)

# $rotation

• Protected $rotation: number = 0

# Inherited from

Layer.$rotation

# Defined in

display/Layer.ts:28 (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)

# $scrollHeight

• Protected $scrollHeight: number = 0

# Defined in

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

# $scrollLeft

• Protected $scrollLeft: number = 0

# Defined in

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

# $scrollTop

• Protected $scrollTop: number = 0

# Defined in

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

# $scrollWidth

• Protected $scrollWidth: number = 0

# Defined in

display/Scroller.ts:13 (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)

# $touches

• Protected $touches: boolean[] = []

# Inherited from

Layer.$touches

# Defined in

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

# $touchingId

• Protected $touchingId: number = null

# Defined in

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

# $touchingTime

• Protected $touchingTime: number = null

# Defined in

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

# $touchingX

• Protected $touchingX: number = null

# Defined in

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

# $touchingY

• Protected $touchingY: number = null

# Defined in

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

# $velocitiesX

• Protected $velocitiesX: number[] = []

# Defined in

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

# $velocitiesY

• Protected $velocitiesY: number[] = []

# Defined in

display/Scroller.ts:20 (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)

# pixelRatio

▪ Static pixelRatio: number

# Inherited from

Layer.pixelRatio

# Defined in

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

# scrollingView

▪ Static Protected scrollingView: Scroller

# Defined in

display/Scroller.ts:9 (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)

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

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

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

# scrollHeight

• get scrollHeight(): number

# Returns

number

# Defined in

display/Scroller.ts:67 (opens new window)

# scrollLeft

• get scrollLeft(): number

# Returns

number

# Defined in

display/Scroller.ts:48 (opens new window)

• set scrollLeft(scrollLeft): void

# Parameters

Name	Type
`scrollLeft`	`number`

# Returns

void

# Defined in

display/Scroller.ts:52 (opens new window)

# scrollTop

• get scrollTop(): number

# Returns

number

# Defined in

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

• set scrollTop(scrollTop): void

# Parameters

Name	Type
`scrollTop`	`number`

# Returns

void

# Defined in

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

# scrollWidth

• get scrollWidth(): number

# Returns

number

# Defined in

display/Scroller.ts:63 (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

# Inherited from

Layer.ticker

# Defined in

display/Layer.ts:223 (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

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

# Overrides

Layer.$emitRemovedFromStage

# Defined in

display/Scroller.ts:170 (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`

# $getChildTransform

▸ Protected $getChildTransform(child): Matrix

# Parameters

Name	Type
`child`	`Layer`

# Returns

Matrix

# Overrides

Layer.$getChildTransform

# Defined in

display/Scroller.ts:71 (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)

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

# $onTouchCancel

▸ Protected $onTouchCancel(e): void

# Parameters

Name	Type
`e`	`TouchEvent`

# Returns

void

# Defined in

display/Scroller.ts:164 (opens new window)

# $onTouchEnd

▸ Protected $onTouchEnd(e): void

# Parameters

Name	Type
`e`	`TouchEvent`

# Returns

void

# Defined in

display/Scroller.ts:130 (opens new window)

# $onTouchMove

▸ Protected $onTouchMove(e): void

# Parameters

Name	Type
`e`	`TouchEvent`

# Returns

void

# Defined in

display/Scroller.ts:99 (opens new window)

# $onTouchStart

▸ Protected $onTouchStart(e): void

# Parameters

Name	Type
`e`	`TouchEvent`

# Returns

void

# Defined in

display/Scroller.ts:86 (opens new window)

# $render

▸ Protected $render(): number

# Returns

number

# Inherited from

Layer.$render

# Defined in

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

# $resizeCanvas

▸ Protected $resizeCanvas(): void

# Returns

void

# Overrides

Layer.$resizeCanvas

# Defined in

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

# $resizeParentCanvas

▸ Protected $resizeParentCanvas(): void

# Returns

void

# Inherited from

Layer.$resizeParentCanvas

# Defined in

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

# addChild

▸ addChild(child): Scroller

# Parameters

Name	Type
`child`	`Layer`

# Returns

Scroller

# Inherited from

Layer.addChild

# Defined in

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

# addChildAt

▸ addChildAt(child, index): Scroller

# Parameters

Name	Type
`child`	`Layer`
`index`	`number`

# Returns

Scroller

# Inherited from

Layer.addChildAt

# Defined in

display/Layer.ts:235 (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?): Scroller

# Parameters

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

# Returns

Scroller

# Inherited from

Layer.off

# Defined in

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

# on

▸ on(type, listener): Scroller

# Parameters

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

# Returns

Scroller

# Inherited from

Layer.on

# Defined in

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

# once

▸ once(type, listener): Scroller

# Parameters

Name	Type
`type`	`string`
`listener`	`Listener`

# Returns

Scroller

# Inherited from

Layer.once

# Defined in

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

# removeAllChildren

▸ removeAllChildren(): Scroller

# Returns

Scroller

# Inherited from

Layer.removeAllChildren

# Defined in

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

# removeAllListeners

▸ removeAllListeners(): Scroller

# Returns

Scroller

# Inherited from

Layer.removeAllListeners

# Defined in

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

# removeChild

▸ removeChild(child): Scroller

# Parameters

Name	Type
`child`	`Layer`

# Returns

Scroller

# Inherited from

Layer.removeChild

# Defined in

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

# removeChildAt

▸ removeChildAt(index): Scroller

# Parameters

Name	Type
`index`	`number`

# Returns

Scroller

# Inherited from

Layer.removeChildAt

# Defined in

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

# removeChildByName

▸ removeChildByName(name): Scroller

# Parameters

Name	Type
`name`	`string`

# Returns

Scroller

# Inherited from

Layer.removeChildByName

# Defined in

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

# removeChildrenByTag

▸ removeChildrenByTag(tag): Scroller

# Parameters

Name	Type
`tag`	`string`

# Returns

Scroller

# Inherited from

Layer.removeChildrenByTag

# Defined in

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

# removeSelf

▸ removeSelf(): Scroller

# Returns

Scroller

# Inherited from

Layer.removeSelf

# Defined in

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

# replaceChild

▸ replaceChild(oldChild, newChild): Scroller

# Parameters

Name	Type
`oldChild`	`Layer`
`newChild`	`Layer`

# Returns

Scroller

# Inherited from

Layer.replaceChild

# Defined in

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

# setChildIndex

▸ setChildIndex(child, index): Scroller

# Parameters

Name	Type
`child`	`Layer`
`index`	`number`

# Returns

Scroller

# Inherited from

Layer.setChildIndex

# Defined in

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

# swapChildren

▸ swapChildren(child1, child2): Scroller

# Parameters

Name	Type
`child1`	`Layer`
`child2`	`Layer`

# Returns

Scroller

# Inherited from

Layer.swapChildren

# Defined in

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

# swapChildrenAt

▸ swapChildrenAt(index1, index2): Scroller

# Parameters

Name	Type
`index1`	`number`
`index2`	`number`

# Returns

Scroller

# Inherited from

Layer.swapChildrenAt

# Defined in

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