Skip to content

Configuration

Jorge Yagüe París edited this page Feb 16, 2018 · 5 revisions
Status of this document
Release 0.0.1

This page describes the configuration process applicable for every visualisation in Proteic.js. The specific parameters of each visualisation can be found in their wiki pages (Available visualizations)

Configuration object

You can pass a configuration object to the constructor of each new chart. Any parameter set this way will override the default configuration of the chart. For example:

var chart = new proteic.Linechart(data, { width: 100, area: true });

Configuration API

The configuration of the chart can also be modified after its creation using the configuration API. Each chart provides a set of methods named after the properties in its configuration object. You can chain the calls to this methods like the following example:

var chart = new proteic.Linechart(data, {width: 100});
chart
  .width(200)
  .area(false);
chart.draw();

To show the changes in the configuration you have to redraw the chart calling the Chart#draw() method.