AutoScroller
Members
isActive
autoScroller.isActive : boolean
Whether any axis is currently scrolling.
isHorizontalActive
autoScroller.isHorizontalActive : boolean
Whether the horizontal axis is currently scrolling.
isVerticalActive
autoScroller.isVerticalActive : boolean
Whether the vertical axis is currently scrolling.
Methods
configure
autoScroller.configure(settings)
Configures scroll timing settings for both axes.
| Param | Type | Description |
|---|---|---|
| settings | object | Scroll settings. |
| settings.intervalRange | object | Interval range in milliseconds. |
| settings.intervalRange.min | object | Minimum interval in milliseconds. |
| settings.intervalRange.max | object | Maximum interval in milliseconds. |
| settings.rampDistance | number | Distance at which interval reaches minimum. |
destroy
autoScroller.destroy()
Destroys the scroll looper.
stop
autoScroller.stop()
Stops all scrolling.
stopHorizontal
autoScroller.stopHorizontal()
Stops the horizontal axis scrolling only.
stopVertical
autoScroller.stopVertical()
Stops the vertical axis scrolling only.
update
autoScroller.update(overflow)
Updates scroll state based on cursor overflow from viewport boundaries.
| Param | Type | Description |
|---|---|---|
| overflow | Object | Distance past viewport edges (0 = inside, N >0 |