Class ScrollProgress

Hierarchy

ScrollProgress

Implements

EventDispatcher

Index

Constructors

constructor

Methods

Constructors

constructor

new ScrollProgress(element: HTMLElement): ScrollProgress

- Defined in dom/scroll-progress.ts:149
Parameters
- element: HTMLElement
Returns ScrollProgress

Methods

dispose

dispose(): void

- Defined in dom/scroll-progress.ts:359
Returns void

getProgress

getProgress(): number

- Defined in dom/scroll-progress.ts:355
Returns number

init

init(settings: ScrollProgressSettings): void

- Defined in dom/scroll-progress.ts:171
Parameters
- Optional settings: ScrollProgressSettings
Returns void

off

off(event: string, callback: EventCallback): void

- Defined in dom/scroll-progress.ts:216
Parameters
- event: string
- callback: EventCallback
Returns void

on

on(event: string, callback: EventCallback): void

- Defined in dom/scroll-progress.ts:212
Parameters
- event: string
- callback: EventCallback
Returns void

updateImmediately

updateImmediately(): void

- Defined in dom/scroll-progress.ts:303
Returns void

updateProgress

updateProgress(lerp: number, damp: number): number

- Defined in dom/scroll-progress.ts:251
Parameters
- lerp: number
- damp: number
Returns number

updateSettings

updateSettings(settings: ScrollProgressSettings): void

- Defined in dom/scroll-progress.ts:184
Parameters
- Optional settings: ScrollProgressSettings
Returns void