react-chartjs-2
Advanced tools
The react-chartjs-2 npm package is a React wrapper for Chart.js, a popular JavaScript library for creating simple yet flexible charts. It allows developers to create various types of charts such as line, bar, radar, doughnut, and pie charts, among others, with ease. The package provides React components that encapsulate Chart.js functionality, making it easy to integrate into React applications.
Line Chart
This code sample demonstrates how to create a simple line chart using react-chartjs-2. It includes a dataset for monthly sales and configures the chart to start the y-axis at zero.
{"import { Line } from 'react-chartjs-2';\n\nconst data = {\n labels: ['January', 'February', 'March', 'April', 'May', 'June'],\n datasets: [{\n label: 'Monthly Sales',\n data: [65, 59, 80, 81, 56, 55],\n fill: false,\n borderColor: 'rgb(75, 192, 192)',\n tension: 0.1\n }]\n};\n\nconst options = {\n scales: {\n y: {\n beginAtZero: true\n }\n }\n};\n\nfunction MyLineChart() {\n return <Line data={data} options={options} />;\n}"}Bar Chart
This code sample shows how to create a bar chart with react-chartjs-2. It sets up a dataset with different colors for each bar representing votes for different options.
{"import { Bar } from 'react-chartjs-2';\n\nconst data = {\n labels: ['Red', 'Blue', 'Yellow', 'Green', 'Purple', 'Orange'],\n datasets: [{\n label: 'Votes',\n data: [12, 19, 3, 5, 2, 3],\n backgroundColor: [\n 'rgba(255, 99, 132, 0.2)',\n 'rgba(54, 162, 235, 0.2)',\n 'rgba(255, 206, 86, 0.2)',\n 'rgba(75, 192, 192, 0.2)',\n 'rgba(153, 102, 255, 0.2)',\n 'rgba(255, 159, 64, 0.2)'\n ],\n borderColor: [\n 'rgba(255, 99, 132, 1)',\n 'rgba(54, 162, 235, 1)',\n 'rgba(255, 206, 86, 1)',\n 'rgba(75, 192, 192, 1)',\n 'rgba(153, 102, 255, 1)',\n 'rgba(255, 159, 64, 1)'\n ],\n borderWidth: 1\n }]\n};\n\nfunction MyBarChart() {\n return <Bar data={data} />;\n}"}Doughnut Chart
This code sample illustrates how to create a doughnut chart using react-chartjs-2. It includes a dataset with three segments, each with its own color.
{"import { Doughnut } from 'react-chartjs-2';\n\nconst data = {\n labels: ['Red', 'Blue', 'Yellow'],\n datasets: [{\n data: [300, 50, 100],\n backgroundColor: [\n '#FF6384',\n '#36A2EB',\n '#FFCE56'\n ],\n hoverBackgroundColor: [\n '#FF6384',\n '#36A2EB',\n '#FFCE56'\n ]\n }]\n};\n\nfunction MyDoughnutChart() {\n return <Doughnut data={data} />;\n}"}Recharts is a composable charting library built on React components. It uses D3.js under the hood for sophisticated charting capabilities. Compared to react-chartjs-2, Recharts offers a more React-friendly API with the ability to compose charts using declarative components.
Victory is another React chart library that provides an extensive collection of composable components for building interactive data visualizations. Victory charts are highly customizable and can be styled using standard inline styles, which might appeal to developers looking for a more integrated React experience compared to react-chartjs-2.
Nivo provides a rich set of dataviz components built on top of D3.js, with a strong emphasis on motion and interactivity. It offers a higher level of abstraction compared to react-chartjs-2 and includes a wide range of chart types with beautiful default styles and animations.
React wrapper for Chart.js
npm install --save react-chartjs-2 chart.js
# or
yarn add react-chartjs-2 chart.js
chart.js ^3.0.0import { Doughnut } from 'react-chartjs-2';
<Doughnut data={...} />
Live: reactchartjs.github.io/react-chartjs-2
See these examples for more information
id?: string;
className?: string;
height?: number;
width?: number;
redraw?: boolean;
type: Chart.ChartType
data: Chart.ChartData | (canvas: HTMLCanvasElement | null) => Chart.ChartData;
options?: Chart.ChartOptions;
fallbackContent?: React.ReactNode;
plugins?: Chart.Plugin[];
getDatasetAtEvent?: (dataset: Chart.InteractionItem[], event: React.MouseEvent<HTMLCanvasElement>) => void;
getElementAtEvent?: (element: Chart.InteractionItem[], event: React.MouseEvent<HTMLCanvasElement>) => void;
getElementsAtEvent?: (elements: Chart.InteractionItem[], event: React.MouseEvent<HTMLCanvasElement>) => void;
Type string
Default: undefined
ID attribute applied to the rendered canvas
Type string
Default: undefined
class attribute applied to the rendered canvas
Type: number
Default: 150
Height attribute applied to the rendered canvas
Type: number
Default: 300
Width attribute applied to the rendered canvas
Type: boolean
Default: false
If true, will tear down and redraw chart on all updates
Type: 'bar' | 'line' | 'scatter' | 'bubble' | 'pie' | 'doughnut' | 'polarArea' | 'radar'
Chart.js chart type (required only on ChartComponent)
Type: Chart.ChartData | (canvas: HTMLCanvasElement | null) => Chart.ChartData
The data object that is passed into the Chart.js chart (more info).
This can also be a function, that receives a canvas element and returns the data object.
const data = canvas => {
const ctx = canvas.getContext('2d');
const g = ctx.createLinearGradient(...);
return {
datasets: [{
backgroundColor: g,
// ...the rest
}],
};
}
Type: Chart.ChartOptions
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 'react-chartjs-2';
// 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 'react-chartjs-2';
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 'react-chartjs-2';
componentWillMount() {
Chart.register({
afterDraw: function (chart, easing) {
// Plugin code.
}
});
}
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:
label property on each dataset. By default, this library uses the label property as the key to distinguish datasets.datasetKeyProvider prop 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) 2020 Jeremy Ayerst
FAQs
React components for Chart.js
The npm package react-chartjs-2 receives a total of 1,043,897 weekly downloads. As such, react-chartjs-2 popularity was classified as popular.
We found that react-chartjs-2 demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.