dmn-elex-poll-closing-time-list

dmn-elex-poll-closing-time-list

Chart module for 2016 general-election poll closing times.

Install

$ npm install --save dmn-elex-poll-closing-time-list

Requirements

This module uses ES6 syntax. To use as a pre-compiled module, you'll need a compiler like babel.

Use

In the client, include the global-chart.js bundle, which defines a global chart object, PollClosingTimeList:

<script src="some/path/to/global-chart.js"></script>

To use as a module, simply import the chart object:

import PollClosingTimeList from 'dmn-elex-poll-closing-time-list';

The chart object has three methods, one to create the chart initially, one another to update it with new data and one to resize the chart.

Importantly, the update and resize functions have no effect with this static chart. They are included only to maintain a common API with all other election-related, pluggable charts from The Dallas Morning News.

var myChart = new PollClosingTimeList();

// create needs a selection string and prefectched data
myChart.create('#chart');

// update needs only new data
myChart.update();

To apply this chart's default styles when using SCSS, simply define the variable $PollClosingTimeList-container to represent the ID or class of the chart's container(s) and import the _chart-styles.scss partial.

$PollClosingTimeList-container: '#chart';

@import 'path/to/dmn-elex-poll-closing-time-list/src/scss/_chart-styles';

Developing

Write your chart code in chart.js and add custom styles to _chart-styles.scss.

Then, just run gulp:

$ gulp

Or to minimize javascript before publishing:

$ gulp --production