Skip to content

ScrollTimer

Members

isActive

Source code

scrollTimer.isActive : boolean

Whether the timer is currently active.

Methods

configure

Source code

scrollTimer.configure(settings)

Configures the scroll timing settings.

ParamTypeDescription
settingsobjectTimer settings.
settings.intervalRangeobjectInterval range in ms.
settings.intervalRange.minnumberMinimum interval in ms.
settings.intervalRange.maxnumberMaximum interval in ms.
settings.rampDistancenumberDistance at which interval reaches minimum.

stop

Source code

scrollTimer.stop()

Stops the timer.

update

Source code

scrollTimer.update(distance)

Updates the timer state. Starts or stops based on distance value.

ParamTypeDescription
distancenumberDistance from viewport edge (0 = inside viewport, N > 0 = outside viewport).