ag-charts-locale
v10.1.0
Published
<div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/ag-grid/ag-grid/blob/latest/documentation/ag-grid-docs/public/images/ag-logos/svg-logos/AG-Charts-Logo_Dark-Theme.svg?raw=true"/> <sourc
Downloads
307,254
Maintainers
Readme
Locale 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 Locale 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+ Locale 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 Locale 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 | ❌ | ✅ |
[!IMPORTANT] Visit the Pricing page for a full comparison.
Financial Charts
Build interactive financial charts featuring advanced annotations with minimal configuration, all you need to do is provide your data:
const options = {
data: getData(),
};
AgCharts.createFinancialChart(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. Read on for vanilla Locale installation instructions, or refer to our framework-specific guides for React, Angular and Vue.
Installation
$ npm install ag-charts-locale
Setup
- Provide a Container
<!doctype html>
<html lang="en">
<head>
<title>AG Charts Quick Start</title>
<!-- Locale Charts Core Library -->
<script src="https://cdn.jsdelivr.net/npm/ag-charts-locale/dist/umd/ag-charts-locale.js"></script>
</head>
<body>
<!-- Container for Chart -->
<div id="myChart"></div>
<!-- Charts configuration file -->
<script src="index.js"></script>
</body>
</html>
- Instantiate the Locale Chart
// Chart Options
const options = {};
// Create Chart
const chart = agCharts.AgCharts.create(options);
- Define Chart Data and Series
// Chart Options
const options = {
// Container: HTML Element to hold the chart
container: document.getElementById('myChart'),
// 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' }],
};
[!IMPORTANT] For more information on building Locale Charts with AG Charts, refer to our Documentation.
🤝 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: