Class ScrollMask

Fixed window view with internally scrollable container.

Hierarchy

Container
- ScrollMask

Index

Constructors

Accessors

scrollX scrollY

Methods

addScrollableChild scrollToPosition

Constructors

constructor

new ScrollMask(scrollBoxOptions?: ScrollBoxOptions): ScrollMask
Parameters
- OptionalscrollBoxOptions: ScrollBoxOptions
Returns ScrollMask
Overrides Container.constructor
- Defined in index.ts:11

Accessors

scrollX

get scrollX(): number
Current scroll on the x-axis

Returns number
- Defined in index.ts:36
set scrollX(val: number): void
Current scroll on the x-axis
Parameters
- val: number
Returns void
- Defined in index.ts:41

scrollY

get scrollY(): number
Current scroll on the y-axis

Returns number
- Defined in index.ts:26
set scrollY(val: number): void
Current scroll on the y-axis
Parameters
- val: number
Returns void
- Defined in index.ts:31

Methods

addScrollableChild

addScrollableChild<U extends (ContainerChild | IRenderLayer)[]>(
...children: U,
): U[0]
Type Parameters
- U extends (ContainerChild | IRenderLayer)[]
Parameters
- ...children: U
Returns U[0]
- Defined in index.ts:18

scrollToPosition

scrollToPosition(position: Partial<PointData>): void
Scrolls to the given position.
Parameters
- position: Partial<PointData>
  x and y position object.
  - x
    x position.
  - y
    y position.
Returns void
- Defined in index.ts:51