ag-charts-react
v10.3.1
Published
AG Charts React Component
Downloads
140,098
Maintainers
Readme
React Charting Library
📖 Overview
AG Charts is available in two versions: Community & Enterprise.
ag-charts-community
is free, available under the MIT license, and comes with core series types, such as Pie, Area, Bar, Scatter and Bubble in addition to all of the key features expected from a React charting library, including Accessibility, Tooltips, Themes, Markers, Legends, Axis Types and Secondary Axes.ag-charts-enterprise
is available under a commercial license and comes with additional series types, such as Maps, Sankey, Radar, and Waterfall Charts as well as advanced interactivity features, like Animations, Context Menus, Zooming, Navigators, Synchronization and much more, including Financial Charts.
Features & Chart Types
Chart Types
AG Charts offers 20+ React Chart types, each of which are fully customisable:
| Chart Type | AG Charts Community | AG Charts Enterprise | | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | -------------------- | | Bar | ✅ | ✅ | | Line | ✅ | ✅ | | Area | ✅ | ✅ | | Scatter | ✅ | ✅ | | Bubble | ✅ | ✅ | | Pie | ✅ | ✅ | | Donut | ✅ | ✅ | | Combination | ✅ | ✅ | | Box Plot | ❌ | ✅ | | Bullet | ❌ | ✅ | | Candlestick | ❌ | ✅ | | OHLC | ❌ | ✅ | | Heatmap | ❌ | ✅ | | Histogram | ❌ | ✅ | | Nightingale | ❌ | ✅ | | Radar Line | ❌ | ✅ | | Radar Area | ❌ | ✅ | | Radial Column | ❌ | ✅ | | Radial Bar | ❌ | ✅ | | Range Area | ❌ | ✅ | | Range Bar | ❌ | ✅ | | Sunburst | ❌ | ✅ | | Treemap | ❌ | ✅ | | Waterfall | ❌ | ✅ | | Sankey | ❌ | ✅ | | Chord | ❌ | ✅ |
Features
AG Charts React Charting Library comes with every feature you'd expect:
| Feature | AG Charts Community | AG Charts Enterprise | | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | -------------------- | | Accessibility | ✅ | ✅ | | Localisation | ✅ | ✅ | | Series Highlighting | ✅ | ✅ | | Tooltips | ✅ | ✅ | | Animations | ❌ | ✅ | | Context Menu | ❌ | ✅ | | Crosshairs | ❌ | ✅ | | Navigator | ❌ | ✅ | | Synchronization | ❌ | ✅ | | Zoom | ❌ | ✅ |
Financial Charts
Build interactive financial charts featuring advanced annotations with minimal configuration, all you need to do is provide your data:
const [options, setOptions] = useState({
data: getData(),
});
return <AgFinancialCharts options={options} />;
Once created, users will have a Financial Chart that they can interact with and add annotations to.
The default chart type is Candlestick, with additional types like OHLC and Line for versatile data visualisation.
Maps
The Maps Series let you visualise geographic data in different ways.
Maps can display data using Shapes, Lines and Marker series:
const options = {
topology: topology,
series: [
{
type: 'map-shape',
data: pacific,
idKey: 'name',
title: 'Pacific',
},
// ...
],
legend: {
enabled: true,
},
// ...
};
⚡️ Quick Start
AG Charts are easy to set up - all you need to do is provide your data and series type along with any other chart options.
Installation
$ npm install ag-charts-react
Setup
- Import the React Chart
import React, { useState } from 'react';
import ReactDOM from 'react-dom/client';
// React Chart Component
import { AgCharts } from 'ag-charts-react';
- Define Chart Data and Series
const ChartExample = () => {
// Chart Options: Control & configure the chart
const [chartOptions, setChartOptions] = useState({
// Data: Data to be displayed in the chart
data: [
{ month: 'Jan', avgTemp: 2.3, iceCreamSales: 162000 },
{ month: 'Mar', avgTemp: 6.3, iceCreamSales: 302000 },
{ month: 'May', avgTemp: 16.2, iceCreamSales: 800000 },
{ month: 'Jul', avgTemp: 22.8, iceCreamSales: 1254000 },
{ month: 'Sep', avgTemp: 14.5, iceCreamSales: 950000 },
{ month: 'Nov', avgTemp: 8.9, iceCreamSales: 200000 },
],
// Series: Defines which chart type and data to use
series: [{ type: 'bar', xKey: 'month', yKey: 'iceCreamSales' }],
});
// ...
};
- React Chart Component
Replace your index.js file (or root component) with the following code:
// React Chart Component
return (
// AgCharts component with options passed as prop
<AgCharts options={chartOptions} />
);
}
// Render component inside root element
const root = ReactDOM.createRoot(document.getElementById('root'));
root.render(<ChartExample />);
🤝 Support
Enterprise Support
AG Charts Enterprise customers have access to dedicated support via ZenDesk, which is monitored by our support & engineering teams.
Bug Reports
If you have found a bug, please report it in this repository's issues section.
Questions
Look for similar problems on StackOverflow using the ag-charts
tag. If nothing seems related, post a new message there. Please do not use GitHub issues to ask questions.
Contributing
AG Charts is developed by a team of co-located developers in London. If you want to join the team send your application to [email protected].
⚠️ License
ag-charts-community
is licensed under the MIT license.
ag-charts-enterprise
has a Commercial license.
See the LICENSE file for more info.
AG Charts is used within AG Grid to power the Integrated Charting feature.
Learn more at ag-grid.com
Follow us to keep up to date with all the latest news from AG Grid: