Filter - Documentation

new Filter()

A filter provides a chart with an interface to the data. The filter contains a number of Partitions and Aggregates. It takes care of calling the relevant functions provided by a Dataset.

Basic usage for a Chart is:

The chart renders using Filter.data if available
It can add or remove partitions and aggregates to the filter
It calls Filter.updateSelection(..) when the user makes a selection
To apply the new selection, and also filter the other charts, the chart calls Filter.updateDataFilter()
The charts redraws on 'newData' events on the filter

The filter does the following:

It adds or removes paritions and aggregates on request
When it has the right number of partitions and aggregates, Filter.isConfigured becomes true and Filter.initDataFilter() is called
This in turn creates a Filter.getData function
As the new filter could affect all plots Dataset.getAllData called

Filter.getData does the following:

It arranges for the Filter.data array to be filled
A newData event is triggerd, and the chart's callback function is executed

Source:

models/filter.js, line 1

Extends

Base

Members

(static) aggregates :Array.<Aggregate>

Type:

Array.<Aggregate>

Source:

models/filter.js, line 77

(static) data :Data

Array containing the data to plot

Type:

Data

Source:

models/filter.js, line 87

(static) partitions :Array.<Partitions>

Type:

Array.<Partitions>

Source:

models/filter.js, line 72

(static) title :string

Title for displaying purposes

Type:

string

Source:

models/filter.js, line 65

Methods

(abstract, static) getData()

Call this function to request new data. The dataset backing the facet will copy the data to Filter.data. A newData event is fired when the data is ready to be plotted.

Source: