AG Studio: Build dashboards using native components in web apps. Join us for a webinar on 28th July at 2pm UTC+1 Register

AgChartOptions

theme AgChartTheme | AgChartThemeName
A predefined theme name or an object containing theme overrides. See: [Themes Reference](/themes-api/)
axes AgChartAxesOptions
Axis configurations. Axes are referenced using a dictionary of axis definitions, where each axis is identified by a key. The default keys are `x` and `y` for cartesian axes, or `radius` and `angle` for polar axes. See: [Axis Configuration](/r/axes-configuration/)
series AgChartSeriesOptions[]
Series configurations.
annotations AgAnnotationsOptions
Annotations configurations.
data TDatum[]
The data to render the chart from. If this is not specified, it must be set on individual series instead.
dataIdKey DatumKey
The key of the property on each datum that contains its unique identifier. When specified, transactions will match items by this field instead of by object reference. The values of this field must be unique across the dataset.
container HTMLElement | null
The element to place the rendered chart into.
initialState AgInitialStateOptions
The initial state of the chart. This must be a serialisable value.
loading boolean
Set to show or hide the loading overlay.
width PixelSize
The width of the chart in pixels.
height PixelSize
The height of the chart in pixels.
minHeight PixelSize default: 300
Sets the minimum height of the chart. Ignored if `height` is specified.
minWidth PixelSize default: 300
Sets the minimum width of the chart. Ignored if `width` is specified.
padding Padding
Configuration for the padding of the chart. A number applies uniform padding; an object sets each side.
seriesArea AgSeriesAreaOptions
Configuration relating to the series area.
background AgChartBackground
Configuration for the background shown behind the chart.
title AgChartCaptionOptions
Configuration for the title shown at the top of the chart.
subtitle AgChartSubtitleOptions
Configuration for the subtitle shown beneath the chart title.
footnote AgChartFooterOptions
Configuration for the footnote shown at the bottom of the chart.
highlight AgChartHighlightOptions
Configuration for the chart highlighting.
overlays AgChartOverlaysOptions
HTML overlays.
tooltip AgChartTooltipOptions
Global configuration that applies to all tooltips in the chart.
legend AgChartLegendOptions
Configuration for the chart legend.
gradientLegend AgGradientLegendOptions
Configuration for the gradient legend.
animation AgAnimationOptions
Configuration for chart animations.
flashOnUpdate AgFlashOnUpdateOptions
Configuration for the flash on update effect.
dataSource AgDataSourceOptions
Configuration for asynchronously loaded data.
contextMenu AgContextMenuOptions
Configuration for the context menu.
context TContext
Context object to use in callbacks.
locale AgLocaleOptions
Configuration for localisation.
ranges AgRangesOptions
Configuration for the ranges buttons.
keyboard AgKeyboardOptions
Keyboard navigation options.
touch AgTouchOptions
Touch input options.
selection AgChartSelectionOptions
Data selection options
suppressFieldDotNotation boolean default: false
Suppress treatment of series keys as JavaScript paths when `true`.
styleNonce string default: undefined
A nonce to be used by any dynamically injected CSS `<style>` tags to assist with Content Security Policy. See [https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/nonce](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/nonce).
listeners AgBaseChartListeners
A map of event names to event listeners.
loadGoogleFonts boolean default: false
Load fonts automatically from Google's CDN.
navigator AgNavigatorOptions
Configuration for the Navigator.
scrollbar AgScrollbarOptions
Configuration for the Scrollbars.
sync AgChartSyncOptions
Configuration for synchronizing multiple charts.
zoom AgZoomOptions
Configuration for the zoom options.
formatter FormatterConfiguration
Global formatter configuration.
enableRtl boolean
Set to `true` to render the chart in right-to-left mode. If not specified, the chart will detect the `dir` attribute on the container or its ancestors.