woocommerce/plugins/woocommerce-admin/client/components/chart
Robert Elliott e79a4b9025 remove he package and rename uniqueDates to ticks 2018-09-17 11:07:11 +02:00
..
d3-base line and bar icon buttons 2018-09-11 13:10:36 +02:00
test only sort on totals for layout=comparison & add dateParser prop for date formatting 2018-09-10 14:57:36 +02:00
README.md only sort on totals for layout=comparison & add dateParser prop for date formatting 2018-09-10 14:57:36 +02:00
charts.js Component - Chart: factorial spacing of x-axis ticks (https://github.com/woocommerce/woocommerce-admin/pull/398) 2018-09-14 10:43:53 -07:00
example-hour.js exmple-hour update 2018-09-06 11:40:29 +02:00
example.js add smallcolorscale fractions for chromatic scaled colors 2018-09-10 15:59:14 +02:00
index.js Component - Chart: factorial spacing of x-axis ticks (https://github.com/woocommerce/woocommerce-admin/pull/398) 2018-09-14 10:43:53 -07:00
legend.js if legend item unchecked no hover status 2018-09-06 18:15:08 +02:00
placeholder.js Add loading indicators, error state, and EmptyContent to the revenue report. (#347, woocommerce/woocommerce-admin#348) 2018-09-05 12:45:49 -04:00
style.scss Chart: Add styling needed to not be wrapped by card. (https://github.com/woocommerce/woocommerce-admin/pull/408) 2018-09-14 09:17:39 -07:00
utils.js remove he package and rename uniqueDates to ticks 2018-09-17 11:07:11 +02:00

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