![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)
react-chartjs-2
React wrapper for Chart.js 2
Open for PR's and contributions!
UPDATE
Actively looking for contributors as for the moment I do not have enough time to dedicate for maintaining this lib.
All contributors can add themselves to Contributors section at the bottom of README.
Demo & Examples
Live demo: gor181.github.io/react-chartjs-2
To build the examples locally, run:
npm install
npm start
Then open localhost:8000
in a browser.
Installation via NPM
npm install react-chartjs-2 chart.js --save
Usage
Check example/src/components/* for usage.
import {Doughnut} from 'react-chartjs-2';
<Doughnut data={...} />
Properties
- data: PropTypes.object.isRequired,
- width: PropTypes.number,
- height: PropTypes.number,
- legend: PropTypes.object,
- options: PropTypes.object,
- redraw: PropTypes.bool,
- getDatasetAtEvent: PropTypes.func,
- getElementAtEvent: PropTypes.func,
- getElementsAtEvent: PropTypes.func
- onElementsClick: PropTypes.func, // alias for getElementsAtEvent (backward compatibility)
Custom size
In order for Chart.js to obey the custom size you need to set maintainAspectRatio
to false, example:
<Bar
data={data}
width={100}
height={50}
options={{
maintainAspectRatio: false
}}
/>
Chart.js instance
Chart.js instance can be accessed by placing a ref to the element as:
render() {
componentDidMount() {
console.log(this.refs.chart.chart_instance);
}
return (
<Doughnut ref='chart' data={data} />
)
}
Chart.js Defaults
Chart.js defaults can be set by importing the defaults
object:
import { defaults } from 'react-chartjs-2';
defaults.global.animation = false;
If you want to bulk set properties, try using the lodash.merge function. This function will do a deep recursive merge preserving previously set values that you don't want to update.
import { defaults } from 'react-chartjs-2';
import merge from 'lodash.merge';
merge(defaults, {
global: {
animation: false,
line: {
borderColor: '#F85F73',
},
},
});
Chart.js object
You can access the internal Chart.js object to register plugins or extend charts like this:
import { Chart } from 'react-chartjs-2';
componentWillMount() {
Chart.pluginService.register({
afterDraw: function (chart, easing) {
}
});
}
Events
onElementsClick || getElementsAtEvent (function)
A function to be called when mouse clicked on chart elememts, will return all element at that point as an array. Check
{
onElementsClick: (elems) => {},
getElementsAtEvent: (elems) => {},
}
getElementAtEvent (function)
Calling getElementAtEvent(event) on your Chart instance passing an argument of an event, or jQuery event, will return the single element at the event position. If there are multiple items within range, only the first is returned Check
{
getElementAtEvent: (elems) => {},
}
getDatasetAtEvent (function)
Looks for the element under the event point, then returns all elements from that dataset. This is used internally for 'dataset' mode highlighting Check
{
getDatasetAtEvent: (dataset) => {}
}
Development (src
, lib
and the build process)
NOTE: The source code for the component is in src
. A transpiled CommonJS version (generated with Babel) is available in lib
for use with node.js, browserify and webpack. A UMD bundle is also built to dist
, which can be included without the need for any build system.
To build, watch and serve the examples (which will also watch the component source), run npm start
. If you just want to watch changes to src
and rebuild lib
, run npm run watch
(this is useful if you are working with npm link
).
Thanks
Jed Watson for making react-component yo builder!
License
MIT Licensed
Copyright (c) 2016 Goran Udosic
Contributors
Jeremy Ayerst @jerairrest