embed_refugee-city-map v1.0.4

embed_refugee-city-map

Chart module for {your chart type here}.

Install

$ npm install --save embed_refugee-city-map

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, CityMap:

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

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

import CityMap from 'embed_refugee-city-map';

The chart object has two methods, one to create the chart, initially, and another to update it.

var myChart = new CityMap();

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

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

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

$CityMap-container: '#chart';

@import 'path/to/embed_refugee-city-map/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