React wrapper for Chart.js 3
- Fork from react-chartjs-2
- Merge #599 3.x Migration from react-chartjs-2
- Bump dependency Chart.js version to 3.0.2
- Implement v3 function getElementsAtEventForMode
Open for PRs and contributions!
npm install --save react-chartjs-2 chart.js
# or
yarn add react-chartjs-2 chart.jsimport { Doughnut } from 'react-chartjs-2';
<Doughnut data={...} />Live: reactchartjs.github.io/react-chartjs-2
See these examples for more information
npm install --save @iftek/react-chartjs-3 chart.jsyarn add @iftek/react-chartjs-3 chart.jsType string
Default: undefined
ID attribute applied to the rendered canvas
import { Doughnut } from '@iftek/react-chartjs-3';
Type `string`
Default: `undefined`
class attribute applied to the rendered canvas
#### height
Type: `number`
Default: `150`
Height attribute applied to the rendered canvas
#### width
Type: `number`
Default: `300`
Width attribute applied to the rendered canvas
#### redraw
Type: `boolean`
Default: `false`
If true, will tear down and redraw chart on all updates
#### type
Type: `'line' | 'bar' | 'horizontalBar' | 'radar' | 'doughnut' | 'polarArea' | 'bubble' | 'pie' | 'scatter'`
Chart.js chart type (required only on ChartComponent)
#### data (required)
Type: `Chart.ChartData | (canvas: HTMLCanvasElement | null) => Chart.ChartData`
The data object that is passed into the Chart.js chart ([more info](https://www.chartjs.org/docs/latest/getting-started/)).
This can also be a function, that receives a canvas element and returns the data object.
```tsx
const data = canvas => {
const ctx = canvas.getContext('2d');
const g = ctx.createLinearGradient(...);
return {
datasets: [{
backgroundColor: g,
// ...the rest
}],
};
}- data: (PropTypes.object | PropTypes.func).isRequired,
- width: PropTypes.number,
- height: PropTypes.number,
- id: PropTypes.string,
- legend: PropTypes.object,
- options: PropTypes.object,
- redraw: PropTypes.bool,
- getElementsAtEventForMode: PropTypes.func
The options object that is passed into the Chart.js chart (more info)
Type: React.ReactNode
A fallback for when the canvas cannot be rendered. Can be used for accessible chart descriptions (more info)
Type: Chart.PluginServiceRegistrationOptions[]
The plugins array that is passed into the Chart.js chart (more info)
Type: (dataset: Array<{}>, event: React.MouseEvent<HTMLCanvasElement>) => void
Default: undefined
Proxy for Chart.js getDatasetAtEvent. Calls with dataset and triggering event
Type: (element: [{}], event: React.MouseEvent<HTMLCanvasElement>) => void
Default: undefined
Proxy for Chart.js getElementAtEvent. Calls with single element array and triggering event
Type: (elements: Array<{}>, event: React.MouseEvent<HTMLCanvasElement>) => void
Default: undefined
Proxy for Chart.js getElementsAtEvent. Calls with element array and triggering event
In order for Chart.js to obey the custom size you need to set maintainAspectRatio to false
<Bar
data={data}
width={100}
height={50}
options={{ maintainAspectRatio: false }}
/>The Chart.js instance can be accessed by placing a ref to the element as:
const App => {
const ref = useRef();
return <Doughnut ref={ref} data={data} options={options} />;
};The canvas node and hence context can be accessed within the data function. This approach is useful when you want to keep your components pure.
render() {
const data = (canvas) => {
const ctx = canvas.getContext('2d')
const gradient = ctx.createLinearGradient(0,0,100,0);
return {
backgroundColor: gradient
// ...the rest
}
}
return <Line data={data} />;
}Chart.js defaults can be set by importing the defaults object:
import { defaults } from '@iftek/react-chartjs-3';
// Disable animating charts by default.
defaults.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 '@iftek/react-chartjs-3';
import merge from 'lodash.merge';
merge(defaults, {
animation: false,
line: {
borderColor: '#F85F73',
}
});
``` -->
<!-- ### Chart.js object
You can access the internal Chart.js object to register plugins or extend charts like this:
```JavaScript
import { Chart } from '@iftek/react-chartjs-3';
componentWillMount() {
Chart.register({
afterDraw: function (chart, easing) {
// Plugin code.
}
});
}If you're using Chart.js 2.6 and below, add the showLines: false property to your chart options. This was later added in the default config, so users of later versions would not need to do this extra step.
A function to be called when mouse clicked on chart elements, will return all element at that point as an array. Check
{
getElementsAtEventForMode: (elems) => {},
// `elems` is an array of chartElements
}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) => {}
// `dataset` is an array of chartElements
}You will find that any event which causes the chart to re-render, such as hover tooltips, etc., will cause the first dataset to be copied over to other datasets, causing your lines and bars to merge together. This is because to track changes in the dataset series, the library needs a key to be specified - if none is found, it can't tell the difference between the datasets while updating. To get around this issue, you can take these two approaches:
- Add a
labelproperty on each dataset. By default, this library uses thelabelproperty as the key to distinguish datasets. - Specify a different property to be used as a key by passing a
datasetKeyProviderprop to your chart component, which would return a unique string value for each dataset.
NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in dist 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.
MIT Licensed Copyright (c) 2021 Iftek