@density/chart-count-graph

Count Graph Chart

A graph of counts over time for a given space. npm

Using this chart

This chart has a single default export. This exported function takes two arguments: a dom element, and an object full of properties. When called, this chart will render the chart inside the given DOM element. See the below example.

import countGraph from '@density/chart-count-graph';
// or: const countGraph = require('@density/chart-count-graph').default;

const element = document.getElementById('chart-container');
const props = {data: []};
countGraph(element, props);

In addition, if you'd like to render a chart in a context where the DOM is abstracted away from you, such as a React or Angular app, then check out our companion helper library.

Properties

• data: An array of {count: <count at a given time>, timestamp: <iso 8601 timestamp>, flag?: <boolean>} objects. Any objects with the "flag" property set to true will draw in a flag at that timestamp with its count. Data must be in chronological order. Example: [{"count": 4, "timestamp": "2017-03-28T12:00:00.000Z"}, {"count": 3, "timestamp": "2017-03-28T12:01:00.000Z", "flag": true}]

• start (optional) A moment that will be used as the starting point of the graph. If omitted, the graph will fit its data.

• end (optional) A moment that will be used as the ending point of the graph. If omitted, the graph will fit its data.

• width (optional) An integer that denotes the width of this chart in pixels. Defaults to 1000.

• height (optional) An integer that denotes the width of this chart in pixels. Defaults to 400.

• initialCount (optional) An integer to specify what the count was before the first event. Defaults to 0.

How this chart is structured

.
├── index.js        # Contains main chart code. Other javascript files may be present.
├── package.json
├── story.js        # Contains a react-storyboard story. Use it to present different states of your chart in the parent project.
└── styles.scss     # Contains all chart styles.