Class CssParallaxer

Hierarchy

CssParallaxer

Implements

EventDispatcher

Index

Constructors

constructor

Methods

Constructors

constructor

new CssParallaxer(element: HTMLElement): CssParallaxer

- Defined in dom/css-parallaxer.ts:315
Parameters
- element: HTMLElement
Returns CssParallaxer

Methods

dispose

dispose(): void

- Defined in dom/css-parallaxer.ts:726
Returns void

getElementProgressPoint

getElementProgressPoint(targetElement: HTMLElement, baseline?: number): number

- Defined in dom/css-parallaxer.ts:711
Parameters
- targetElement: HTMLElement
- Default value baseline: number = 0
Returns number

getInterpolator

getInterpolator(): CssVarInterpolate

- Defined in dom/css-parallaxer.ts:469
Returns CssVarInterpolate

getProgress

getProgress(): number

- Defined in dom/css-parallaxer.ts:618
Returns number

getRaf

getRaf(): Raf

- Defined in dom/css-parallaxer.ts:722
Returns Raf

getSettings

getSettings(): CssParallaxSettings | null

- Defined in dom/css-parallaxer.ts:442
Returns CssParallaxSettings | null

init

init(settings: CssParallaxSettings, interpolations: Array<interpolateSettings>): void

- Defined in dom/css-parallaxer.ts:345
Parameters
- Optional settings: CssParallaxSettings
- Optional interpolations: Array<interpolateSettings>
Returns void

off

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

- Defined in dom/css-parallaxer.ts:336
Parameters
- event: string
- callback: EventCallback
Returns void

on

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

- Defined in dom/css-parallaxer.ts:332
Parameters
- event: string
- callback: EventCallback
Returns void

setManualProgress

setManualProgress(progress: number): void

- Defined in dom/css-parallaxer.ts:640
Parameters
- progress: number
Returns void

updateImmediately

updateImmediately(): void

- Defined in dom/css-parallaxer.ts:533
Returns void

updateInterpolations

updateInterpolations(interpolations: Array<interpolateSettings>): void

- Defined in dom/css-parallaxer.ts:361
Parameters
- interpolations: Array<interpolateSettings>
Returns void

updateProgress

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

- Defined in dom/css-parallaxer.ts:476
Parameters
- lerp: number
- damp: number
Returns number

updateSettings

updateSettings(settings: CssParallaxSettings): void

- Defined in dom/css-parallaxer.ts:403
Parameters
- Optional settings: CssParallaxSettings
Returns void