ScrollSync

Handles piped in mousewheel events. Emits 'start', 'update', and 'end' events with payloads including: delta: change since last position, position: accumulated deltas, velocity: speed of change in pixels per ms, slip: true (unused). Can be used as delegate of GenericSync.

Overview

Options
direction
minimumEndSpeed
rails
scale
stallTime
Methods
getOptions
setOptions

ScrollSync(options)

Constructor Parameters

options

Object

overrides of default options

direction
Number
Pay attention to x changes (ScrollSync.DIRECTION_X), y changes (ScrollSync.DIRECTION_Y) or both (undefined)
minimumEndSpeed
Number
End speed calculation floors at this number, in pixels per ms
rails
Boolean
whether to snap position calculations to nearest axis
scale
Number | Array.Number
scale outputs in by scalar or pair of scalars
stallTime
Number
reset time for velocity calculation in ms
Methods

getOptions()

Return entire options dictionary, including defaults.

Returns
Object
configuration options

setOptions(options)

Set internal options, overriding any default options

Parameters
options
Object
overrides of default options