Skip to content

AutoScroller

Members

isActive

Source code

autoScroller.isActive : boolean

Whether any axis is currently scrolling.

isHorizontalActive

Source code

autoScroller.isHorizontalActive : boolean

Whether the horizontal axis is currently scrolling.

isVerticalActive

Source code

autoScroller.isVerticalActive : boolean

Whether the vertical axis is currently scrolling.

Methods

configure

Source code

autoScroller.configure(settings)

Configures scroll timing settings for both axes.

ParamTypeDescription
settingsobjectScroll settings.
settings.intervalRangeobjectInterval range in milliseconds.
settings.intervalRange.minobjectMinimum interval in milliseconds.
settings.intervalRange.maxobjectMaximum interval in milliseconds.
settings.rampDistancenumberDistance at which interval reaches minimum.

destroy

Source code

autoScroller.destroy()

Destroys the scroll looper.

stop

Source code

autoScroller.stop()

Stops all scrolling.

stopHorizontal

Source code

autoScroller.stopHorizontal()

Stops the horizontal axis scrolling only.

stopVertical

Source code

autoScroller.stopVertical()

Stops the vertical axis scrolling only.

update

Source code

autoScroller.update(overflow)

Updates scroll state based on cursor overflow from viewport boundaries.

ParamTypeDescription
overflowObjectDistance past viewport edges (0 = inside, N >0