4242a64f30 | ||
---|---|---|
.. | ||
d3-base | ||
test | ||
README.md | ||
charts.js | ||
example-hour.js | ||
example.js | ||
index.js | ||
legend.js | ||
placeholder.js | ||
style.scss | ||
utils.js |
README.md
D3 Chart Component
A simple D3 line and bar chart component for timeseries data in React.
Usage
<Chart
data={ timeseries }
dateParser={ '%Y-%m-%d' }
tooltipFormat={ 'Date is %Y-%m-%d' }
type={ 'bar' }
xFormat={ '%d' }
yFormat={ '.3s' }
/>
Expected Data Format
This component accepts timeseries data
prop in the following format (with dates following the ISO 8601 format):
[
{
date: '%Y-%m-%d', // string in `dateParser` format (see below)
category1: value, // number
category2: value, // number
...
},
...
]
For example:
[
{
date: '2018-06-25',
category1: 1234.56,
category2: 9876,
...
},
...
]
Props
Required props are marked with *
.
Name | Type | Default | Description |
---|---|---|---|
data * |
array |
none | An array of data as specified above(below) |
dateParser |
string |
%Y-%m-%dT%H:%M:%S |
Format to parse datetimes in the data |
type * |
string |
line |
Chart type of either line or bar |
title |
string |
none | Chart title |
tooltipFormat |
string |
%Y-%m-%d |
Title and format of the tooltip title |
xFormat |
string |
%Y-%m-%d |
d3TimeFormat of the x-axis values |
yFormat |
string |
.3s |
d3Format of the y-axis values |