GenericSync

Combines multiple types of sync classes (e.g. mouse, touch, scrolling) into one standardized interface for inclusion in widgets. Sync classes are first registered with a key, and then can be accessed globally by key. Emits 'start', 'update' and 'end' events as a union of the sync class providers.

Overview

Options
Methods
register
setOptions
pipeSync
unpipeSync
addSync

GenericSync(syncs, options)

Constructor Parameters

syncs

Object|Array

object with fields {sync key : sync options} or an array of registered sync keys

options

Object|Array

options object to set on all syncs

Methods

register(syncObject)Static

Register a global sync class with an identifying key

Parameters
syncObject
Object
an object of {sync key : sync options} fields

setOptions(options)

Helper to set options on all sync instances

Parameters
options
Object
options object

pipeSync(key)

Pipe events to a sync class

Parameters
key
String
identifier for sync class

unpipeSync(key)

Unpipe events from a sync class

Parameters
key
String
identifier for sync class

addSync(syncs)

Add a sync class to from the registered classes

Parameters
syncs
Object|Array.String
an array of registered sync keys or an object with fields {sync key : sync options}