Class: Filter

Filter

new Filter()

TODO Filter is badly missing a correct documentation

Source:

Methods

cloneWithDelta(properties)

Create a clone of this filter and changes some properties

Parameters:
Name Type Description
properties
Source:
Returns:

pryv.Filter

compareToFilterData(filterDataTest)

Compare this filter with data form another filter

Parameters:
Name Type Description
filterDataTest Object

data got with filter.getData
Source:
Returns:

keymap { timeFrame : -1, 0 , 1 } (1 = more than test, -1 = less data than test, 0 == no changes)

focusedOnSingleStream()

return true if context (stream is on a single stream) This is usefull to check when creating and event in a context. This way, no need to ask the user for a stream specification. TODO determine if this should stay in the lib.. or handle by apps

Source:

getData(ignoreNulls, withDelta) → {*}

returns a dictionary containing all the settings of this filter.

Parameters:
Name Type Description
ignoreNulls

(optional) boolean
withDelta

(optional) adds this differences on the data
Source:
Returns:
Type
*

matchEvent()

TODO write doc TODO complete with tags and state and modified and.. check if this event is in this filter

Source:

set(keyValueMap, batch)

TODO review documentation and add example Change several values of the filter in batch.. this wil group all events behind a batch id

Parameters:
Name Type Description
keyValueMap Object
batch SignalEmitter~Batch
Source: