xtal-chart-istic
v0.0.6
Published
Vanilla-ish web component wrapper around the chartist library
Downloads
17
Readme
<xtal-chart-istic>
Vanilla-ish web component wrapper around the chartist library.
The web component itself is ~1.4kb minified, gzipped.
The chartist library is ~12kb minified, gzipped.
The default css is ~1.4kb minified, gzipped.
Syntax
chartist basically supports three chart types:
<xtal-chart-istic draw line-chart={lineChartDataAndOptions}></xtal-chart-istic>
<xtal-chart-istic draw pie-chart={pieChartDataAndOptions}></xtal-chart-istic>
<xtal-chart-istic draw bar-chart={barChartDataAndOptions}></xtal-chart-istic>
The properties lineChart, pieChart, barChart needs to consist of two properties:
data and options, e.g.:
<xtal-chart-istic draw line-chart='
{
"data": {
"labels": ["Mon", "Tue", "Wed", "Thu", "Fri"],
"series": [
[5, 2, 4, 2, 0]
]
},
"options": {
"width": "600px",
"height": "300px"
}
}
'></xtal-chart-istic>
These data and options subproperties are passed to the second and third arguments of chartist api:
this.chart = new Chartist.Pie(
this._chartTarget,
this._pieChart.data,
this._pieChart.options,
this._pieChart.responsiveOptions,
);
As you can see, there's a third sub property that can be passed in -- responsiveOptions, which are demonstrated frequently in the chartist examples.
"draw" is a boolean attribute / property that allows you to delay or prevent rendering (for example, if element is hidden);
Install the Polymer-CLI
First, make sure you have the Polymer CLI and npm (packaged with Node.js) installed. Run npm install
to install your element's dependencies, then run polymer serve
to serve your element locally.
Viewing Your Element
$ polymer serve
Running Tests
$ polymer test
Your application is already set up to be tested via web-component-tester. Run polymer test
to run your application's test suite locally.