Data controller for lotivis.js.
let data = [
{ label: "label-1", location: "paris", date: "1999-01-01", value: 1 },
{ label: "label-1", location: "paris", date: "1999-01-02", value: 2 },
{ label: "label-1", location: "berlin", date: "1999-01-03", value: 3 },
];
let dataController = lotivis.dataController(data);
// append data controller to charts ...
If you use npm, npm install lotivis-data
. You can also download the latest realease on GitHub. For using in browsers, you can load the UMD bundle from an npm-based CDN such as jsDelivr.
<script src="https://cdn.jsdelivr.net/..."></script>
<script>
let dataController = lotivis.dataController();
</script>
dataController.id()
Returns the controllers id.
dataController.data(_)
Gets or sets the controllers data.
dataController.snapshot()
Returns the current snapshot from the filtered data.
Call with specifying a name
will return the corresponding array.
dataController.onFilterWillChange(name, callback)
Adds a listener with the passed name for filter-will-change
events.
dataController.onFilterDidChange(name, callback)
Adds a listener with the passed name for filter-did-change
events.
dataController.onDataWillChange(name, callback)
Adds a listener with the passed name for data-will-change
events.
dataController.onDataDidChange(name, callback)
Adds a listener with the passed name for data-did-change
events.
dataController.removeAllListeners()
Removes all callbacks.
dataController.filters(name?)
Gets the controllers filters. Calling without specifying a name
will return the following presented filters object.
// available filters
{
labels: [],
locations: [],
dates: [],
groups: []
}
dataController.hasFilters(name?)
Returns a Boolean value indicating whether the controller contains any filters.
var anyFilters = dataController.hasFilters();
var dateFilters = dataController.hasFilters("dates");
dataController.clearFilters(sender, name?)
Clears the filters of the controller.
// clear all filters
dataController.clearFilters(someChart);
// clear date filters
dataController.clearFilters(someChart, "dates");
dataController.isFilter(name, item)
Returns a Boolean value indicating whether the specified item is included in the specified filters list.
dataController.addFilter(name, item, sender)
Adds the specified item
to the specified filters list.
dataController.removeFilter(name, item, sender)
Removes the specified item
from the collection of filters with the specified name
.
dataController.toggleFilter(name, item, sender)
Toggles the filtered state of the passed item in the collection of filters with the passed name.
dataController.filename(extension, prefix)
Generates and returns a filename from the data with the passed extension
and prefix
.
data.sum
Holds the sum of all values.
data.max
Holds the maximum value.
data.min
Holds the minimum value.
data.labels
Holds an array of all labels found in the data.
data.locations
Holds an array of all locations found in the data.
data.dates
Holds an array of all dates found in the data.
data.groups
Holds an array of all groups found in the data.
data.byLabel
Holds an InternMap mapping label to data.
data.byLocation
Holds an InternMap mapping location to data.
data.byDate
Holds an InternMap mapping date to data.
data.byGroup
Holds an InternMap mapping group to data.
data.filterValid()
Returns an array containing only data with valid values.
data.dataByLabel(label)
Returns an array containing only data for the specified label
.
data.dataByLocation(location)
Returns an array containing only data for the specified location
.
data.dataByDate(date)
Returns an array containing only data for the specified date
.
data.dataByGroup(group)
Returns an array containing only data for the specified group
.
data.sumOfLabel(label)
Returns the sum of data for the specified label
.
data.sumOfLocation(location)
Returns the sum of data for the specified location
.
data.sumOfDate(date)
Returns the sum of data for the specified date
.
data.sumOfGroup(group)
Returns the sum of data for the specified group
.
Events.disp()
The static dispatch object.
Events.on(type, callback)
Adds the given callback
for the given type
.
Events.call(type, sender, ...params)
Calls the callback
for the given type
with the given sender
and params
.
# build module
yarn build
# develop module
yarn build:watch