API Reference

Wiki ▸ API Reference

API Reference

All functionality within Polychart.js is scoped under polyjs. This object contains three properties:

Chart Specification: polyjs.chart

This is the most important function in polychart.js. To create a chart, call polyjs.chart() with an appropriate specification object. The function will return a chart object, which can be used to define interaction behaviours.

Data: polyjs.data

This function takes a data set in JSON or CSV format or an AJAX endpoint that would return such data, and creates a Polychart.js data object. The data object has several functions that makes it easier to add new columns, rename columns, and otherwise interact with the data. See the section data for specifics.

Interaction: polyjs.interact

This object contains default handlers that defines interactive behaviour. See the section on interactions for more details