Inputs.ScrollInput Class
Wrapper for DOM wheel/mousewheel events. Converts scroll
events
to start
, update
and end
events and emits them with the payload:
value
- Scroll displacement in pixels from start
delta
- Scroll differential in pixels between subsequent events
velocity
- Velocity of scroll
event
- Original DOM event
Constructor
Inputs.ScrollInput
(
-
[options]
Parameters:
Example:
var scrollInput = new ScrollInput();
scrollInput.subscribe(surface)
scrollInput.on('start', function(payload){
console.log('start', payload);
});
scrollInput.on('update', function(payload){
console.log('update', payload);
});
scrollInput.on('end', function(payload){
console.log('end', payload);
});
Methods
filter
(
SimpleStream
-
filterFn
Filter converts the current stream into a new stream
that only emits if the filter condition is satisfied.
The filter function should return a Boolean value.
Parameters:
-
filterFn
FunctionFunction to filter event payload
Returns:
SimpleStream:
stream Filtered stream
map
(
SimpleStream
-
mapperFn
Map converts the current stream into a new stream
with a modified (mapped) data payload.
Parameters:
-
mapperFn
FunctionFunction to map event payload
Returns:
SimpleStream:
stream Mapped stream
pluck
(
SimpleStream
-
key
Pluck is an opinionated mapper. It projects a Stream
onto one of its return values.
Useful if a Stream returns an array or object.
Returns:
SimpleStream:
stream Plucked stream
split
(
-
splitterFn
Split maps one of several streams based on custom logic.
The splitter function should return an EventEmitter type.
Parameters:
-
splitterFn
FunctionSplitter function