Chartist - API Documentation

auto-scale-axis.js

Module Chartist.AutoScaleAxis

The auto scale axis uses standard linear scale projection of values along an axis. It uses order of magnitude to find a scale automatically and evaluates the available space in order to find the perfect amount of ticks for your chart.
Options
The following options are used by this axis in addition to the default axis options outlined in the axis configuration of the chart default settings.

var options = {
  // If high is specified then the axis will display values explicitly up to this value and the computed maximum from the data is ignored
  high: 100,
  // If low is specified then the axis will display values explicitly down to this value and the computed minimum from the data is ignored
  low: 0,
  // This option will be used when finding the right scale division settings. The amount of ticks on the scale will be determined so that as many ticks as possible will be displayed, while not violating this minimum required space (in pixel).
  scaleMinSpace: 20,
  // Can be set to true or false. If set to true, the scale will be generated with whole numbers only.
  onlyInteger: true,
  // The reference value can be used to make sure that this value will always be on the chart. This is especially useful on bipolar charts where the bipolar center always needs to be part of the chart.
  referenceValue: 5
};

axis.js

fixed-scale-axis.js

Module Chartist.FixedScaleAxis

The fixed scale axis uses standard linear projection of values along an axis. It makes use of a divisor option to divide the range provided from the minimum and maximum value or the options high and low that will override the computed minimum and maximum.
Options
The following options are used by this axis in addition to the default axis options outlined in the axis configuration of the chart default settings.

var options = {
  // If high is specified then the axis will display values explicitly up to this value and the computed maximum from the data is ignored
  high: 100,
  // If low is specified then the axis will display values explicitly down to this value and the computed minimum from the data is ignored
  low: 0,
  // If specified then the value range determined from minimum to maximum (or low and high) will be divided by this number and ticks will be generated at those division points. The default divisor is 1.
  divisor: 4,
  // If ticks is explicitly set, then the axis will not compute the ticks with the divisor, but directly use the data in ticks to determine at what points on the axis a tick need to be generated.
  ticks: [1, 10, 20, 30]
};

step-axis.js

Module Chartist.StepAxis

The step axis for step based charts like bar chart or step based line charts. It uses a fixed amount of ticks that will be equally distributed across the whole axis length. The projection is done using the index of the data value rather than the value itself and therefore it's only useful for distribution purpose.
Options
The following options are used by this axis in addition to the default axis options outlined in the axis configuration of the chart default settings.

var options = {
  // Ticks to be used to distribute across the axis length. As this axis type relies on the index of the value rather than the value, arbitrary data that can be converted to a string can be used as ticks.
  ticks: ['One', 'Two', 'Three'],
  // If set to true the full width will be used to distribute the values where the last value will be at the maximum of the axis length. If false the spaces between the ticks will be evenly distributed instead.
  stretch: true
};

base.js

Module Chartist.Base

Base for all chart types. The methods in Chartist.Base are inherited to all chart types.

function update()
    function update(data, options, override) {
  if(data) {
    this.data = data || {};
    this.data.labels = this.data.labels || [];
    this.data.series = this.data.series || [];
    // Event for data transformation that allows to manipulate the data before it gets rendered in the charts
    this.eventEmitter.emit('data', {
      type: 'update',
      data: this.data
    });
  }

  if(options) {
    this.options = Chartist.extend({}, override ? this.options : this.defaultOptions, options);

    // If chartist was not initialized yet, we just set the options and leave the rest to the initialization
    // Otherwise we re-create the optionsProvider at this point
    if(!this.initializeTimeoutId) {
      this.optionsProvider.removeMediaQueryListeners();
      this.optionsProvider = Chartist.optionsProvider(this.options, this.responsiveOptions, this.eventEmitter);
    }
  }

  // Only re-created the chart if it has been initialized yet
  if(!this.initializeTimeoutId) {
    this.createChart(this.optionsProvider.getCurrentOptions());
  }

  // Return a reference to the chart object to chain up calls
  return this;
}
  

Updates the chart which currently does a full reconstruction of the SVG DOM

Parameters
[data] ( Object )
Optional data you'd like to set for the chart before it will update. If not specified the update method will use the data that is already configured with the chart.
[options] ( Object )
Optional options you'd like to add to the previous options for the chart before it will update. If not specified the update method will use the options that have been already configured with the chart.
[override] ( Boolean )
If set to true, the passed options will be used to extend the options that have been configured already. Otherwise the chart default options will be used as the base
function detach()
    function detach() {
  // Only detach if initialization already occurred on this chart. If this chart still hasn't initialized (therefore
  // the initializationTimeoutId is still a valid timeout reference, we will clear the timeout
  if(!this.initializeTimeoutId) {
    window.removeEventListener('resize', this.resizeListener);
    this.optionsProvider.removeMediaQueryListeners();
  } else {
    window.clearTimeout(this.initializeTimeoutId);
  }

  return this;
}
  

This method can be called on the API object of each chart and will un-register all event listeners that were added to other components. This currently includes a window.resize listener as well as media query listeners if any responsive options have been provided. Use this function if you need to destroy and recreate Chartist charts dynamically.

function on()
    function on(event, handler) {
  this.eventEmitter.addEventHandler(event, handler);
  return this;
}
  

Use this function to register event handlers. The handler callbacks are synchronous and will run in the main thread rather than the event loop.

Parameters
event ( String )
Name of the event. Check the examples for supported events.
handler ( Function )
The handler function that will be called when an event with the given name was emitted. This function will receive a data argument which contains event data. See the example for more details.
function off()
    function off(event, handler) {
  this.eventEmitter.removeEventHandler(event, handler);
  return this;
}

function initialize() {
  // Add window resize listener that re-creates the chart
  window.addEventListener('resize', this.resizeListener);

  // Obtain current options based on matching media queries (if responsive options are given)
  // This will also register a listener that is re-creating the chart based on media changes
  this.optionsProvider = Chartist.optionsProvider(this.options, this.responsiveOptions, this.eventEmitter);
  // Register options change listener that will trigger a chart update
  this.eventEmitter.addEventHandler('optionsChanged', function() {
    this.update();
  }.bind(this));

  // Before the first chart creation we need to register us with all plugins that are configured
  // Initialize all relevant plugins with our chart object and the plugin options specified in the config
  if(this.options.plugins) {
    this.options.plugins.forEach(function(plugin) {
      if(plugin instanceof Array) {
        plugin[0](this, plugin[1]);
      } else {
        plugin(this);
      }
    }.bind(this));
  }

  // Event for data transformation that allows to manipulate the data before it gets rendered in the charts
  this.eventEmitter.emit('data', {
    type: 'initial',
    data: this.data
  });

  // Create the first chart
  this.createChart(this.optionsProvider.getCurrentOptions());

  // As chart is initialized from the event loop now we can reset our timeout reference
  // This is important if the chart gets initialized on the same element twice
  this.initializeTimeoutId = undefined;
}
  

Use this function to un-register event handlers. If the handler function parameter is omitted all handlers for the given event will be un-registered.

Parameters
event ( String )
Name of the event for which a handler should be removed
[handler] ( Function )
The handler function that that was previously used to register a new event handler. This handler will be removed from the event handler list. If this parameter is omitted then all event handlers for the given event are removed from the list.

bar.js

Module Chartist.Bar

The bar chart module of Chartist that can be used to draw unipolar or bipolar bar and grouped bar charts.

declaration defaultOptions
    var defaultOptions = {
  // Options for X-Axis
  axisX: {
    // The offset of the chart drawing area to the border of the container
    offset: 30,
    // Position where labels are placed. Can be set to `start` or `end` where `start` is equivalent to left or top on vertical axis and `end` is equivalent to right or bottom on horizontal axis.
    position: 'end',
    // Allows you to correct label positioning on this axis by positive or negative x and y offset.
    labelOffset: {
      x: 0,
      y: 0
    },
    // If labels should be shown or not
    showLabel: true,
    // If the axis grid should be drawn or not
    showGrid: true,
    // Interpolation function that allows you to intercept the value from the axis label
    labelInterpolationFnc: Chartist.noop,
    // This value specifies the minimum width in pixel of the scale steps
    scaleMinSpace: 30,
    // Use only integer values (whole numbers) for the scale steps
    onlyInteger: false
  },
  // Options for Y-Axis
  axisY: {
    // The offset of the chart drawing area to the border of the container
    offset: 40,
    // Position where labels are placed. Can be set to `start` or `end` where `start` is equivalent to left or top on vertical axis and `end` is equivalent to right or bottom on horizontal axis.
    position: 'start',
    // Allows you to correct label positioning on this axis by positive or negative x and y offset.
    labelOffset: {
      x: 0,
      y: 0
    },
    // If labels should be shown or not
    showLabel: true,
    // If the axis grid should be drawn or not
    showGrid: true,
    // Interpolation function that allows you to intercept the value from the axis label
    labelInterpolationFnc: Chartist.noop,
    // This value specifies the minimum height in pixel of the scale steps
    scaleMinSpace: 20,
    // Use only integer values (whole numbers) for the scale steps
    onlyInteger: false
  },
  // Specify a fixed width for the chart as a string (i.e. '100px' or '50%')
  width: undefined,
  // Specify a fixed height for the chart as a string (i.e. '100px' or '50%')
  height: undefined,
  // Overriding the natural high of the chart allows you to zoom in or limit the charts highest displayed value
  high: undefined,
  // Overriding the natural low of the chart allows you to zoom in or limit the charts lowest displayed value
  low: undefined,
  // Unless low/high are explicitly set, bar chart will be centered at zero by default. Set referenceValue to null to auto scale.
  referenceValue: 0,
  // Padding of the chart drawing area to the container element and labels as a number or padding object {top: 5, right: 5, bottom: 5, left: 5}
  chartPadding: {
    top: 15,
    right: 15,
    bottom: 5,
    left: 10
  },
  // Specify the distance in pixel of bars in a group
  seriesBarDistance: 15,
  // If set to true this property will cause the series bars to be stacked. Check the `stackMode` option for further stacking options.
  stackBars: false,
  // If set to 'overlap' this property will force the stacked bars to draw from the zero line.
  // If set to 'accumulate' this property will form a total for each series point. This will also influence the y-axis and the overall bounds of the chart. In stacked mode the seriesBarDistance property will have no effect.
  stackMode: 'accumulate',
  // Inverts the axes of the bar chart in order to draw a horizontal bar chart. Be aware that you also need to invert your axis settings as the Y Axis will now display the labels and the X Axis the values.
  horizontalBars: false,
  // If set to true then each bar will represent a series and the data array is expected to be a one dimensional array of data values rather than a series array of series. This is useful if the bar chart should represent a profile rather than some data over time.
  distributeSeries: false,
  // If true the whole data is reversed including labels, the series order as well as the whole series data arrays.
  reverseData: false,
  // If the bar chart should add a background fill to the .ct-grids group.
  showGridBackground: false,
  // Override the class names that get used to generate the SVG structure of the chart
  classNames: {
    chart: 'ct-chart-bar',
    horizontalBars: 'ct-horizontal-bars',
    label: 'ct-label',
    labelGroup: 'ct-labels',
    series: 'ct-series',
    bar: 'ct-bar',
    grid: 'ct-grid',
    gridGroup: 'ct-grids',
    gridBackground: 'ct-grid-background',
    vertical: 'ct-vertical',
    horizontal: 'ct-horizontal',
    start: 'ct-start',
    end: 'ct-end'
  }
};
  

Default options in bar charts. Expand the code view to see a detailed list of options with comments.

function Bar()
    function Bar(query, data, options, responsiveOptions) {
  Chartist.Bar.super.constructor.call(this,
    query,
    data,
    defaultOptions,
    Chartist.extend({}, defaultOptions, options),
    responsiveOptions);
}

// Creating bar chart type in Chartist namespace
Chartist.Bar = Chartist.Base.extend({
  constructor: Bar,
  createChart: createChart
});

}(window, document, Chartist));
  

This method creates a new bar chart and returns API object that you can use for later changes.

Parameters
query ( String Node )
A selector query string or directly a DOM element
data ( Object )
The data object that needs to consist of a labels and a series array
[options] ( Object )
The options object with options that override the default options. Check the examples for a detailed list.
[responsiveOptions] ( Array )
Specify an array of responsive option arrays which are a media query and options object pair => [[mediaQueryString, optionsObject],[more...]]
Returns
( Object )
An object which exposes the API for the created chart
Examples
// Create a simple bar chart
var data = {
  labels: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri'],
  series: [
    [5, 2, 4, 2, 0]
  ]
};

// In the global name space Chartist we call the Bar function to initialize a bar chart. As a first parameter we pass in a selector where we would like to get our chart created and as a second parameter we pass our data object.
new Chartist.Bar('.ct-chart', data);
// This example creates a bipolar grouped bar chart where the boundaries are limitted to -10 and 10
new Chartist.Bar('.ct-chart', {
  labels: [1, 2, 3, 4, 5, 6, 7],
  series: [
    [1, 3, 2, -5, -3, 1, -6],
    [-5, -2, -4, -1, 2, -3, 1]
  ]
}, {
  seriesBarDistance: 12,
  low: -10,
  high: 10
});

line.js

Module Chartist.Line

The Chartist line chart can be used to draw Line or Scatter charts. If used in the browser you can access the global Chartist namespace where you find the Line function as a main entry point.

declaration defaultOptions
    var defaultOptions = {
  // Options for X-Axis
  axisX: {
    // The offset of the labels to the chart area
    offset: 30,
    // Position where labels are placed. Can be set to `start` or `end` where `start` is equivalent to left or top on vertical axis and `end` is equivalent to right or bottom on horizontal axis.
    position: 'end',
    // Allows you to correct label positioning on this axis by positive or negative x and y offset.
    labelOffset: {
      x: 0,
      y: 0
    },
    // If labels should be shown or not
    showLabel: true,
    // If the axis grid should be drawn or not
    showGrid: true,
    // Interpolation function that allows you to intercept the value from the axis label
    labelInterpolationFnc: Chartist.noop,
    // Set the axis type to be used to project values on this axis. If not defined, Chartist.StepAxis will be used for the X-Axis, where the ticks option will be set to the labels in the data and the stretch option will be set to the global fullWidth option. This type can be changed to any axis constructor available (e.g. Chartist.FixedScaleAxis), where all axis options should be present here.
    type: undefined
  },
  // Options for Y-Axis
  axisY: {
    // The offset of the labels to the chart area
    offset: 40,
    // Position where labels are placed. Can be set to `start` or `end` where `start` is equivalent to left or top on vertical axis and `end` is equivalent to right or bottom on horizontal axis.
    position: 'start',
    // Allows you to correct label positioning on this axis by positive or negative x and y offset.
    labelOffset: {
      x: 0,
      y: 0
    },
    // If labels should be shown or not
    showLabel: true,
    // If the axis grid should be drawn or not
    showGrid: true,
    // Interpolation function that allows you to intercept the value from the axis label
    labelInterpolationFnc: Chartist.noop,
    // Set the axis type to be used to project values on this axis. If not defined, Chartist.AutoScaleAxis will be used for the Y-Axis, where the high and low options will be set to the global high and low options. This type can be changed to any axis constructor available (e.g. Chartist.FixedScaleAxis), where all axis options should be present here.
    type: undefined,
    // This value specifies the minimum height in pixel of the scale steps
    scaleMinSpace: 20,
    // Use only integer values (whole numbers) for the scale steps
    onlyInteger: false
  },
  // Specify a fixed width for the chart as a string (i.e. '100px' or '50%')
  width: undefined,
  // Specify a fixed height for the chart as a string (i.e. '100px' or '50%')
  height: undefined,
  // If the line should be drawn or not
  showLine: true,
  // If dots should be drawn or not
  showPoint: true,
  // If the line chart should draw an area
  showArea: false,
  // The base for the area chart that will be used to close the area shape (is normally 0)
  areaBase: 0,
  // Specify if the lines should be smoothed. This value can be true or false where true will result in smoothing using the default smoothing interpolation function Chartist.Interpolation.cardinal and false results in Chartist.Interpolation.none. You can also choose other smoothing / interpolation functions available in the Chartist.Interpolation module, or write your own interpolation function. Check the examples for a brief description.
  lineSmooth: true,
  // If the line chart should add a background fill to the .ct-grids group.
  showGridBackground: false,
  // Overriding the natural low of the chart allows you to zoom in or limit the charts lowest displayed value
  low: undefined,
  // Overriding the natural high of the chart allows you to zoom in or limit the charts highest displayed value
  high: undefined,
  // Padding of the chart drawing area to the container element and labels as a number or padding object {top: 5, right: 5, bottom: 5, left: 5}
  chartPadding: {
    top: 15,
    right: 15,
    bottom: 5,
    left: 10
  },
  // When set to true, the last grid line on the x-axis is not drawn and the chart elements will expand to the full available width of the chart. For the last label to be drawn correctly you might need to add chart padding or offset the last label with a draw event handler.
  fullWidth: false,
  // If true the whole data is reversed including labels, the series order as well as the whole series data arrays.
  reverseData: false,
  // Override the class names that get used to generate the SVG structure of the chart
  classNames: {
    chart: 'ct-chart-line',
    label: 'ct-label',
    labelGroup: 'ct-labels',
    series: 'ct-series',
    line: 'ct-line',
    point: 'ct-point',
    area: 'ct-area',
    grid: 'ct-grid',
    gridGroup: 'ct-grids',
    gridBackground: 'ct-grid-background',
    vertical: 'ct-vertical',
    horizontal: 'ct-horizontal',
    start: 'ct-start',
    end: 'ct-end'
  }
};
  

Default options in line charts. Expand the code view to see a detailed list of options with comments.

function Line()
    function Line(query, data, options, responsiveOptions) {
  Chartist.Line.super.constructor.call(this,
    query,
    data,
    defaultOptions,
    Chartist.extend({}, defaultOptions, options),
    responsiveOptions);
}

// Creating line chart type in Chartist namespace
Chartist.Line = Chartist.Base.extend({
  constructor: Line,
  createChart: createChart
});

}(window, document, Chartist));
  

This method creates a new line chart.

Parameters
query ( String Node )
A selector query string or directly a DOM element
data ( Object )
The data object that needs to consist of a labels and a series array
[options] ( Object )
The options object with options that override the default options. Check the examples for a detailed list.
[responsiveOptions] ( Array )
Specify an array of responsive option arrays which are a media query and options object pair => [[mediaQueryString, optionsObject],[more...]]
Returns
( Object )
An object which exposes the API for the created chart
Examples
// Create a simple line chart
var data = {
  // A labels array that can contain any sort of values
  labels: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri'],
  // Our series array that contains series objects or in this case series data arrays
  series: [
    [5, 2, 4, 2, 0]
  ]
};

// As options we currently only set a static size of 300x200 px
var options = {
  width: '300px',
  height: '200px'
};

// In the global name space Chartist we call the Line function to initialize a line chart. As a first parameter we pass in a selector where we would like to get our chart created. Second parameter is the actual data object and as a third parameter we pass in our options
new Chartist.Line('.ct-chart', data, options);
// Use specific interpolation function with configuration from the Chartist.Interpolation module

var chart = new Chartist.Line('.ct-chart', {
  labels: [1, 2, 3, 4, 5],
  series: [
    [1, 1, 8, 1, 7]
  ]
}, {
  lineSmooth: Chartist.Interpolation.cardinal({
    tension: 0.2
  })
});
// Create a line chart with responsive options

var data = {
  // A labels array that can contain any sort of values
  labels: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
  // Our series array that contains series objects or in this case series data arrays
  series: [
    [5, 2, 4, 2, 0]
  ]
};

// In addition to the regular options we specify responsive option overrides that will override the default configutation based on the matching media queries.
var responsiveOptions = [
  ['screen and (min-width: 641px) and (max-width: 1024px)', {
    showPoint: false,
    axisX: {
      labelInterpolationFnc: function(value) {
        // Will return Mon, Tue, Wed etc. on medium screens
        return value.slice(0, 3);
      }
    }
  }],
  ['screen and (max-width: 640px)', {
    showLine: false,
    axisX: {
      labelInterpolationFnc: function(value) {
        // Will return M, T, W etc. on small screens
        return value[0];
      }
    }
  }]
];

new Chartist.Line('.ct-chart', data, null, responsiveOptions);

pie.js

Module Chartist.Pie

The pie chart module of Chartist that can be used to draw pie, donut or gauge charts

declaration defaultOptions
    var defaultOptions = {
  // Specify a fixed width for the chart as a string (i.e. '100px' or '50%')
  width: undefined,
  // Specify a fixed height for the chart as a string (i.e. '100px' or '50%')
  height: undefined,
  // Padding of the chart drawing area to the container element and labels as a number or padding object {top: 5, right: 5, bottom: 5, left: 5}
  chartPadding: 5,
  // Override the class names that are used to generate the SVG structure of the chart
  classNames: {
    chartPie: 'ct-chart-pie',
    chartDonut: 'ct-chart-donut',
    series: 'ct-series',
    slicePie: 'ct-slice-pie',
    sliceDonut: 'ct-slice-donut',
    label: 'ct-label'
  },
  // The start angle of the pie chart in degrees where 0 points north. A higher value offsets the start angle clockwise.
  startAngle: 0,
  // An optional total you can specify. By specifying a total value, the sum of the values in the series must be this total in order to draw a full pie. You can use this parameter to draw only parts of a pie or gauge charts.
  total: undefined,
  // If specified the donut CSS classes will be used and strokes will be drawn instead of pie slices.
  donut: false,
  // Specify the donut stroke width, currently done in javascript for convenience. May move to CSS styles in the future.
  // This option can be set as number or string to specify a relative width (i.e. 100 or '30%').
  donutWidth: 60,
  // If a label should be shown or not
  showLabel: true,
  // Label position offset from the standard position which is half distance of the radius. This value can be either positive or negative. Positive values will position the label away from the center.
  labelOffset: 0,
  // This option can be set to 'inside', 'outside' or 'center'. Positioned with 'inside' the labels will be placed on half the distance of the radius to the border of the Pie by respecting the 'labelOffset'. The 'outside' option will place the labels at the border of the pie and 'center' will place the labels in the absolute center point of the chart. The 'center' option only makes sense in conjunction with the 'labelOffset' option.
  labelPosition: 'inside',
  // An interpolation function for the label value
  labelInterpolationFnc: Chartist.noop,
  // Label direction can be 'neutral', 'explode' or 'implode'. The labels anchor will be positioned based on those settings as well as the fact if the labels are on the right or left side of the center of the chart. Usually explode is useful when labels are positioned far away from the center.
  labelDirection: 'neutral',
  // If true the whole data is reversed including labels, the series order as well as the whole series data arrays.
  reverseData: false,
  // If true empty values will be ignored to avoid drawing unncessary slices and labels
  ignoreEmptyValues: false
};
  

Default options in line charts. Expand the code view to see a detailed list of options with comments.

function Pie()
    function Pie(query, data, options, responsiveOptions) {
  Chartist.Pie.super.constructor.call(this,
    query,
    data,
    defaultOptions,
    Chartist.extend({}, defaultOptions, options),
    responsiveOptions);
}

// Creating pie chart type in Chartist namespace
Chartist.Pie = Chartist.Base.extend({
  constructor: Pie,
  createChart: createChart,
  determineAnchorPosition: determineAnchorPosition
});

}(window, document, Chartist));
  

This method creates a new pie chart and returns an object that can be used to redraw the chart.

Parameters
query ( String Node )
A selector query string or directly a DOM element
data ( Object )
The data object in the pie chart needs to have a series property with a one dimensional data array. The values will be normalized against each other and don't necessarily need to be in percentage. The series property can also be an array of value objects that contain a value property and a className property to override the CSS class name for the series group.
[options] ( Object )
The options object with options that override the default options. Check the examples for a detailed list.
[responsiveOptions] ( Array )
Specify an array of responsive option arrays which are a media query and options object pair => [[mediaQueryString, optionsObject],[more...]]
Returns
( Object )
An object with a version and an update method to manually redraw the chart
Examples
// Simple pie chart example with four series
new Chartist.Pie('.ct-chart', {
  series: [10, 2, 4, 3]
});
// Drawing a donut chart
new Chartist.Pie('.ct-chart', {
  series: [10, 2, 4, 3]
}, {
  donut: true
});
// Using donut, startAngle and total to draw a gauge chart
new Chartist.Pie('.ct-chart', {
  series: [20, 10, 30, 40]
}, {
  donut: true,
  donutWidth: 20,
  startAngle: 270,
  total: 200
});
// Drawing a pie chart with padding and labels that are outside the pie
new Chartist.Pie('.ct-chart', {
  series: [20, 10, 30, 40]
}, {
  chartPadding: 30,
  labelOffset: 50,
  labelDirection: 'explode'
});
// Overriding the class names for individual series as well as a name and meta data.
// The name will be written as ct:series-name attribute and the meta data will be serialized and written
// to a ct:meta attribute.
new Chartist.Pie('.ct-chart', {
  series: [{
    value: 20,
    name: 'Series 1',
    className: 'my-custom-class-one',
    meta: 'Meta One'
  }, {
    value: 10,
    name: 'Series 2',
    className: 'my-custom-class-two',
    meta: 'Meta Two'
  }, {
    value: 70,
    name: 'Series 3',
    className: 'my-custom-class-three',
    meta: 'Meta Three'
  }]
});

class.js

Module Chartist.Class

This module provides some basic prototype inheritance utilities.

function extend()
    function extend(properties, superProtoOverride) {
  var superProto = superProtoOverride || this.prototype || Chartist.Class;
  var proto = Object.create(superProto);

  Chartist.Class.cloneDefinitions(proto, properties);

  var constr = function() {
    var fn = proto.constructor || function () {},
      instance;

    // If this is linked to the Chartist namespace the constructor was not called with new
    // To provide a fallback we will instantiate here and return the instance
    instance = this === Chartist ? Object.create(proto) : this;
    fn.apply(instance, Array.prototype.slice.call(arguments, 0));

    // If this constructor was not called with new we need to return the instance
    // This will not harm when the constructor has been called with new as the returned value is ignored
    return instance;
  };

  constr.prototype = proto;
  constr.super = superProto;
  constr.extend = this.extend;

  return constr;
}

// Variable argument list clones args > 0 into args[0] and retruns modified args[0]
function cloneDefinitions() {
  var args = listToArray(arguments);
  var target = args[0];

  args.splice(1, args.length - 1).forEach(function (source) {
    Object.getOwnPropertyNames(source).forEach(function (propName) {
      // If this property already exist in target we delete it first
      delete target[propName];
      // Define the property with the descriptor from source
      Object.defineProperty(target, propName,
        Object.getOwnPropertyDescriptor(source, propName));
    });
  });

  return target;
}

Chartist.Class = {
  extend: extend,
  cloneDefinitions: cloneDefinitions
};

}(window, document, Chartist));
  

Method to extend from current prototype.

Parameters
properties ( Object )
The object that serves as definition for the prototype that gets created for the new class. This object should always contain a constructor property that is the desired constructor for the newly created class.
[superProtoOverride] ( Object )
By default extens will use the current class prototype or Chartist.class. With this parameter you can specify any super prototype that will be used.
Returns
( Function )
Constructor function of the new class
Examples
var Fruit = Class.extend({
color: undefined,
  sugar: undefined,

  constructor: function(color, sugar) {
    this.color = color;
    this.sugar = sugar;
  },

  eat: function() {
    this.sugar = 0;
    return this;
  }
});

var Banana = Fruit.extend({
  length: undefined,

  constructor: function(length, sugar) {
    Banana.super.constructor.call(this, 'Yellow', sugar);
    this.length = length;
  }
});

var banana = new Banana(20, 40);
console.log('banana instanceof Fruit', banana instanceof Fruit);
console.log('Fruit is prototype of banana', Fruit.prototype.isPrototypeOf(banana));
console.log('bananas prototype is Fruit', Object.getPrototypeOf(banana) === Fruit.prototype);
console.log(banana.sugar);
console.log(banana.eat().sugar);
console.log(banana.color);

core.js

Module Chartist.Core

The core module of Chartist that is mainly providing static functions and higher level functions for chart modules.

property Chartist.namespaces
    Chartist.namespaces = {
  svg: 'http://www.w3.org/2000/svg',
  xmlns: 'http://www.w3.org/2000/xmlns/',
  xhtml: 'http://www.w3.org/1999/xhtml',
  xlink: 'http://www.w3.org/1999/xlink',
  ct: 'http://gionkunz.github.com/chartist-js/ct'
};

/**
 * Helps to simplify functional style code
 *
 * @memberof Chartist.Core
 * @param {*} n This exact value will be returned by the noop function
 * @return {*} The same value that was provided to the n parameter
 */
Chartist.noop = function (n) {
  return n;
};

/**
 * Generates a-z from a number 0 to 26
 *
 * @memberof Chartist.Core
 * @param {Number} n A number from 0 to 26 that will result in a letter a-z
 * @return {String} A character from a-z based on the input number n
 */
Chartist.alphaNumerate = function (n) {
  // Limit to a-z
  return String.fromCharCode(97 + n % 26);
};

/**
 * Simple recursive object extend
 *
 * @memberof Chartist.Core
 * @param {Object} target Target object where the source will be merged into
 * @param {Object...} sources This object (objects) will be merged into target and then target is returned
 * @return {Object} An object that has the same reference as target but is extended and merged with the properties of source
 */
Chartist.extend = function (target) {
  var i, source, sourceProp;
  target = target || {};

  for (i = 1; i < arguments.length; i++) {
    source = arguments[i];
    for (var prop in source) {
      sourceProp = source[prop];
      if (typeof sourceProp === 'object' && sourceProp !== null && !(sourceProp instanceof Array)) {
        target[prop] = Chartist.extend(target[prop], sourceProp);
      } else {
        target[prop] = sourceProp;
      }
    }
  }

  return target;
};

/**
 * Replaces all occurrences of subStr in str with newSubStr and returns a new string.
 *
 * @memberof Chartist.Core
 * @param {String} str
 * @param {String} subStr
 * @param {String} newSubStr
 * @return {String}
 */
Chartist.replaceAll = function(str, subStr, newSubStr) {
  return str.replace(new RegExp(subStr, 'g'), newSubStr);
};

/**
 * Converts a number to a string with a unit. If a string is passed then this will be returned unmodified.
 *
 * @memberof Chartist.Core
 * @param {Number} value
 * @param {String} unit
 * @return {String} Returns the passed number value with unit.
 */
Chartist.ensureUnit = function(value, unit) {
  if(typeof value === 'number') {
    value = value + unit;
  }

  return value;
};

/**
 * Converts a number or string to a quantity object.
 *
 * @memberof Chartist.Core
 * @param {String|Number} input
 * @return {Object} Returns an object containing the value as number and the unit as string.
 */
Chartist.quantity = function(input) {
  if (typeof input === 'string') {
    var match = (/^(\d+)\s*(.*)$/g).exec(input);
    return {
      value : +match[1],
      unit: match[2] || undefined
    };
  }
  return { value: input };
};

/**
 * This is a wrapper around document.querySelector that will return the query if it's already of type Node
 *
 * @memberof Chartist.Core
 * @param {String|Node} query The query to use for selecting a Node or a DOM node that will be returned directly
 * @return {Node}
 */
Chartist.querySelector = function(query) {
  return query instanceof Node ? query : document.querySelector(query);
};
  

This object contains all namespaces used within Chartist.

method Chartist.times()
    Chartist.times = function(length) {
  return Array.apply(null, new Array(length));
};
  

Functional style helper to produce array with given length initialized with undefined values

Parameters
( length )
Returns
( Array )
method Chartist.sum()
    Chartist.sum = function(previous, current) {
  return previous + (current ? current : 0);
};
  

Sum helper to be used in reduce functions

Parameters
( previous )
( current )
Returns
( * )
method Chartist.mapMultiply()
    Chartist.mapMultiply = function(factor) {
  return function(num) {
    return num * factor;
  };
};
  

Multiply helper to be used in Array.map for multiplying each value of an array with a factor.

Parameters
factor ( Number )
method Chartist.mapAdd()
    Chartist.mapAdd = function(addend) {
  return function(num) {
    return num + addend;
  };
};
  

Add helper to be used in Array.map for adding a addend to each value of an array.

Parameters
addend ( Number )
method Chartist.serialMap()
    Chartist.serialMap = function(arr, cb) {
  var result = [],
      length = Math.max.apply(null, arr.map(function(e) {
        return e.length;
      }));

  Chartist.times(length).forEach(function(e, index) {
    var args = arr.map(function(e) {
      return e[index];
    });

    result[index] = cb.apply(null, args);
  });

  return result;
};
  

Map for multi dimensional arrays where their nested arrays will be mapped in serial. The output array will have the length of the largest nested array. The callback function is called with variable arguments where each argument is the nested array value (or undefined if there are no more values).

Parameters
( arr )
( cb )
Returns
( Array )
method Chartist.roundWithPrecision()
    Chartist.roundWithPrecision = function(value, digits) {
  var precision = Math.pow(10, digits || Chartist.precision);
  return Math.round(value * precision) / precision;
};
  

This helper function can be used to round values with certain precision level after decimal. This is used to prevent rounding errors near float point precision limit.

Parameters
value ( Number )
The value that should be rounded with precision
[digits] ( Number )
The number of digits after decimal used to do the rounding
property Chartist.precision
    Chartist.precision = 8;
  

Precision level used internally in Chartist for rounding. If you require more decimal places you can increase this number.

property Chartist.escapingMap
    Chartist.escapingMap = {
  '&': '&amp;',
  '<': '&lt;',
  '>': '&gt;',
  '"': '&quot;',
  '\'': '&#039;'
};
  

A map with characters to escape for strings to be safely used as attribute values.

method Chartist.serialize()
    Chartist.serialize = function(data) {
  if(data === null || data === undefined) {
    return data;
  } else if(typeof data === 'number') {
    data = ''+data;
  } else if(typeof data === 'object') {
    data = JSON.stringify({data: data});
  }

  return Object.keys(Chartist.escapingMap).reduce(function(result, key) {
    return Chartist.replaceAll(result, key, Chartist.escapingMap[key]);
  }, data);
};
  

This function serializes arbitrary data to a string. In case of data that can't be easily converted to a string, this function will create a wrapper object and serialize the data using JSON.stringify. The outcoming string will always be escaped using Chartist.escapingMap.
If called with null or undefined the function will return immediately with null or undefined.

Parameters
data ( Number String Object )
Returns
( String )
method Chartist.deserialize()
    Chartist.deserialize = function(data) {
  if(typeof data !== 'string') {
    return data;
  }

  data = Object.keys(Chartist.escapingMap).reduce(function(result, key) {
    return Chartist.replaceAll(result, Chartist.escapingMap[key], key);
  }, data);

  try {
    data = JSON.parse(data);
    data = data.data !== undefined ? data.data : data;
  } catch(e) {}

  return data;
};
  

This function de-serializes a string previously serialized with Chartist.serialize. The string will always be unescaped using Chartist.escapingMap before it's returned. Based on the input value the return type can be Number, String or Object. JSON.parse is used with try / catch to see if the unescaped string can be parsed into an Object and this Object will be returned on success.

Parameters
data ( String )
Returns
( String Number Object )
method Chartist.createSvg()
    Chartist.createSvg = function (container, width, height, className) {
  var svg;

  width = width || '100%';
  height = height || '100%';

  // Check if there is a previous SVG element in the container that contains the Chartist XML namespace and remove it
  // Since the DOM API does not support namespaces we need to manually search the returned list http://www.w3.org/TR/selectors-api/
  Array.prototype.slice.call(container.querySelectorAll('svg')).filter(function filterChartistSvgObjects(svg) {
    return svg.getAttributeNS(Chartist.namespaces.xmlns, 'ct');
  }).forEach(function removePreviousElement(svg) {
    container.removeChild(svg);
  });

  // Create svg object with width and height or use 100% as default
  svg = new Chartist.Svg('svg').attr({
    width: width,
    height: height
  }).addClass(className).attr({
    style: 'width: ' + width + '; height: ' + height + ';'
  });

  // Add the DOM node to our container
  container.appendChild(svg._node);

  return svg;
};
  

Create or reinitialize the SVG element for the chart

Parameters
container ( Node )
The containing DOM Node object that will be used to plant the SVG element
width ( String )
Set the width of the SVG element. Default is 100%
height ( String )
Set the height of the SVG element. Default is 100%
className ( String )
Specify a class to be added to the SVG element
Returns
( Object )
The created/reinitialized SVG element
method Chartist.reverseData()
    Chartist.reverseData = function(data) {
  data.labels.reverse();
  data.series.reverse();
  for (var i = 0; i < data.series.length; i++) {
    if(typeof(data.series[i]) === 'object' && data.series[i].data !== undefined) {
      data.series[i].data.reverse();
    } else if(data.series[i] instanceof Array) {
      data.series[i].reverse();
    }
  }
};
  

Reverses the series, labels and series data arrays.

Parameters
( data )
method Chartist.getDataArray()
    Chartist.getDataArray = function(data, reverse, multi) {
  // Recursively walks through nested arrays and convert string values to numbers and objects with value properties
  // to values. Check the tests in data core -> data normalization for a detailed specification of expected values
  function recursiveConvert(value) {
    if(Chartist.safeHasProperty(value, 'value')) {
      // We are dealing with value object notation so we need to recurse on value property
      return recursiveConvert(value.value);
    } else if(Chartist.safeHasProperty(value, 'data')) {
      // We are dealing with series object notation so we need to recurse on data property
      return recursiveConvert(value.data);
    } else if(value instanceof Array) {
      // Data is of type array so we need to recurse on the series
      return value.map(recursiveConvert);
    } else if(Chartist.isDataHoleValue(value)) {
      // We're dealing with a hole in the data and therefore need to return undefined
      // We're also returning undefined for multi value output
      return undefined;
    } else {
      // We need to prepare multi value output (x and y data)
      if(multi) {
        var multiValue = {};

        // Single series value arrays are assumed to specify the Y-Axis value
        // For example: [1, 2] => [{x: undefined, y: 1}, {x: undefined, y: 2}]
        // If multi is a string then it's assumed that it specified which dimension should be filled as default
        if(typeof multi === 'string') {
          multiValue[multi] = Chartist.getNumberOrUndefined(value);
        } else {
          multiValue.y = Chartist.getNumberOrUndefined(value);
        }

        multiValue.x = value.hasOwnProperty('x') ? Chartist.getNumberOrUndefined(value.x) : multiValue.x;
        multiValue.y = value.hasOwnProperty('y') ? Chartist.getNumberOrUndefined(value.y) : multiValue.y;

        return multiValue;

      } else {
        // We can return simple data
        return Chartist.getNumberOrUndefined(value);
      }
    }
  }

  return data.series.map(recursiveConvert);
};
  

Convert data series into plain array

Parameters
data ( Object )
The series object that contains the data to be visualized in the chart
[reverse] ( Boolean )
If true the whole data is reversed by the getDataArray call. This will modify the data object passed as first parameter. The labels as well as the series order is reversed. The whole series data arrays are reversed too.
[multi] ( Boolean )
Create a multi dimensional array from a series data array where a value object with `x` and `y` values will be created.
Returns
( Array )
A plain array that contains the data to be visualized in the chart
method Chartist.normalizePadding()
    Chartist.normalizePadding = function(padding, fallback) {
  fallback = fallback || 0;

  return typeof padding === 'number' ? {
    top: padding,
    right: padding,
    bottom: padding,
    left: padding
  } : {
    top: typeof padding.top === 'number' ? padding.top : fallback,
    right: typeof padding.right === 'number' ? padding.right : fallback,
    bottom: typeof padding.bottom === 'number' ? padding.bottom : fallback,
    left: typeof padding.left === 'number' ? padding.left : fallback
  };
};

Chartist.getMetaData = function(series, index) {
  var value = series.data ? series.data[index] : series[index];
  return value ? value.meta : undefined;
};
  

Converts a number into a padding object.

Parameters
padding ( Object Number )
[fallback] ( Number )
This value is used to fill missing values if a incomplete padding object was passed
method Chartist.orderOfMagnitude()
    Chartist.orderOfMagnitude = function (value) {
  return Math.floor(Math.log(Math.abs(value)) / Math.LN10);
};
  

Calculate the order of magnitude for the chart scale

Parameters
value ( Number )
The value Range of the chart
Returns
( Number )
The order of magnitude
method Chartist.projectLength()
    Chartist.projectLength = function (axisLength, length, bounds) {
  return length / bounds.range * axisLength;
};
  

Project a data length into screen coordinates (pixels)

Parameters
axisLength ( Object )
The svg element for the chart
length ( Number )
Single data value from a series array
bounds ( Object )
All the values to set the bounds of the chart
Returns
( Number )
The projected data length in pixels
method Chartist.getAvailableHeight()
    Chartist.getAvailableHeight = function (svg, options) {
  return Math.max((Chartist.quantity(options.height).value || svg.height()) - (options.chartPadding.top +  options.chartPadding.bottom) - options.axisX.offset, 0);
};
  

Get the height of the area in the chart for the data series

Parameters
svg ( Object )
The svg element for the chart
options ( Object )
The Object that contains all the optional values for the chart
Returns
( Number )
The height of the area in the chart for the data series
method Chartist.getHighLow()
    Chartist.getHighLow = function (data, options, dimension) {
  // TODO: Remove workaround for deprecated global high / low config. Axis high / low configuration is preferred
  options = Chartist.extend({}, options, dimension ? options['axis' + dimension.toUpperCase()] : {});

  var highLow = {
      high: options.high === undefined ? -Number.MAX_VALUE : +options.high,
      low: options.low === undefined ? Number.MAX_VALUE : +options.low
    };
  var findHigh = options.high === undefined;
  var findLow = options.low === undefined;

  // Function to recursively walk through arrays and find highest and lowest number
  function recursiveHighLow(data) {
    if(data === undefined) {
      return undefined;
    } else if(data instanceof Array) {
      for (var i = 0; i < data.length; i++) {
        recursiveHighLow(data[i]);
      }
    } else {
      var value = dimension ? +data[dimension] : +data;

      if (findHigh && value > highLow.high) {
        highLow.high = value;
      }

      if (findLow && value < highLow.low) {
        highLow.low = value;
      }
    }
  }

  // Start to find highest and lowest number recursively
  if(findHigh || findLow) {
    recursiveHighLow(data);
  }

  // Overrides of high / low based on reference value, it will make sure that the invisible reference value is
  // used to generate the chart. This is useful when the chart always needs to contain the position of the
  // invisible reference value in the view i.e. for bipolar scales.
  if (options.referenceValue || options.referenceValue === 0) {
    highLow.high = Math.max(options.referenceValue, highLow.high);
    highLow.low = Math.min(options.referenceValue, highLow.low);
  }

  // If high and low are the same because of misconfiguration or flat data (only the same value) we need
  // to set the high or low to 0 depending on the polarity
  if (highLow.high <= highLow.low) {
    // If both values are 0 we set high to 1
    if (highLow.low === 0) {
      highLow.high = 1;
    } else if (highLow.low < 0) {
      // If we have the same negative value for the bounds we set bounds.high to 0
      highLow.high = 0;
    } else if (highLow.high > 0) {
      // If we have the same positive value for the bounds we set bounds.low to 0
      highLow.low = 0;
    } else {
      // If data array was empty, values are Number.MAX_VALUE and -Number.MAX_VALUE. Set bounds to prevent errors
      highLow.high = 1;
      highLow.low = 0;
    }
  }

  return highLow;
};
  

Get highest and lowest value of data array. This Array contains the data that will be visualized in the chart.

Parameters
data ( Array )
The array that contains the data to be visualized in the chart
options ( Object )
The Object that contains the chart options
dimension ( String )
Axis dimension 'x' or 'y' used to access the correct value and high / low configuration
Returns
( Object )
An object that contains the highest and lowest value that will be visualized on the chart.
method Chartist.isNumeric()
    Chartist.isNumeric = function(value) {
  return value === null ? false : isFinite(value);
};
  

Checks if a value can be safely coerced to a number. This includes all values except null which result in finite numbers when coerced. This excludes NaN, since it's not finite.

Parameters
( value )
method Chartist.isFalseyButZero()
    Chartist.isFalseyButZero = function(value) {
  return !value && value !== 0;
};
  

Returns true on all falsey values except the numeric value 0.

Parameters
( value )
method Chartist.getNumberOrUndefined()
    Chartist.getNumberOrUndefined = function(value) {
  return Chartist.isNumeric(value) ? +value : undefined;
};
  

Returns a number if the passed parameter is a valid number or the function will return undefined. On all other values than a valid number, this function will return undefined.

Parameters
( value )
method Chartist.isMultiValue()
    Chartist.isMultiValue = function(value) {
  return typeof value === 'object' && ('x' in value || 'y' in value);
};
  

Checks if provided value object is multi value (contains x or y properties)

Parameters
( value )
method Chartist.getMultiValue()
    Chartist.getMultiValue = function(value, dimension) {
  if(Chartist.isMultiValue(value)) {
    return Chartist.getNumberOrUndefined(value[dimension || 'y']);
  } else {
    return Chartist.getNumberOrUndefined(value);
  }
};
  

Gets a value from a dimension value.x or value.y while returning value directly if it's a valid numeric value. If the value is not numeric and it's falsey this function will return defaultValue.

Parameters
( value )
( dimension )
( defaultValue )
method Chartist.rho()
    Chartist.rho = function(num) {
  if(num === 1) {
    return num;
  }

  function gcd(p, q) {
    if (p % q === 0) {
      return q;
    } else {
      return gcd(q, p % q);
    }
  }

  function f(x) {
    return x * x + 1;
  }

  var x1 = 2, x2 = 2, divisor;
  if (num % 2 === 0) {
    return 2;
  }

  do {
    x1 = f(x1) % num;
    x2 = f(f(x2)) % num;
    divisor = gcd(Math.abs(x1 - x2), num);
  } while (divisor === 1);

  return divisor;
};
  

Pollard Rho Algorithm to find smallest factor of an integer value. There are more efficient algorithms for factorization, but this one is quite efficient and not so complex.

Parameters
num ( Number )
An integer number where the smallest factor should be searched for
method Chartist.getBounds()
    Chartist.getBounds = function (axisLength, highLow, scaleMinSpace, onlyInteger) {
  var i,
    optimizationCounter = 0,
    newMin,
    newMax,
    bounds = {
      high: highLow.high,
      low: highLow.low
    };

  bounds.valueRange = bounds.high - bounds.low;
  bounds.oom = Chartist.orderOfMagnitude(bounds.valueRange);
  bounds.step = Math.pow(10, bounds.oom);
  bounds.min = Math.floor(bounds.low / bounds.step) * bounds.step;
  bounds.max = Math.ceil(bounds.high / bounds.step) * bounds.step;
  bounds.range = bounds.max - bounds.min;
  bounds.numberOfSteps = Math.round(bounds.range / bounds.step);

  // Optimize scale step by checking if subdivision is possible based on horizontalGridMinSpace
  // If we are already below the scaleMinSpace value we will scale up
  var length = Chartist.projectLength(axisLength, bounds.step, bounds);
  var scaleUp = length < scaleMinSpace;
  var smallestFactor = onlyInteger ? Chartist.rho(bounds.range) : 0;

  // First check if we should only use integer steps and if step 1 is still larger than scaleMinSpace so we can use 1
  if(onlyInteger && Chartist.projectLength(axisLength, 1, bounds) >= scaleMinSpace) {
    bounds.step = 1;
  } else if(onlyInteger && smallestFactor < bounds.step && Chartist.projectLength(axisLength, smallestFactor, bounds) >= scaleMinSpace) {
    // If step 1 was too small, we can try the smallest factor of range
    // If the smallest factor is smaller than the current bounds.step and the projected length of smallest factor
    // is larger than the scaleMinSpace we should go for it.
    bounds.step = smallestFactor;
  } else {
    // Trying to divide or multiply by 2 and find the best step value
    while (true) {
      if (scaleUp && Chartist.projectLength(axisLength, bounds.step, bounds) <= scaleMinSpace) {
        bounds.step *= 2;
      } else if (!scaleUp && Chartist.projectLength(axisLength, bounds.step / 2, bounds) >= scaleMinSpace) {
        bounds.step /= 2;
        if(onlyInteger && bounds.step % 1 !== 0) {
          bounds.step *= 2;
          break;
        }
      } else {
        break;
      }

      if(optimizationCounter++ > 1000) {
        throw new Error('Exceeded maximum number of iterations while optimizing scale step!');
      }
    }
  }

  var EPSILON = 2.221E-16;
  bounds.step = Math.max(bounds.step, EPSILON);
  function safeIncrement(value, increment) {
    // If increment is too small use *= (1+EPSILON) as a simple nextafter
    if (value === (value += increment)) {
    	value *= (1 + (increment > 0 ? EPSILON : -EPSILON));
    }
    return value;
  }

  // Narrow min and max based on new step
  newMin = bounds.min;
  newMax = bounds.max;
  while (newMin + bounds.step <= bounds.low) {
  	newMin = safeIncrement(newMin, bounds.step);
  }
  while (newMax - bounds.step >= bounds.high) {
  	newMax = safeIncrement(newMax, -bounds.step);
  }
  bounds.min = newMin;
  bounds.max = newMax;
  bounds.range = bounds.max - bounds.min;

  var values = [];
  for (i = bounds.min; i <= bounds.max; i = safeIncrement(i, bounds.step)) {
    var value = Chartist.roundWithPrecision(i);
    if (value !== values[values.length - 1]) {
      values.push(value);
    }
  }
  bounds.values = values;
  return bounds;
};
  

Calculate and retrieve all the bounds for the chart and return them in one array

Parameters
axisLength ( Number )
The length of the Axis used for
highLow ( Object )
An object containing a high and low property indicating the value range of the chart.
scaleMinSpace ( Number )
The minimum projected length a step should result in
onlyInteger ( Boolean )
Returns
( Object )
All the values to set the bounds of the chart
method Chartist.polarToCartesian()
    Chartist.polarToCartesian = function (centerX, centerY, radius, angleInDegrees) {
  var angleInRadians = (angleInDegrees - 90) * Math.PI / 180.0;

  return {
    x: centerX + (radius * Math.cos(angleInRadians)),
    y: centerY + (radius * Math.sin(angleInRadians))
  };
};
  

Calculate cartesian coordinates of polar coordinates

Parameters
centerX ( Number )
X-axis coordinates of center point of circle segment
centerY ( Number )
X-axis coordinates of center point of circle segment
radius ( Number )
Radius of circle segment
angleInDegrees ( Number )
Angle of circle segment in degrees
Returns
( x:Number )
y:Number}} Coordinates of point on circumference
method Chartist.createChartRect()
    Chartist.createChartRect = function (svg, options, fallbackPadding) {
  var hasAxis = !!(options.axisX || options.axisY);
  var yAxisOffset = hasAxis ? options.axisY.offset : 0;
  var xAxisOffset = hasAxis ? options.axisX.offset : 0;
  // If width or height results in invalid value (including 0) we fallback to the unitless settings or even 0
  var width = svg.width() || Chartist.quantity(options.width).value || 0;
  var height = svg.height() || Chartist.quantity(options.height).value || 0;
  var normalizedPadding = Chartist.normalizePadding(options.chartPadding, fallbackPadding);

  // If settings were to small to cope with offset (legacy) and padding, we'll adjust
  width = Math.max(width, yAxisOffset + normalizedPadding.left + normalizedPadding.right);
  height = Math.max(height, xAxisOffset + normalizedPadding.top + normalizedPadding.bottom);

  var chartRect = {
    padding: normalizedPadding,
    width: function () {
      return this.x2 - this.x1;
    },
    height: function () {
      return this.y1 - this.y2;
    }
  };

  if(hasAxis) {
    if (options.axisX.position === 'start') {
      chartRect.y2 = normalizedPadding.top + xAxisOffset;
      chartRect.y1 = Math.max(height - normalizedPadding.bottom, chartRect.y2 + 1);
    } else {
      chartRect.y2 = normalizedPadding.top;
      chartRect.y1 = Math.max(height - normalizedPadding.bottom - xAxisOffset, chartRect.y2 + 1);
    }

    if (options.axisY.position === 'start') {
      chartRect.x1 = normalizedPadding.left + yAxisOffset;
      chartRect.x2 = Math.max(width - normalizedPadding.right, chartRect.x1 + 1);
    } else {
      chartRect.x1 = normalizedPadding.left;
      chartRect.x2 = Math.max(width - normalizedPadding.right - yAxisOffset, chartRect.x1 + 1);
    }
  } else {
    chartRect.x1 = normalizedPadding.left;
    chartRect.x2 = Math.max(width - normalizedPadding.right, chartRect.x1 + 1);
    chartRect.y2 = normalizedPadding.top;
    chartRect.y1 = Math.max(height - normalizedPadding.bottom, chartRect.y2 + 1);
  }

  return chartRect;
};
  

Initialize chart drawing rectangle (area where chart is drawn) x1,y1 = bottom left / x2,y2 = top right

Parameters
svg ( Object )
The svg element for the chart
options ( Object )
The Object that contains all the optional values for the chart
[fallbackPadding] ( Number )
The fallback padding if partial padding objects are used
Returns
( Object )
The chart rectangles coordinates inside the svg element plus the rectangles measurements
method Chartist.createGrid()
    Chartist.createGrid = function(position, index, axis, offset, length, group, classes, eventEmitter) {
  var positionalData = {};
  positionalData[axis.units.pos + '1'] = position;
  positionalData[axis.units.pos + '2'] = position;
  positionalData[axis.counterUnits.pos + '1'] = offset;
  positionalData[axis.counterUnits.pos + '2'] = offset + length;

  var gridElement = group.elem('line', positionalData, classes.join(' '));

  // Event for grid draw
  eventEmitter.emit('draw',
    Chartist.extend({
      type: 'grid',
      axis: axis,
      index: index,
      group: group,
      element: gridElement
    }, positionalData)
  );
};
  

Creates a grid line based on a projected value.

Parameters
( position )
( index )
( axis )
( offset )
( length )
( group )
( classes )
( eventEmitter )
method Chartist.createGridBackground()
    Chartist.createGridBackground = function (gridGroup, chartRect, className, eventEmitter) {
  var gridBackground = gridGroup.elem('rect', {
      x: chartRect.x1,
      y: chartRect.y2,
      width: chartRect.width(),
      height: chartRect.height(),
    }, className, true);

    // Event for grid background draw
    eventEmitter.emit('draw', {
      type: 'gridBackground',
      group: gridGroup,
      element: gridBackground
    });
};
  

Creates a grid background rect and emits the draw event.

Parameters
( gridGroup )
( chartRect )
( className )
( eventEmitter )
method Chartist.createLabel()
    Chartist.createLabel = function(position, length, index, labels, axis, axisOffset, labelOffset, group, classes, useForeignObject, eventEmitter) {
  var labelElement;
  var positionalData = {};

  positionalData[axis.units.pos] = position + labelOffset[axis.units.pos];
  positionalData[axis.counterUnits.pos] = labelOffset[axis.counterUnits.pos];
  positionalData[axis.units.len] = length;
  positionalData[axis.counterUnits.len] = Math.max(0, axisOffset - 10);

  if(useForeignObject) {
    // We need to set width and height explicitly to px as span will not expand with width and height being
    // 100% in all browsers
    var content = '<span class="' + classes.join(' ') + '" style="' +
      axis.units.len + ': ' + Math.round(positionalData[axis.units.len]) + 'px; ' +
      axis.counterUnits.len + ': ' + Math.round(positionalData[axis.counterUnits.len]) + 'px">' +
      labels[index] + '</span>';

    labelElement = group.foreignObject(content, Chartist.extend({
      style: 'overflow: visible;'
    }, positionalData));
  } else {
    labelElement = group.elem('text', positionalData, classes.join(' ')).text(labels[index]);
  }

  eventEmitter.emit('draw', Chartist.extend({
    type: 'label',
    axis: axis,
    index: index,
    group: group,
    element: labelElement,
    text: labels[index]
  }, positionalData));
};
  

Creates a label based on a projected value and an axis.

Parameters
( position )
( length )
( index )
( labels )
( axis )
( axisOffset )
( labelOffset )
( group )
( classes )
( useForeignObject )
( eventEmitter )
method Chartist.optionsProvider()
    Chartist.optionsProvider = function (options, responsiveOptions, eventEmitter) {
  var baseOptions = Chartist.extend({}, options),
    currentOptions,
    mediaQueryListeners = [],
    i;

  function updateCurrentOptions(mediaEvent) {
    var previousOptions = currentOptions;
    currentOptions = Chartist.extend({}, baseOptions);

    if (responsiveOptions) {
      for (i = 0; i < responsiveOptions.length; i++) {
        var mql = window.matchMedia(responsiveOptions[i][0]);
        if (mql.matches) {
          currentOptions = Chartist.extend(currentOptions, responsiveOptions[i][1]);
        }
      }
    }

    if(eventEmitter && mediaEvent) {
      eventEmitter.emit('optionsChanged', {
        previousOptions: previousOptions,
        currentOptions: currentOptions
      });
    }
  }

  function removeMediaQueryListeners() {
    mediaQueryListeners.forEach(function(mql) {
      mql.removeListener(updateCurrentOptions);
    });
  }

  if (!window.matchMedia) {
    throw 'window.matchMedia not found! Make sure you\'re using a polyfill.';
  } else if (responsiveOptions) {

    for (i = 0; i < responsiveOptions.length; i++) {
      var mql = window.matchMedia(responsiveOptions[i][0]);
      mql.addListener(updateCurrentOptions);
      mediaQueryListeners.push(mql);
    }
  }
  // Execute initially without an event argument so we get the correct options
  updateCurrentOptions();

  return {
    removeMediaQueryListeners: removeMediaQueryListeners,
    getCurrentOptions: function getCurrentOptions() {
      return Chartist.extend({}, currentOptions);
    }
  };
};


/**
 * Splits a list of coordinates and associated values into segments. Each returned segment contains a pathCoordinates
 * valueData property describing the segment.
 *
 * With the default options, segments consist of contiguous sets of points that do not have an undefined value. Any
 * points with undefined values are discarded.
 *
 * **Options**
 * The following options are used to determine how segments are formed
 * ```javascript
 * var options = {
 *   // If fillHoles is true, undefined values are simply discarded without creating a new segment. Assuming other options are default, this returns single segment.
 *   fillHoles: false,
 *   // If increasingX is true, the coordinates in all segments have strictly increasing x-values.
 *   increasingX: false
 * };
 * ```
 *
 * @memberof Chartist.Core
 * @param {Array} pathCoordinates List of point coordinates to be split in the form [x1, y1, x2, y2 ... xn, yn]
 * @param {Array} values List of associated point values in the form [v1, v2 .. vn]
 * @param {Object} options Options set by user
 * @return {Array} List of segments, each containing a pathCoordinates and valueData property.
 */
Chartist.splitIntoSegments = function(pathCoordinates, valueData, options) {
  var defaultOptions = {
    increasingX: false,
    fillHoles: false
  };

  options = Chartist.extend({}, defaultOptions, options);

  var segments = [];
  var hole = true;

  for(var i = 0; i < pathCoordinates.length; i += 2) {
    // If this value is a "hole" we set the hole flag
    if(Chartist.getMultiValue(valueData[i / 2].value) === undefined) {
    // if(valueData[i / 2].value === undefined) {
      if(!options.fillHoles) {
        hole = true;
      }
    } else {
      if(options.increasingX && i >= 2 && pathCoordinates[i] <= pathCoordinates[i-2]) {
        // X is not increasing, so we need to make sure we start a new segment
        hole = true;
      }


      // If it's a valid value we need to check if we're coming out of a hole and create a new empty segment
      if(hole) {
        segments.push({
          pathCoordinates: [],
          valueData: []
        });
        // As we have a valid value now, we are not in a "hole" anymore
        hole = false;
      }

      // Add to the segment pathCoordinates and valueData
      segments[segments.length - 1].pathCoordinates.push(pathCoordinates[i], pathCoordinates[i + 1]);
      segments[segments.length - 1].valueData.push(valueData[i / 2]);
    }
  }

  return segments;
};
}(window, document, Chartist));
  

Provides options handling functionality with callback for options changes triggered by responsive options and media query matches

Parameters
options ( Object )
Options set by user
responsiveOptions ( Array )
Optional functions to add responsive behavior to chart
eventEmitter ( Object )
The event emitter that will be used to emit the options changed events
Returns
( Object )
The consolidated options object from the defaults, base and matching responsive options

event.js

Module Chartist.Event

A very basic event module that helps to generate and catch events.

function addEventHandler()
    function addEventHandler(event, handler) {
  handlers[event] = handlers[event] || [];
  handlers[event].push(handler);
}
  

Add an event handler for a specific event

Parameters
event ( String )
The event name
handler ( Function )
A event handler function
function removeEventHandler()
    function removeEventHandler(event, handler) {
  // Only do something if there are event handlers with this name existing
  if(handlers[event]) {
    // If handler is set we will look for a specific handler and only remove this
    if(handler) {
      handlers[event].splice(handlers[event].indexOf(handler), 1);
      if(handlers[event].length === 0) {
        delete handlers[event];
      }
    } else {
      // If no handler is specified we remove all handlers for this event
      delete handlers[event];
    }
  }
}
  

Remove an event handler of a specific event name or remove all event handlers for a specific event.

Parameters
event ( String )
The event name where a specific or all handlers should be removed
[handler] ( Function )
An optional event handler function. If specified only this specific handler will be removed and otherwise all handlers are removed.
function emit()
    function emit(event, data) {
  // Only do something if there are event handlers with this name existing
  if(handlers[event]) {
    handlers[event].forEach(function(handler) {
      handler(data);
    });
  }

  // Emit event to star event handlers
  if(handlers['*']) {
    handlers['*'].forEach(function(starHandler) {
      starHandler(event, data);
    });
  }
}

return {
  addEventHandler: addEventHandler,
  removeEventHandler: removeEventHandler,
  emit: emit
};
  };

}(window, document, Chartist));
  

Use this function to emit an event. All handlers that are listening for this event will be triggered with the data parameter.

Parameters
event ( String )
The event name that should be triggered
data ( * )
Arbitrary data that will be passed to the event handler callback functions

interpolation.js

Module Chartist.Interpolation

Chartist path interpolation functions.

method Chartist.Interpolation.none()
    Chartist.Interpolation.none = function(options) {
  var defaultOptions = {
    fillHoles: false
  };
  options = Chartist.extend({}, defaultOptions, options);
  return function none(pathCoordinates, valueData) {
    var path = new Chartist.Svg.Path();
    var hole = true;

    for(var i = 0; i < pathCoordinates.length; i += 2) {
      var currX = pathCoordinates[i];
      var currY = pathCoordinates[i + 1];
      var currData = valueData[i / 2];

      if(Chartist.getMultiValue(currData.value) !== undefined) {

        if(hole) {
          path.move(currX, currY, false, currData);
        } else {
          path.line(currX, currY, false, currData);
        }

        hole = false;
      } else if(!options.fillHoles) {
        hole = true;
      }
    }

    return path;
  };
};
  

This interpolation function does not smooth the path and the result is only containing lines and no curves.

Returns
( Function )
Examples
var chart = new Chartist.Line('.ct-chart', {
  labels: [1, 2, 3, 4, 5],
  series: [[1, 2, 8, 1, 7]]
}, {
  lineSmooth: Chartist.Interpolation.none({
    fillHoles: false
  })
});

method Chartist.Interpolation.simple()
    Chartist.Interpolation.simple = function(options) {
  var defaultOptions = {
    divisor: 2,
    fillHoles: false
  };
  options = Chartist.extend({}, defaultOptions, options);

  var d = 1 / Math.max(1, options.divisor);

  return function simple(pathCoordinates, valueData) {
    var path = new Chartist.Svg.Path();
    var prevX, prevY, prevData;

    for(var i = 0; i < pathCoordinates.length; i += 2) {
      var currX = pathCoordinates[i];
      var currY = pathCoordinates[i + 1];
      var length = (currX - prevX) * d;
      var currData = valueData[i / 2];

      if(currData.value !== undefined) {

        if(prevData === undefined) {
          path.move(currX, currY, false, currData);
        } else {
          path.curve(
            prevX + length,
            prevY,
            currX - length,
            currY,
            currX,
            currY,
            false,
            currData
          );
        }

        prevX = currX;
        prevY = currY;
        prevData = currData;
      } else if(!options.fillHoles) {
        prevX = currX = prevData = undefined;
      }
    }

    return path;
  };
};
  

Simple smoothing creates horizontal handles that are positioned with a fraction of the length between two data points. You can use the divisor option to specify the amount of smoothing.

Parameters
options ( Object )
The options of the simple interpolation factory function.
Returns
( Function )
Examples
var chart = new Chartist.Line('.ct-chart', {
  labels: [1, 2, 3, 4, 5],
  series: [[1, 2, 8, 1, 7]]
}, {
  lineSmooth: Chartist.Interpolation.simple({
    divisor: 2,
    fillHoles: false
  })
});

method Chartist.Interpolation.cardinal()
    Chartist.Interpolation.cardinal = function(options) {
  var defaultOptions = {
    tension: 1,
    fillHoles: false
  };

  options = Chartist.extend({}, defaultOptions, options);

  var t = Math.min(1, Math.max(0, options.tension)),
    c = 1 - t;

  return function cardinal(pathCoordinates, valueData) {
    // First we try to split the coordinates into segments
    // This is necessary to treat "holes" in line charts
    var segments = Chartist.splitIntoSegments(pathCoordinates, valueData, {
      fillHoles: options.fillHoles
    });

    if(!segments.length) {
      // If there were no segments return 'Chartist.Interpolation.none'
      return Chartist.Interpolation.none()([]);
    } else if(segments.length > 1) {
      // If the split resulted in more that one segment we need to interpolate each segment individually and join them
      // afterwards together into a single path.
        var paths = [];
      // For each segment we will recurse the cardinal function
      segments.forEach(function(segment) {
        paths.push(cardinal(segment.pathCoordinates, segment.valueData));
      });
      // Join the segment path data into a single path and return
      return Chartist.Svg.Path.join(paths);
    } else {
      // If there was only one segment we can proceed regularly by using pathCoordinates and valueData from the first
      // segment
      pathCoordinates = segments[0].pathCoordinates;
      valueData = segments[0].valueData;

      // If less than two points we need to fallback to no smoothing
      if(pathCoordinates.length <= 4) {
        return Chartist.Interpolation.none()(pathCoordinates, valueData);
      }

      var path = new Chartist.Svg.Path().move(pathCoordinates[0], pathCoordinates[1], false, valueData[0]),
        z;

      for (var i = 0, iLen = pathCoordinates.length; iLen - 2 * !z > i; i += 2) {
        var p = [
          {x: +pathCoordinates[i - 2], y: +pathCoordinates[i - 1]},
          {x: +pathCoordinates[i], y: +pathCoordinates[i + 1]},
          {x: +pathCoordinates[i + 2], y: +pathCoordinates[i + 3]},
          {x: +pathCoordinates[i + 4], y: +pathCoordinates[i + 5]}
        ];
        if (z) {
          if (!i) {
            p[0] = {x: +pathCoordinates[iLen - 2], y: +pathCoordinates[iLen - 1]};
          } else if (iLen - 4 === i) {
            p[3] = {x: +pathCoordinates[0], y: +pathCoordinates[1]};
          } else if (iLen - 2 === i) {
            p[2] = {x: +pathCoordinates[0], y: +pathCoordinates[1]};
            p[3] = {x: +pathCoordinates[2], y: +pathCoordinates[3]};
          }
        } else {
          if (iLen - 4 === i) {
            p[3] = p[2];
          } else if (!i) {
            p[0] = {x: +pathCoordinates[i], y: +pathCoordinates[i + 1]};
          }
        }

        path.curve(
          (t * (-p[0].x + 6 * p[1].x + p[2].x) / 6) + (c * p[2].x),
          (t * (-p[0].y + 6 * p[1].y + p[2].y) / 6) + (c * p[2].y),
          (t * (p[1].x + 6 * p[2].x - p[3].x) / 6) + (c * p[2].x),
          (t * (p[1].y + 6 * p[2].y - p[3].y) / 6) + (c * p[2].y),
          p[2].x,
          p[2].y,
          false,
          valueData[(i + 2) / 2]
        );
      }

      return path;
    }
  };
};
  

Cardinal / Catmull-Rome spline interpolation is the default smoothing function in Chartist. It produces nice results where the splines will always meet the points. It produces some artifacts though when data values are increased or decreased rapidly. The line may not follow a very accurate path and if the line should be accurate this smoothing function does not produce the best results.

Parameters
options ( Object )
The options of the cardinal factory function.
Returns
( Function )
Examples
var chart = new Chartist.Line('.ct-chart', {
  labels: [1, 2, 3, 4, 5],
  series: [[1, 2, 8, 1, 7]]
}, {
  lineSmooth: Chartist.Interpolation.cardinal({
    tension: 1,
    fillHoles: false
  })
});
method Chartist.Interpolation.monotoneCubic()
    Chartist.Interpolation.monotoneCubic = function(options) {
  var defaultOptions = {
    fillHoles: false
  };

  options = Chartist.extend({}, defaultOptions, options);

  return function monotoneCubic(pathCoordinates, valueData) {
    // First we try to split the coordinates into segments
    // This is necessary to treat "holes" in line charts
    var segments = Chartist.splitIntoSegments(pathCoordinates, valueData, {
      fillHoles: options.fillHoles,
      increasingX: true
    });

    if(!segments.length) {
      // If there were no segments return 'Chartist.Interpolation.none'
      return Chartist.Interpolation.none()([]);
    } else if(segments.length > 1) {
      // If the split resulted in more that one segment we need to interpolate each segment individually and join them
      // afterwards together into a single path.
        var paths = [];
      // For each segment we will recurse the monotoneCubic fn function
      segments.forEach(function(segment) {
        paths.push(monotoneCubic(segment.pathCoordinates, segment.valueData));
      });
      // Join the segment path data into a single path and return
      return Chartist.Svg.Path.join(paths);
    } else {
      // If there was only one segment we can proceed regularly by using pathCoordinates and valueData from the first
      // segment
      pathCoordinates = segments[0].pathCoordinates;
      valueData = segments[0].valueData;

      // If less than three points we need to fallback to no smoothing
      if(pathCoordinates.length <= 4) {
        return Chartist.Interpolation.none()(pathCoordinates, valueData);
      }

      var xs = [],
        ys = [],
        i,
        n = pathCoordinates.length / 2,
        ms = [],
        ds = [], dys = [], dxs = [],
        path;

      // Populate x and y coordinates into separate arrays, for readability

      for(i = 0; i < n; i++) {
        xs[i] = pathCoordinates[i * 2];
        ys[i] = pathCoordinates[i * 2 + 1];
      }

      // Calculate deltas and derivative

      for(i = 0; i < n - 1; i++) {
        dys[i] = ys[i + 1] - ys[i];
        dxs[i] = xs[i + 1] - xs[i];
        ds[i] = dys[i] / dxs[i];
      }

      // Determine desired slope (m) at each point using Fritsch-Carlson method
      // See: http://math.stackexchange.com/questions/45218/implementation-of-monotone-cubic-interpolation

      ms[0] = ds[0];
      ms[n - 1] = ds[n - 2];

      for(i = 1; i < n - 1; i++) {
        if(ds[i] === 0 || ds[i - 1] === 0 || (ds[i - 1] > 0) !== (ds[i] > 0)) {
          ms[i] = 0;
        } else {
          ms[i] = 3 * (dxs[i - 1] + dxs[i]) / (
            (2 * dxs[i] + dxs[i - 1]) / ds[i - 1] +
            (dxs[i] + 2 * dxs[i - 1]) / ds[i]);

          if(!isFinite(ms[i])) {
            ms[i] = 0;
          }
        }
      }

      // Now build a path from the slopes

      path = new Chartist.Svg.Path().move(xs[0], ys[0], false, valueData[0]);

      for(i = 0; i < n - 1; i++) {
        path.curve(
          // First control point
          xs[i] + dxs[i] / 3,
          ys[i] + ms[i] * dxs[i] / 3,
          // Second control point
          xs[i + 1] - dxs[i] / 3,
          ys[i + 1] - ms[i + 1] * dxs[i] / 3,
          // End point
          xs[i + 1],
          ys[i + 1],

          false,
          valueData[i + 1]
        );
      }

      return path;
    }
  };
};
  

Monotone Cubic spline interpolation produces a smooth curve which preserves monotonicity. Unlike cardinal splines, the curve will not extend beyond the range of y-values of the original data points.

Parameters
options ( Object )
The options of the monotoneCubic factory function.
Returns
( Function )
Examples
var chart = new Chartist.Line('.ct-chart', {
  labels: [1, 2, 3, 4, 5],
  series: [[1, 2, 8, 1, 7]]
}, {
  lineSmooth: Chartist.Interpolation.monotoneCubic({
    fillHoles: false
  })
});
method Chartist.Interpolation.step()
    Chartist.Interpolation.step = function(options) {
  var defaultOptions = {
    postpone: true,
    fillHoles: false
  };

  options = Chartist.extend({}, defaultOptions, options);

  return function step(pathCoordinates, valueData) {
    var path = new Chartist.Svg.Path();

    var prevX, prevY, prevData;

    for (var i = 0; i < pathCoordinates.length; i += 2) {
      var currX = pathCoordinates[i];
      var currY = pathCoordinates[i + 1];
      var currData = valueData[i / 2];

      // If the current point is also not a hole we can draw the step lines
      if(currData.value !== undefined) {
        if(prevData === undefined) {
          path.move(currX, currY, false, currData);
        } else {
          if(options.postpone) {
            // If postponed we should draw the step line with the value of the previous value
            path.line(currX, prevY, false, prevData);
          } else {
            // If not postponed we should draw the step line with the value of the current value
            path.line(prevX, currY, false, currData);
          }
          // Line to the actual point (this should only be a Y-Axis movement
          path.line(currX, currY, false, currData);
        }

        prevX = currX;
        prevY = currY;
        prevData = currData;
      } else if(!options.fillHoles) {
        prevX = prevY = prevData = undefined;
      }
    }

    return path;
  };
};

}(window, document, Chartist));
  

Step interpolation will cause the line chart to move in steps rather than diagonal or smoothed lines. This interpolation will create additional points that will also be drawn when the showPoint option is enabled.

Parameters
( options )
Examples
var chart = new Chartist.Line('.ct-chart', {
  labels: [1, 2, 3, 4, 5],
  series: [[1, 2, 8, 1, 7]]
}, {
  lineSmooth: Chartist.Interpolation.step({
    postpone: true,
    fillHoles: false
  })
});

svg-path.js

Module Chartist.Svg.Path

Chartist SVG path module for SVG path description creation and modification.

declaration elementDescriptions
    var elementDescriptions = {
  m: ['x', 'y'],
  l: ['x', 'y'],
  c: ['x1', 'y1', 'x2', 'y2', 'x', 'y'],
  a: ['rx', 'ry', 'xAr', 'lAf', 'sf', 'x', 'y']
};
  

Contains the descriptors of supported element types in a SVG path. Currently only move, line and curve are supported.

declaration defaultOptions
    var defaultOptions = {
  // The accuracy in digit count after the decimal point. This will be used to round numbers in the SVG path. If this option is set to false then no rounding will be performed.
  accuracy: 3
};

function element(command, params, pathElements, pos, relative, data) {
  var pathElement = Chartist.extend({
    command: relative ? command.toLowerCase() : command.toUpperCase()
  }, params, data ? { data: data } : {} );

  pathElements.splice(pos, 0, pathElement);
}

function forEachParam(pathElements, cb) {
  pathElements.forEach(function(pathElement, pathElementIndex) {
    elementDescriptions[pathElement.command.toLowerCase()].forEach(function(paramName, paramIndex) {
      cb(pathElement, paramName, pathElementIndex, paramIndex, pathElements);
    });
  });
}
  

Default options for newly created SVG path objects.

constructor SvgPath()
    function SvgPath(close, options) {
  this.pathElements = [];
  this.pos = 0;
  this.close = close;
  this.options = Chartist.extend({}, defaultOptions, options);
}
  

Used to construct a new path object.

Parameters
close ( Boolean )
If set to true then this path will be closed when stringified (with a Z at the end)
options ( Object )
Options object that overrides the default objects. See default options for more details.
function position()
    function position(pos) {
  if(pos !== undefined) {
    this.pos = Math.max(0, Math.min(this.pathElements.length, pos));
    return this;
  } else {
    return this.pos;
  }
}
  

Gets or sets the current position (cursor) inside of the path. You can move around the cursor freely but limited to 0 or the count of existing elements. All modifications with element functions will insert new elements at the position of this cursor.

Parameters
[pos] ( Number )
If a number is passed then the cursor is set to this position in the path element array.
Returns
( Chartist.Svg.Path Number )
If the position parameter was passed then the return value will be the path object for easy call chaining. If no position parameter was passed then the current position is returned.
function remove()
    function remove(count) {
  this.pathElements.splice(this.pos, count);
  return this;
}
  

Removes elements from the path starting at the current position.

Parameters
count ( Number )
Number of path elements that should be removed from the current position.
Returns
( Chartist.Svg.Path )
The current path object for easy call chaining.
function move()
    function move(x, y, relative, data) {
  element('M', {
    x: +x,
    y: +y
  }, this.pathElements, this.pos++, relative, data);
  return this;
}
  

Use this function to add a new move SVG path element.

Parameters
x ( Number )
The x coordinate for the move element.
y ( Number )
The y coordinate for the move element.
[relative] ( Boolean )
If set to true the move element will be created with relative coordinates (lowercase letter)
[data] ( * )
Any data that should be stored with the element object that will be accessible in pathElement
Returns
( Chartist.Svg.Path )
The current path object for easy call chaining.
function line()
    function line(x, y, relative, data) {
  element('L', {
    x: +x,
    y: +y
  }, this.pathElements, this.pos++, relative, data);
  return this;
}
  

Use this function to add a new line SVG path element.

Parameters
x ( Number )
The x coordinate for the line element.
y ( Number )
The y coordinate for the line element.
[relative] ( Boolean )
If set to true the line element will be created with relative coordinates (lowercase letter)
[data] ( * )
Any data that should be stored with the element object that will be accessible in pathElement
Returns
( Chartist.Svg.Path )
The current path object for easy call chaining.
function curve()
    function curve(x1, y1, x2, y2, x, y, relative, data) {
  element('C', {
    x1: +x1,
    y1: +y1,
    x2: +x2,
    y2: +y2,
    x: +x,
    y: +y
  }, this.pathElements, this.pos++, relative, data);
  return this;
}
  

Use this function to add a new curve SVG path element.

Parameters
x1 ( Number )
The x coordinate for the first control point of the bezier curve.
y1 ( Number )
The y coordinate for the first control point of the bezier curve.
x2 ( Number )
The x coordinate for the second control point of the bezier curve.
y2 ( Number )
The y coordinate for the second control point of the bezier curve.
x ( Number )
The x coordinate for the target point of the curve element.
y ( Number )
The y coordinate for the target point of the curve element.
[relative] ( Boolean )
If set to true the curve element will be created with relative coordinates (lowercase letter)
[data] ( * )
Any data that should be stored with the element object that will be accessible in pathElement
Returns
( Chartist.Svg.Path )
The current path object for easy call chaining.
function arc()
    function arc(rx, ry, xAr, lAf, sf, x, y, relative, data) {
  element('A', {
    rx: +rx,
    ry: +ry,
    xAr: +xAr,
    lAf: +lAf,
    sf: +sf,
    x: +x,
    y: +y
  }, this.pathElements, this.pos++, relative, data);
  return this;
}
  

Use this function to add a new non-bezier curve SVG path element.

Parameters
rx ( Number )
The radius to be used for the x-axis of the arc.
ry ( Number )
The radius to be used for the y-axis of the arc.
xAr ( Number )
Defines the orientation of the arc
lAf ( Number )
Large arc flag
sf ( Number )
Sweep flag
x ( Number )
The x coordinate for the target point of the curve element.
y ( Number )
The y coordinate for the target point of the curve element.
[relative] ( Boolean )
If set to true the curve element will be created with relative coordinates (lowercase letter)
[data] ( * )
Any data that should be stored with the element object that will be accessible in pathElement
Returns
( Chartist.Svg.Path )
The current path object for easy call chaining.
function parse()
    function parse(path) {
  // Parsing the SVG path string into an array of arrays [['M', '10', '10'], ['L', '100', '100']]
  var chunks = path.replace(/([A-Za-z])([0-9])/g, '$1 $2')
    .replace(/([0-9])([A-Za-z])/g, '$1 $2')
    .split(/[\s,]+/)
    .reduce(function(result, element) {
      if(element.match(/[A-Za-z]/)) {
        result.push([]);
      }

      result[result.length - 1].push(element);
      return result;
    }, []);

  // If this is a closed path we remove the Z at the end because this is determined by the close option
  if(chunks[chunks.length - 1][0].toUpperCase() === 'Z') {
    chunks.pop();
  }

  // Using svgPathElementDescriptions to map raw path arrays into objects that contain the command and the parameters
  // For example {command: 'M', x: '10', y: '10'}
  var elements = chunks.map(function(chunk) {
      var command = chunk.shift(),
        description = elementDescriptions[command.toLowerCase()];

      return Chartist.extend({
        command: command
      }, description.reduce(function(result, paramName, index) {
        result[paramName] = +chunk[index];
        return result;
      }, {}));
    });

  // Preparing a splice call with the elements array as var arg params and insert the parsed elements at the current position
  var spliceArgs = [this.pos, 0];
  Array.prototype.push.apply(spliceArgs, elements);
  Array.prototype.splice.apply(this.pathElements, spliceArgs);
  // Increase the internal position by the element count
  this.pos += elements.length;

  return this;
}
  

Parses an SVG path seen in the d attribute of path elements, and inserts the parsed elements into the existing path object at the current cursor position. Any closing path indicators (Z at the end of the path) will be ignored by the parser as this is provided by the close option in the options of the path object.

Parameters
path ( String )
Any SVG path that contains move (m), line (l) or curve (c) components.
Returns
( Chartist.Svg.Path )
The current path object for easy call chaining.
function stringify()
    function stringify() {
  var accuracyMultiplier = Math.pow(10, this.options.accuracy);

  return this.pathElements.reduce(function(path, pathElement) {
      var params = elementDescriptions[pathElement.command.toLowerCase()].map(function(paramName) {
        return this.options.accuracy ?
          (Math.round(pathElement[paramName] * accuracyMultiplier) / accuracyMultiplier) :
          pathElement[paramName];
      }.bind(this));

      return path + pathElement.command + params.join(',');
    }.bind(this), '') + (this.close ? 'Z' : '');
}
  

This function renders to current SVG path object into a final SVG string that can be used in the d attribute of SVG path elements. It uses the accuracy option to round big decimals. If the close parameter was set in the constructor of this path object then a path closing Z will be appended to the output string.

Returns
( String )
function scale()
    function scale(x, y) {
  forEachParam(this.pathElements, function(pathElement, paramName) {
    pathElement[paramName] *= paramName[0] === 'x' ? x : y;
  });
  return this;
}
  

Scales all elements in the current SVG path object. There is an individual parameter for each coordinate. Scaling will also be done for control points of curves, affecting the given coordinate.

Parameters
x ( Number )
The number which will be used to scale the x, x1 and x2 of all path elements.
y ( Number )
The number which will be used to scale the y, y1 and y2 of all path elements.
Returns
( Chartist.Svg.Path )
The current path object for easy call chaining.
function translate()
    function translate(x, y) {
  forEachParam(this.pathElements, function(pathElement, paramName) {
    pathElement[paramName] += paramName[0] === 'x' ? x : y;
  });
  return this;
}
  

Translates all elements in the current SVG path object. The translation is relative and there is an individual parameter for each coordinate. Translation will also be done for control points of curves, affecting the given coordinate.

Parameters
x ( Number )
The number which will be used to translate the x, x1 and x2 of all path elements.
y ( Number )
The number which will be used to translate the y, y1 and y2 of all path elements.
Returns
( Chartist.Svg.Path )
The current path object for easy call chaining.
function transform()
    function transform(transformFnc) {
  forEachParam(this.pathElements, function(pathElement, paramName, pathElementIndex, paramIndex, pathElements) {
    var transformed = transformFnc(pathElement, paramName, pathElementIndex, paramIndex, pathElements);
    if(transformed || transformed === 0) {
      pathElement[paramName] = transformed;
    }
  });
  return this;
}
  

This function will run over all existing path elements and then loop over their attributes. The callback function will be called for every path element attribute that exists in the current path.
The method signature of the callback function looks like this:

function(pathElement, paramName, pathElementIndex, paramIndex, pathElements)

If something else than undefined is returned by the callback function, this value will be used to replace the old value. This allows you to build custom transformations of path objects that can't be achieved using the basic transformation functions scale and translate.

Parameters
transformFnc ( Function )
The callback function for the transformation. Check the signature in the function description.
Returns
( Chartist.Svg.Path )
The current path object for easy call chaining.
function clone()
    function clone(close) {
  var c = new Chartist.Svg.Path(close || this.close);
  c.pos = this.pos;
  c.pathElements = this.pathElements.slice().map(function cloneElements(pathElement) {
    return Chartist.extend({}, pathElement);
  });
  c.options = Chartist.extend({}, this.options);
  return c;
}
  

This function clones a whole path object with all its properties. This is a deep clone and path element objects will also be cloned.

Parameters
[close] ( Boolean )
Optional option to set the new cloned path to closed. If not specified or false, the original path close option will be used.
Returns
( Chartist.Svg.Path )
function splitByCommand()
    function splitByCommand(command) {
  var split = [
    new Chartist.Svg.Path()
  ];

  this.pathElements.forEach(function(pathElement) {
    if(pathElement.command === command.toUpperCase() && split[split.length - 1].pathElements.length !== 0) {
      split.push(new Chartist.Svg.Path());
    }

    split[split.length - 1].pathElements.push(pathElement);
  });

  return split;
}
  

Split a Svg.Path object by a specific command in the path chain. The path chain will be split and an array of newly created paths objects will be returned. This is useful if you'd like to split an SVG path by it's move commands, for example, in order to isolate chunks of drawings.

Parameters
command ( String )
The command you'd like to use to split the path
Returns
( Array<Chartist.Svg.Path> )
function join()
    function join(paths, close, options) {
  var joinedPath = new Chartist.Svg.Path(close, options);
  for(var i = 0; i < paths.length; i++) {
    var path = paths[i];
    for(var j = 0; j < path.pathElements.length; j++) {
      joinedPath.pathElements.push(path.pathElements[j]);
    }
  }
  return joinedPath;
}

Chartist.Svg.Path = Chartist.Class.extend({
  constructor: SvgPath,
  position: position,
  remove: remove,
  move: move,
  line: line,
  curve: curve,
  arc: arc,
  scale: scale,
  translate: translate,
  transform: transform,
  parse: parse,
  stringify: stringify,
  clone: clone,
  splitByCommand: splitByCommand
});

Chartist.Svg.Path.elementDescriptions = elementDescriptions;
Chartist.Svg.Path.join = join;
}(window, document, Chartist));
  

This static function on Chartist.Svg.Path is joining multiple paths together into one paths.

Parameters
paths ( Array<Chartist.Svg.Path> )
A list of paths to be joined together. The order is important.
close ( boolean )
If the newly created path should be a closed path
options ( Object )
Path options for the newly created path.
Returns
( Chartist.Svg.Path )

svg.js

Module Chartist.Svg

Chartist SVG module for simple SVG DOM abstraction

constructor Svg()
    function Svg(name, attributes, className, parent, insertFirst) {
  // If Svg is getting called with an SVG element we just return the wrapper
  if(name instanceof Element) {
    this._node = name;
  } else {
    this._node = document.createElementNS(Chartist.namespaces.svg, name);

    // If this is an SVG element created then custom namespace
    if(name === 'svg') {
      this.attr({
        'xmlns:ct': Chartist.namespaces.ct
      });
    }
  }

  if(attributes) {
    this.attr(attributes);
  }

  if(className) {
    this.addClass(className);
  }

  if(parent) {
    if (insertFirst && parent._node.firstChild) {
      parent._node.insertBefore(this._node, parent._node.firstChild);
    } else {
      parent._node.appendChild(this._node);
    }
  }
}
  

Chartist.Svg creates a new SVG object wrapper with a starting element. You can use the wrapper to fluently create sub-elements and modify them.

Parameters
name ( String Element )
The name of the SVG element to create or an SVG dom element which should be wrapped into Chartist.Svg
attributes ( Object )
An object with properties that will be added as attributes to the SVG element that is created. Attributes with undefined values will not be added.
className ( String )
This class or class list will be added to the SVG element
parent ( Object )
The parent SVG wrapper object where this newly created wrapper and it's element will be attached to as child
insertFirst ( Boolean )
If this param is set to true in conjunction with a parent element the newly created element will be added as first child element in the parent element
function attr()
    function attr(attributes, ns) {
  if(typeof attributes === 'string') {
    if(ns) {
      return this._node.getAttributeNS(ns, attributes);
    } else {
      return this._node.getAttribute(attributes);
    }
  }

  Object.keys(attributes).forEach(function(key) {
    // If the attribute value is undefined we can skip this one
    if(attributes[key] === undefined) {
      return;
    }

    if (key.indexOf(':') !== -1) {
      var namespacedAttribute = key.split(':');
      this._node.setAttributeNS(Chartist.namespaces[namespacedAttribute[0]], key, attributes[key]);
    } else {
      this._node.setAttribute(key, attributes[key]);
    }
  }.bind(this));

  return this;
}
  

Set attributes on the current SVG element of the wrapper you're currently working on.

Parameters
attributes ( Object String )
An object with properties that will be added as attributes to the SVG element that is created. Attributes with undefined values will not be added. If this parameter is a String then the function is used as a getter and will return the attribute value.
[ns] ( String )
If specified, the attribute will be obtained using getAttributeNs. In order to write namepsaced attributes you can use the namespace:attribute notation within the attributes object.
Returns
( Object String )
The current wrapper object will be returned so it can be used for chaining or the attribute value if used as getter function.
function elem()
    function elem(name, attributes, className, insertFirst) {
  return new Chartist.Svg(name, attributes, className, this, insertFirst);
}
  

Create a new SVG element whose wrapper object will be selected for further operations. This way you can also create nested groups easily.

Parameters
name ( String )
The name of the SVG element that should be created as child element of the currently selected element wrapper
[attributes] ( Object )
An object with properties that will be added as attributes to the SVG element that is created. Attributes with undefined values will not be added.
[className] ( String )
This class or class list will be added to the SVG element
[insertFirst] ( Boolean )
If this param is set to true in conjunction with a parent element the newly created element will be added as first child element in the parent element
Returns
( Chartist.Svg )
Returns a Chartist.Svg wrapper object that can be used to modify the containing SVG data
function parent()
    function parent() {
  return this._node.parentNode instanceof SVGElement ? new Chartist.Svg(this._node.parentNode) : null;
}
  

Returns the parent Chartist.SVG wrapper object

Returns
( Chartist.Svg )
Returns a Chartist.Svg wrapper around the parent node of the current node. If the parent node is not existing or it's not an SVG node then this function will return null.
function root()
    function root() {
  var node = this._node;
  while(node.nodeName !== 'svg') {
    node = node.parentNode;
  }
  return new Chartist.Svg(node);
}
  

This method returns a Chartist.Svg wrapper around the root SVG element of the current tree.

Returns
( Chartist.Svg )
The root SVG element wrapped in a Chartist.Svg element
function querySelector()
    function querySelector(selector) {
  var foundNode = this._node.querySelector(selector);
  return foundNode ? new Chartist.Svg(foundNode) : null;
}
  

Find the first child SVG element of the current element that matches a CSS selector. The returned object is a Chartist.Svg wrapper.

Parameters
selector ( String )
A CSS selector that is used to query for child SVG elements
Returns
( Chartist.Svg )
The SVG wrapper for the element found or null if no element was found
function querySelectorAll()
    function querySelectorAll(selector) {
  var foundNodes = this._node.querySelectorAll(selector);
  return foundNodes.length ? new Chartist.Svg.List(foundNodes) : null;
}
  

Find the all child SVG elements of the current element that match a CSS selector. The returned object is a Chartist.Svg.List wrapper.

Parameters
selector ( String )
A CSS selector that is used to query for child SVG elements
Returns
( Chartist.Svg.List )
The SVG wrapper list for the element found or null if no element was found
function getNode()
    function getNode() {
  return this._node;
}
  

Returns the underlying SVG node for the current element.

function foreignObject()
    function foreignObject(content, attributes, className, insertFirst) {
  // If content is string then we convert it to DOM
  // TODO: Handle case where content is not a string nor a DOM Node
  if(typeof content === 'string') {
    var container = document.createElement('div');
    container.innerHTML = content;
    content = container.firstChild;
  }

  // Adding namespace to content element
  content.setAttribute('xmlns', Chartist.namespaces.xmlns);

  // Creating the foreignObject without required extension attribute (as described here
  // http://www.w3.org/TR/SVG/extend.html#ForeignObjectElement)
  var fnObj = this.elem('foreignObject', attributes, className, insertFirst);

  // Add content to foreignObjectElement
  fnObj._node.appendChild(content);

  return fnObj;
}
  

This method creates a foreignObject (see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/foreignObject) that allows to embed HTML content into a SVG graphic. With the help of foreignObjects you can enable the usage of regular HTML elements inside of SVG where they are subject for SVG positioning and transformation but the Browser will use the HTML rendering capabilities for the containing DOM.

Parameters
content ( Node String )
The DOM Node, or HTML string that will be converted to a DOM Node, that is then placed into and wrapped by the foreignObject
[attributes] ( String )
An object with properties that will be added as attributes to the foreignObject element that is created. Attributes with undefined values will not be added.
[className] ( String )
This class or class list will be added to the SVG element
[insertFirst] ( Boolean )
Specifies if the foreignObject should be inserted as first child
Returns
( Chartist.Svg )
New wrapper object that wraps the foreignObject element
function text()
    function text(t) {
  this._node.appendChild(document.createTextNode(t));
  return this;
}
  

This method adds a new text element to the current Chartist.Svg wrapper.

Parameters
t ( String )
The text that should be added to the text element that is created
Returns
( Chartist.Svg )
The same wrapper object that was used to add the newly created element
function empty()
    function empty() {
  while (this._node.firstChild) {
    this._node.removeChild(this._node.firstChild);
  }

  return this;
}
  

This method will clear all child nodes of the current wrapper object.

Returns
( Chartist.Svg )
The same wrapper object that got emptied
function remove()
    function remove() {
  this._node.parentNode.removeChild(this._node);
  return this.parent();
}
  

This method will cause the current wrapper to remove itself from its parent wrapper. Use this method if you'd like to get rid of an element in a given DOM structure.

Returns
( Chartist.Svg )
The parent wrapper object of the element that got removed
function replace()
    function replace(newElement) {
  this._node.parentNode.replaceChild(newElement._node, this._node);
  return newElement;
}
  

This method will replace the element with a new element that can be created outside of the current DOM.

Parameters
newElement ( Chartist.Svg )
The new Chartist.Svg object that will be used to replace the current wrapper object
Returns
( Chartist.Svg )
The wrapper of the new element
function append()
    function append(element, insertFirst) {
  if(insertFirst && this._node.firstChild) {
    this._node.insertBefore(element._node, this._node.firstChild);
  } else {
    this._node.appendChild(element._node);
  }

  return this;
}
  

This method will append an element to the current element as a child.

Parameters
element ( Chartist.Svg )
The Chartist.Svg element that should be added as a child
[insertFirst] ( Boolean )
Specifies if the element should be inserted as first child
Returns
( Chartist.Svg )
The wrapper of the appended object
function classes()
    function classes() {
  return this._node.getAttribute('class') ? this._node.getAttribute('class').trim().split(/\s+/) : [];
}
  

Returns an array of class names that are attached to the current wrapper element. This method can not be chained further.

Returns
( Array )
A list of classes or an empty array if there are no classes on the current element
function addClass()
    function addClass(names) {
  this._node.setAttribute('class',
    this.classes(this._node)
      .concat(names.trim().split(/\s+/))
      .filter(function(elem, pos, self) {
        return self.indexOf(elem) === pos;
      }).join(' ')
  );

  return this;
}
  

Adds one or a space separated list of classes to the current element and ensures the classes are only existing once.

Parameters
names ( String )
A white space separated list of class names
Returns
( Chartist.Svg )
The wrapper of the current element
function removeClass()
    function removeClass(names) {
  var removedClasses = names.trim().split(/\s+/);

  this._node.setAttribute('class', this.classes(this._node).filter(function(name) {
    return removedClasses.indexOf(name) === -1;
  }).join(' '));

  return this;
}
  

Removes one or a space separated list of classes from the current element.

Parameters
names ( String )
A white space separated list of class names
Returns
( Chartist.Svg )
The wrapper of the current element
function removeAllClasses()
    function removeAllClasses() {
  this._node.setAttribute('class', '');

  return this;
}
  

Removes all classes from the current element.

Returns
( Chartist.Svg )
The wrapper of the current element
function height()
    function height() {
  return this._node.getBoundingClientRect().height;
}
  

Get element height using getBoundingClientRect

Returns
( Number )
The elements height in pixels
function animate()
    function animate(animations, guided, eventEmitter) {
  if(guided === undefined) {
    guided = true;
  }

  Object.keys(animations).forEach(function createAnimateForAttributes(attribute) {

    function createAnimate(animationDefinition, guided) {
      var attributeProperties = {},
        animate,
        timeout,
        easing;

      // Check if an easing is specified in the definition object and delete it from the object as it will not
      // be part of the animate element attributes.
      if(animationDefinition.easing) {
        // If already an easing Bézier curve array we take it or we lookup a easing array in the Easing object
        easing = animationDefinition.easing instanceof Array ?
          animationDefinition.easing :
          Chartist.Svg.Easing[animationDefinition.easing];
        delete animationDefinition.easing;
      }

      // If numeric dur or begin was provided we assume milli seconds
      animationDefinition.begin = Chartist.ensureUnit(animationDefinition.begin, 'ms');
      animationDefinition.dur = Chartist.ensureUnit(animationDefinition.dur, 'ms');

      if(easing) {
        animationDefinition.calcMode = 'spline';
        animationDefinition.keySplines = easing.join(' ');
        animationDefinition.keyTimes = '0;1';
      }

      // Adding "fill: freeze" if we are in guided mode and set initial attribute values
      if(guided) {
        animationDefinition.fill = 'freeze';
        // Animated property on our element should already be set to the animation from value in guided mode
        attributeProperties[attribute] = animationDefinition.from;
        this.attr(attributeProperties);

        // In guided mode we also set begin to indefinite so we can trigger the start manually and put the begin
        // which needs to be in ms aside
        timeout = Chartist.quantity(animationDefinition.begin || 0).value;
        animationDefinition.begin = 'indefinite';
      }

      animate = this.elem('animate', Chartist.extend({
        attributeName: attribute
      }, animationDefinition));

      if(guided) {
        // If guided we take the value that was put aside in timeout and trigger the animation manually with a timeout
        setTimeout(function() {
          // If beginElement fails we set the animated attribute to the end position and remove the animate element
          // This happens if the SMIL ElementTimeControl interface is not supported or any other problems occured in
          // the browser. (Currently FF 34 does not support animate elements in foreignObjects)
          try {
            animate._node.beginElement();
          } catch(err) {
            // Set animated attribute to current animated value
            attributeProperties[attribute] = animationDefinition.to;
            this.attr(attributeProperties);
            // Remove the animate element as it's no longer required
            animate.remove();
          }
        }.bind(this), timeout);
      }

      if(eventEmitter) {
        animate._node.addEventListener('beginEvent', function handleBeginEvent() {
          eventEmitter.emit('animationBegin', {
            element: this,
            animate: animate._node,
            params: animationDefinition
          });
        }.bind(this));
      }

      animate._node.addEventListener('endEvent', function handleEndEvent() {
        if(eventEmitter) {
          eventEmitter.emit('animationEnd', {
            element: this,
            animate: animate._node,
            params: animationDefinition
          });
        }

        if(guided) {
          // Set animated attribute to current animated value
          attributeProperties[attribute] = animationDefinition.to;
          this.attr(attributeProperties);
          // Remove the animate element as it's no longer required
          animate.remove();
        }
      }.bind(this));
    }

    // If current attribute is an array of definition objects we create an animate for each and disable guided mode
    if(animations[attribute] instanceof Array) {
      animations[attribute].forEach(function(animationDefinition) {
        createAnimate.bind(this)(animationDefinition, false);
      }.bind(this));
    } else {
      createAnimate.bind(this)(animations[attribute], guided);
    }

  }.bind(this));

  return this;
}

Chartist.Svg = Chartist.Class.extend({
  constructor: Svg,
  attr: attr,
  elem: elem,
  parent: parent,
  root: root,
  querySelector: querySelector,
  querySelectorAll: querySelectorAll,
  getNode: getNode,
  foreignObject: foreignObject,
  text: text,
  empty: empty,
  remove: remove,
  replace: replace,
  append: append,
  classes: classes,
  addClass: addClass,
  removeClass: removeClass,
  removeAllClasses: removeAllClasses,
  height: height,
  width: width,
  animate: animate
});
  

The animate function lets you animate the current element with SMIL animations. You can add animations for multiple attributes at the same time by using an animation definition object. This object should contain SMIL animation attributes. Please refer to http://www.w3.org/TR/SVG/animate.html for a detailed specification about the available animation attributes. Additionally an easing property can be passed in the animation definition object. This can be a string with a name of an easing function in Chartist.Svg.Easing or an array with four numbers specifying a cubic Bézier curve.
An animations object could look like this:

element.animate({
  opacity: {
    dur: 1000,
    from: 0,
    to: 1
  },
  x1: {
    dur: '1000ms',
    from: 100,
    to: 200,
    easing: 'easeOutQuart'
  },
  y1: {
    dur: '2s',
    from: 0,
    to: 100
  }
});

Automatic unit conversion
For the dur and the begin animate attribute you can also omit a unit by passing a number. The number will automatically be converted to milli seconds.
Guided mode
The default behavior of SMIL animations with offset using the begin attribute is that the attribute will keep it's original value until the animation starts. Mostly this behavior is not desired as you'd like to have your element attributes already initialized with the animation from value even before the animation starts. Also if you don't specify fill="freeze" on an animate element or if you delete the animation after it's done (which is done in guided mode) the attribute will switch back to the initial value. This behavior is also not desired when performing simple one-time animations. For one-time animations you'd want to trigger animations immediately instead of relative to the document begin time. That's why in guided mode Chartist.Svg will also use the begin property to schedule a timeout and manually start the animation after the timeout. If you're using multiple SMIL definition objects for an attribute (in an array), guided mode will be disabled for this attribute, even if you explicitly enabled it.
If guided mode is enabled the following behavior is added:

  • Before the animation starts (even when delayed with begin) the animated attribute will be set already to the from value of the animation
  • begin is explicitly set to indefinite so it can be started manually without relying on document begin time (creation)
  • The animate element will be forced to use fill="freeze"
  • The animation will be triggered with beginElement() in a timeout where begin of the definition object is interpreted in milli seconds. If no begin was specified the timeout is triggered immediately.
  • After the animation the element attribute value will be set to the to value of the animation
  • The animate element is deleted from the DOM
Parameters
animations ( Object )
An animations object where the property keys are the attributes you'd like to animate. The properties should be objects again that contain the SMIL animation attributes (usually begin, dur, from, and to). The property begin and dur is auto converted (see Automatic unit conversion). You can also schedule multiple animations for the same attribute by passing an Array of SMIL definition objects. Attributes that contain an array of SMIL definition objects will not be executed in guided mode.
guided ( Boolean )
Specify if guided mode should be activated for this animation (see Guided mode). If not otherwise specified, guided mode will be activated.
eventEmitter ( Object )
If specified, this event emitter will be notified when an animation starts or ends.
Returns
( Chartist.Svg )
The current element where the animation was added
method Chartist.Svg.isSupported()
    Chartist.Svg.isSupported = function(feature) {
  return document.implementation.hasFeature('http://www.w3.org/TR/SVG11/feature#' + feature, '1.1');
};

/**
 * This Object contains some standard easing cubic bezier curves. Then can be used with their name in the `Chartist.Svg.animate`. You can also extend the list and use your own name in the `animate` function. Click the show code button to see the available bezier functions.
 *
 * @memberof Chartist.Svg
 */
var easingCubicBeziers = {
  easeInSine: [0.47, 0, 0.745, 0.715],
  easeOutSine: [0.39, 0.575, 0.565, 1],
  easeInOutSine: [0.445, 0.05, 0.55, 0.95],
  easeInQuad: [0.55, 0.085, 0.68, 0.53],
  easeOutQuad: [0.25, 0.46, 0.45, 0.94],
  easeInOutQuad: [0.455, 0.03, 0.515, 0.955],
  easeInCubic: [0.55, 0.055, 0.675, 0.19],
  easeOutCubic: [0.215, 0.61, 0.355, 1],
  easeInOutCubic: [0.645, 0.045, 0.355, 1],
  easeInQuart: [0.895, 0.03, 0.685, 0.22],
  easeOutQuart: [0.165, 0.84, 0.44, 1],
  easeInOutQuart: [0.77, 0, 0.175, 1],
  easeInQuint: [0.755, 0.05, 0.855, 0.06],
  easeOutQuint: [0.23, 1, 0.32, 1],
  easeInOutQuint: [0.86, 0, 0.07, 1],
  easeInExpo: [0.95, 0.05, 0.795, 0.035],
  easeOutExpo: [0.19, 1, 0.22, 1],
  easeInOutExpo: [1, 0, 0, 1],
  easeInCirc: [0.6, 0.04, 0.98, 0.335],
  easeOutCirc: [0.075, 0.82, 0.165, 1],
  easeInOutCirc: [0.785, 0.135, 0.15, 0.86],
  easeInBack: [0.6, -0.28, 0.735, 0.045],
  easeOutBack: [0.175, 0.885, 0.32, 1.275],
  easeInOutBack: [0.68, -0.55, 0.265, 1.55]
};

Chartist.Svg.Easing = easingCubicBeziers;

/**
 * This helper class is to wrap multiple `Chartist.Svg` elements into a list where you can call the `Chartist.Svg` functions on all elements in the list with one call. This is helpful when you'd like to perform calls with `Chartist.Svg` on multiple elements.
 * An instance of this class is also returned by `Chartist.Svg.querySelectorAll`.
 *
 * @memberof Chartist.Svg
 * @param {Array<Node>|NodeList} nodeList An Array of SVG DOM nodes or a SVG DOM NodeList (as returned by document.querySelectorAll)
 * @constructor
 */
function SvgList(nodeList) {
  var list = this;

  this.svgElements = [];
  for(var i = 0; i < nodeList.length; i++) {
    this.svgElements.push(new Chartist.Svg(nodeList[i]));
  }

  // Add delegation methods for Chartist.Svg
  Object.keys(Chartist.Svg.prototype).filter(function(prototypeProperty) {
    return ['constructor',
        'parent',
        'querySelector',
        'querySelectorAll',
        'replace',
        'append',
        'classes',
        'height',
        'width'].indexOf(prototypeProperty) === -1;
  }).forEach(function(prototypeProperty) {
    list[prototypeProperty] = function() {
      var args = Array.prototype.slice.call(arguments, 0);
      list.svgElements.forEach(function(element) {
        Chartist.Svg.prototype[prototypeProperty].apply(element, args);
      });
      return list;
    };
  });
}

Chartist.Svg.List = Chartist.Class.extend({
  constructor: SvgList
});
}(window, document, Chartist));
  

This method checks for support of a given SVG feature like Extensibility, SVG-animation or the like. Check http://www.w3.org/TR/SVG11/feature for a detailed list.

Parameters
feature ( String )
The SVG 1.1 feature that should be checked for support.
Returns
( Boolean )
True of false if the feature is supported or not