React ChartsGet Started with AG Charts
AG Charts is a powerful standalone component with no dependencies. The charts factory API can be used to seamlessly create and update data visualizations independently of the grid.
Quick Look Code Example
import React, { Component } from 'react';
import { AgChartsReact } from 'ag-charts-react';
export default class ChartExample extends Component {
data = [
{
beverage: 'Coffee',
Q1: 700,
Q2: 600,
Q3: 560,
Q4: 450
},
{
beverage: 'Tea',
Q1: 520,
Q2: 450,
Q3: 380,
Q4: 270
},
{
beverage: 'Milk',
Q1: 200,
Q2: 190,
Q3: 170,
Q4: 180
},
];
constructor(props) {
super(props);
this.state = {
options: {
data: this.data,
title: { text: 'Beverage Expenses' },
subtitle: { text: 'per quarter' },
footnote: { text: 'Based on a sample size of 200 respondents' },
padding: {
top: 40,
right: 40,
bottom: 40,
left: 40,
},
series: [
{ type: 'column', xKey: 'beverage', yKey: 'Q1', stacked: true },
{ type: 'column', xKey: 'beverage', yKey: 'Q2', stacked: true },
{ type: 'column', xKey: 'beverage', yKey: 'Q3', stacked: true },
{ type: 'column', xKey: 'beverage', yKey: 'Q4', stacked: true },
],
legend: { spacing: 40 },
},
};
}
render() {
return <AgChartsReact options={this.state.options} />;
}
}Getting Started
In this article we will walk through the necessary steps to add AG Charts to an existing React project and produce your first charts.charts.Add AG Charts to Your Project
For the purposes of this tutorial, we are going to scaffold a React app with create-react-app.
Don't worry if your project has a different configuration - AG Charts and the React wrapper are distributed as NPM packages, which should work with any common React project module bundler setup.
Let's follow the create-react-app instructions and run the following commands in your terminal:
npx create-react-app my-app
cd my-app
npm startIf everything goes well, npm start has started the web server and conveniently opened a browser pointing to localhost:3000.
As a next step, let's add the AG Charts NPM packages. Run the following command in my-app (you may need a new instance of the terminal):
npm install --save ag-charts-community ag-charts-reactAfter a few seconds of waiting, you should be good to go. Let's get to the actual coding! Open src/App.js in your favourite text editor and change its contents to the following:
import React, { Component } from 'react';
import { AgChartsReact } from 'ag-charts-react';
export default class ChartExample extends Component {
data = [
{
quarter: 'Q1',
spending: 700,
},
{
quarter: 'Q2',
spending: 600,
},
{
quarter: 'Q3',
spending: 560,
},
{
quarter: 'Q4',
spending: 450,
},
];
constructor(props) {
super(props);
this.state = {
options: {
data: this.data,
series: [{
xKey: 'quarter',
yKey: 'spending',
}],
},
};
}
render() {
return <AgChartsReact options={this.state.options} />;
}
}Here we'll provide the options we want to use for our chart, including the series to use to plot the data.
The series type defaults to 'line' so the only series configuration we need to specify is to tell the series which keys to use to fetch the data to be plotted along the horizontal (x) and vertical (y) axes.
The series property is an array because it is possible to supply multiple series (including mixed kinds!) into a single chart.
The default axes configuration is a category axis on the bottom and number axis on the left of a chart, both of which are exactly what we need in this case, so we don't need to supply these here.
Legend
By default, the chart displays a legend when there is more than one series present. To enable the legend for a chart with a single series, set legend.enabled to true.
The chart legend uses the yKey for the series, which in this case is 'spending'. This can be renamed using the yName property.
constructor(props) {
super(props);
this.state = {
options: {
data: this.data,
series: [{
xKey: 'quarter',
yKey: 'spending',
+ yName: 'Coffee Spending',
}],
+ legend: {
+ enabled: true,
+ },
}
}
}Basic Column Chart
Now let's try something more interesting. Let's say you want to visualise how much is spent on coffee, milk and tea in your company each quarter and in total. Your data might look something like this:
const data = [
{
beverage: 'Coffee',
Q1: 700,
Q2: 600,
Q3: 560,
Q4: 450
},
{
beverage: 'Tea',
Q1: 520,
Q2: 450,
Q3: 380,
Q4: 270
},
{
beverage: 'Milk',
Q1: 200,
Q2: 190,
Q3: 170,
Q4: 180
},
];constructor(props) {
super(props);
this.state = {
options: {
data: this.data,
series: [
{ type: 'column', xKey: 'beverage', yKey: 'Q1', stacked: true },
{ type: 'column', xKey: 'beverage', yKey: 'Q2', stacked: true },
{ type: 'column', xKey: 'beverage', yKey: 'Q3', stacked: true },
{ type: 'column', xKey: 'beverage', yKey: 'Q4', stacked: true },
],
}
}
}Chart tooltips are enabled by default so you can hover over a block to see its value.
Labels and Titles
We can enhance our chart by providing a label for each block segment. We can set a label's fontSize, fontFamily and other properties, but for now we'll just accept the default values:
constructor(props) {
super(props);
this.state = {
options: {
data: this.data,
series: [
{
type: 'column',
xKey: 'beverage',
yKey: 'Q1',
stacked: true,
+ label: {},
},
{
type: 'column',
xKey: 'beverage',
yKey: 'Q2',
stacked: true,
+ label: {},
},
{
type: 'column',
xKey: 'beverage',
yKey: 'Q3',
stacked: true,
+ label: {},
},
{
type: 'column',
xKey: 'beverage',
yKey: 'Q4',
stacked: true,
+ label: {},
},
],
}
}
}If we then want to add a title and subtitle to the chart, we can simply add this to our chart config:
constructor(props) {
super(props);
this.state = {
options: {
data: this.data,
+ title: {
+ text: 'Beverage Expenses',
+ },
+ subtitle: {
+ text: 'per quarter',
+ },
+ footnote: {
+ text: 'Based on a sample size of 200 respondents',
+ },
series: [
{
type: 'column',
xKey: 'beverage',
yKey: 'Q1',
stacked: true,
label: {},
},
{
type: 'column',
xKey: 'beverage',
yKey: 'Q2',
stacked: true,
label: {},
},
{
type: 'column',
xKey: 'beverage',
yKey: 'Q3',
stacked: true,
label: {},
},
{
type: 'column',
xKey: 'beverage',
yKey: 'Q4',
stacked: true,
label: {},
},
],
}
}
}Now that you've had a taste of what it's like to use AG Charts, we encourage you to explore our documentation to learn more.