JavaScript Charts: Options Reference

This page documents the AG Charts API. You can find more details about getting started with AG Charts in the Getting Started section. You can also explore the API and see in real-time how different options affect charts using the API Explorer.

Cartesian Chart Options

options: {
type?: 'cartesian' | 'groupedCategory' | 'line' | 'bar' | 'column' | 'area' | 'scatter' | 'histogram'; 
data?: any[]; 
container?: HTMLElement | null; 
axes?: AgCartesianAxisOptions[] [ ... ]; 
series?: AgCartesianSeriesOptions[] [ ... ]; 
width?: number; 
height?: number; 
autoSize?: boolean; 
padding?: AgChartPaddingOptions { ... }; 
background?: AgChartBackground { ... }; 
title?: AgChartCaptionOptions { ... }; 
subtitle?: AgChartCaptionOptions { ... }; 
tooltip?: AgChartTooltipOptions { ... }; 
legend?: AgChartLegendOptions { ... }; 
listeners?: AgBaseChartListeners { ... }; 
navigator?: AgNavigatorOptions { ... }; 
theme?: string | AgChartTheme; 
}

Polar Chart Options

options: {
type?: 'polar' | 'pie'; 
data?: any[]; 
container?: HTMLElement | null; 
series?: AgPolarSeriesOptions[] [ ... ]; 
width?: number; 
height?: number; 
autoSize?: boolean; 
padding?: AgChartPaddingOptions { ... }; 
background?: AgChartBackground { ... }; 
title?: AgChartCaptionOptions { ... }; 
subtitle?: AgChartCaptionOptions { ... }; 
tooltip?: AgChartTooltipOptions { ... }; 
legend?: AgChartLegendOptions { ... }; 
listeners?: AgBaseChartListeners { ... }; 
theme?: string | AgChartTheme; 
}

Hierarchy Chart Options

options: {
type?: 'hierarchy' | 'treemap'; 
data?: any; 
container?: HTMLElement | null; 
series?: AgHierarchySeriesOptions[] [ ... ]; 
width?: number; 
height?: number; 
autoSize?: boolean; 
padding?: AgChartPaddingOptions { ... }; 
background?: AgChartBackground { ... }; 
title?: AgChartCaptionOptions { ... }; 
subtitle?: AgChartCaptionOptions { ... }; 
tooltip?: AgChartTooltipOptions { ... }; 
legend?: AgChartLegendOptions { ... }; 
listeners?: AgBaseChartListeners { ... }; 
theme?: string | AgChartTheme; 
}