AgChartOptions
- theme
AgChartTheme | AgChartThemeName - A predefined theme name or an object containing theme overrides. See: [Themes Reference](/themes-api/)
- seriesArea
AgCartesianSeriesAreaOptions - Configuration relating to the series area.
-
- backgroundRegions
AgSeriesAreaBackgroundRegion[] - Rectangular regions filled behind the series, each bounded by value ranges on an x-axis and a y-axis.
- border
BorderOptions - The border around the series area.
- clip
boolean - Controls whether to strictly clip the series rendering to the series area.
- cornerRadius
number - The corner radius of the series area.
- padding
Padding - Configuration for the padding inside the series area. A number applies uniform padding; an object sets each side.
- backgroundRegions
- 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.
-
- axesButtons
AgAnnotationAxesButtons - The options for the axes buttons
- toolbar
AgAnnotationsToolbar - Configuration for the toolbar for creating annotations.
- optionsToolbar
AgAnnotationOptionsToolbar - Configuration for the options toolbar for editing an annotation.
- enabled
boolean - Whether the associated elements and properties should be used in the chart.
- axesButtons
- 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.
-
- active
AgActiveState - The initial picked item.
- annotations
AgAnnotation[] - The initial set of annotations to display on the chart.
- chartType
AgInitialStateChartType - The initial chart type.
- collapsed
Array<string | number> - The initial collapsed datums by id, for Organization Charts.
- legend
AgInitialStateLegendOptions[] - The initial legend series visibility state.
- legendPagination
number - The initial legend pagination page as a zero-based index, restored on a best-effort like-for-like basis as the page count depends on the render size.
- zoom
AgInitialStateZoomOptions - The initial zoom state.
- active
- loading
boolean - Set to show or hide the loading overlay.
- validations
AgChartValidationsOptions - Configuration for how the chart reports invalid configuration and runtime problems.
-
- consoleOn
AgChartValidationSeverity[]default: ['error', 'warning', 'deprecation'] - The severities to write to the browser console.
- showOverlayOn
AgChartValidationSeverity[]default: [] - The severities to report in an overlay on the chart itself.
- throwOn
AgChartValidationSeverity[]default: [] - The severities that cause the chart to throw instead of warning and falling back to a default. Console output is never suppressed by this option.
- issueRaised
Functiondefault: undefined - Called for each validation issue the chart raises.
- consoleOn
- width
PixelSize - The width of the chart in pixels.
- height
PixelSize - The height of the chart in pixels.
- minHeight
PixelSizedefault: 300 - Sets the minimum height of the chart. Ignored if `height` is specified.
- minWidth
PixelSizedefault: 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.
- background
AgChartBackground - Configuration for the background shown behind the chart.
-
- visible
boolean - Whether the background should be visible.
- fill
CssColor - Colour of the chart background.
- image
AgChartBackgroundImage - Background image. May be combined with fill colour.
- visible
- title
AgChartCaptionOptions - Configuration for the title shown at the top of the chart.
-
- enabled
boolean - Whether the text should be shown.
- text
TextOrSegments - The text to display. Plain text, or an array of segments for rich content.
- textAlign
TextAlign - Horizontal position of the text.
- fontStyle
FontStyle - The font style to use for the text.
- fontWeight
FontWeight - The font weight to use for the text.
- fontSize
FontSize - The font size in pixels to use for the text.
- fontFamily
FontFamilyFull - The font family to use for the text. A single family name, or an array of names used as fallbacks.
- color
AgCssColorOrRef - The colour to use for the text. A colour string, or a theme-colour reference object.
- spacing
PixelSize - Spacing added to help position the text.
- maxWidth
PixelSize - Used to constrain the width of the title before text is wrapped or truncated.
- maxHeight
PixelSize - Used to constrain the height of the title before text is truncated.
- minimumFontSize
FontSize - If the text does not fit within the space available to it, setting this will allow the text to pick a font size between its normal `fontSize` and `minimumFontSize` to fit. The text is only truncated when it still does not fit at `minimumFontSize`.
- wrapping
TextWrapdefault: 'on-space' - Text wrapping strategy for long text. - `'always'` will always wrap text to fit within the `maxWidth`. - `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word. - `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the `maxWidth`, the text will be truncated. - `'never'` disables text wrapping.
- tooltip
AgCaptionTooltipOptions - Configuration for the caption tooltip shown on hover.
- listeners
AgCaptionListeners - A map of event names to event listeners.
- border
BorderOptions - Stroke options for the box border.
- cornerRadius
PixelSize - Apply rounded corners to the label box.
- padding
Padding - Distance between the label text and the border. A number applies uniform padding; an object sets each side.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- enabled
- subtitle
AgChartSubtitleOptions - Configuration for the subtitle shown beneath the chart title.
-
- enabled
boolean - Whether the text should be shown.
- text
TextOrSegments - The text to display. Plain text, or an array of segments for rich content.
- textAlign
TextAlign - Horizontal position of the text.
- fontStyle
FontStyle - The font style to use for the text.
- fontWeight
FontWeight - The font weight to use for the text.
- fontSize
FontSize - The font size in pixels to use for the text.
- fontFamily
FontFamilyFull - The font family to use for the text. A single family name, or an array of names used as fallbacks.
- color
AgCssColorOrRef - The colour to use for the text. A colour string, or a theme-colour reference object.
- spacing
PixelSize - Spacing added to help position the text.
- maxWidth
PixelSize - Used to constrain the width of the title before text is wrapped or truncated.
- maxHeight
PixelSize - Used to constrain the height of the title before text is truncated.
- minimumFontSize
FontSize - If the text does not fit within the space available to it, setting this will allow the text to pick a font size between its normal `fontSize` and `minimumFontSize` to fit. The text is only truncated when it still does not fit at `minimumFontSize`.
- wrapping
TextWrapdefault: 'on-space' - Text wrapping strategy for long text. - `'always'` will always wrap text to fit within the `maxWidth`. - `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word. - `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the `maxWidth`, the text will be truncated. - `'never'` disables text wrapping.
- tooltip
AgCaptionTooltipOptions - Configuration for the caption tooltip shown on hover.
- listeners
AgCaptionListeners - A map of event names to event listeners.
- border
BorderOptions - Stroke options for the box border.
- cornerRadius
PixelSize - Apply rounded corners to the label box.
- padding
Padding - Distance between the label text and the border. A number applies uniform padding; an object sets each side.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- enabled
- footnote
AgChartFooterOptions - Configuration for the footnote shown at the bottom of the chart.
-
- enabled
boolean - Whether the text should be shown.
- text
TextOrSegments - The text to display. Plain text, or an array of segments for rich content.
- textAlign
TextAlign - Horizontal position of the text.
- fontStyle
FontStyle - The font style to use for the text.
- fontWeight
FontWeight - The font weight to use for the text.
- fontSize
FontSize - The font size in pixels to use for the text.
- fontFamily
FontFamilyFull - The font family to use for the text. A single family name, or an array of names used as fallbacks.
- color
AgCssColorOrRef - The colour to use for the text. A colour string, or a theme-colour reference object.
- spacing
PixelSize - Spacing added to help position the text.
- maxWidth
PixelSize - Used to constrain the width of the title before text is wrapped or truncated.
- maxHeight
PixelSize - Used to constrain the height of the title before text is truncated.
- minimumFontSize
FontSize - If the text does not fit within the space available to it, setting this will allow the text to pick a font size between its normal `fontSize` and `minimumFontSize` to fit. The text is only truncated when it still does not fit at `minimumFontSize`.
- wrapping
TextWrapdefault: 'on-space' - Text wrapping strategy for long text. - `'always'` will always wrap text to fit within the `maxWidth`. - `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word. - `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the `maxWidth`, the text will be truncated. - `'never'` disables text wrapping.
- tooltip
AgCaptionTooltipOptions - Configuration for the caption tooltip shown on hover.
- listeners
AgCaptionListeners - A map of event names to event listeners.
- border
BorderOptions - Stroke options for the box border.
- cornerRadius
PixelSize - Apply rounded corners to the label box.
- padding
Padding - Distance between the label text and the border. A number applies uniform padding; an object sets each side.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- enabled
- highlight
AgChartHighlightOptions - Configuration for the chart highlighting.
-
- enabled
booleandefault: true - Set to `false` to disable highlighting for all series in the chart.
- range
AgChartHighlightRange - By default, nodes will be highlighted when the cursor is within the `tooltip.range`. Set this to `'node'` to highlight nodes when within the `series[].nodeClickRange`.
- mode
AgChartHighlightModedefault: 'single' - Determines which items are highlighted when hovering an item. - `'single'` highlights the hovered item only. - `'shared'` also highlights the item of every other series that shares the hovered item's category, using the same grouping as `tooltip.mode: 'shared'`. Series with no item at that category - including series with no category concept, such as scatter and bubble - are unhighlighted as a whole series.
- drawingMode
AgDrawingModedefault: 'cutout' - Determines the rendering behaviour of the highlight relative to existing chart content. - `'overlay'` renders the highlight above existing content, both layers remain visible where they overlap. - `'cutout'` removes existing content in overlapping areas, showing only the highlight.
- enabled
- overlays
AgChartOverlaysOptions - HTML overlays.
-
- loading
AgChartOverlayOptions - An overlay to be displayed when there is no data.
- noData
AgChartOverlayOptions - An overlay to be displayed when there is no data.
- noVisibleSeries
AgChartOverlayOptions - An overlay to be displayed when there are no series visible.
- unsupportedBrowser
AgChartOverlayOptions - An overlay to be displayed when chart is running in an unsupported browser.
- loading
- tooltip
AgChartTooltipOptions - Global configuration that applies to all tooltips in the chart.
-
- enabled
boolean - Set to `false` to disable tooltips for all series in the chart.
- mode
AgTooltipMode - Group multiple series into the same tooltip
- showArrow
boolean - The tooltip arrow is displayed by default, unless the container restricts it or a position offset is provided. To always display the arrow, set `showArrow` to `true`. To remove the arrow, set `showArrow` to `false`.
- range
InteractionRange - Range from a point that triggers the tooltip to show. This will be used unless overridden by the series `tooltip.range` option.
- position
AgTooltipPositionOptions - The position of the tooltip. This will be used unless overridden by the series `tooltip.range` option.
- pagination
boolean - The configuration for tooltip pagination.
- delay
DurationMs - The time interval (in milliseconds) after which the tooltip is shown.
- wrapping
TextWrapdefault: 'hyphenate' - Text wrapping strategy for tooltips. - `'always'` will always wrap text to fit within the tooltip. - `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word. - `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the tooltip dimensions, the text will be truncated. - `'never'` disables text wrapping.
- enabled
- legend
AgChartLegendOptions - Configuration for the chart legend.
-
- enabled
boolean - Whether to show the legend. By default, the chart displays a legend when there is more than one series present.
- position
AgChartLegendPositiondefault: 'bottom' - Where the legend should be positioned in relation to the chart. A placement keyword, or an object for fine-grained positioning.
- orientation
AgChartLegendOrientation - How the legend items should be arranged.
- maxWidth
PixelSize - Used to constrain the width of the legend.
- maxHeight
PixelSize - Used to constrain the height of the legend.
- border
BorderOptions - The border around the legend.
- cornerRadius
PixelSize - The corner radius of the legend.
- padding
Padding - The padding between the border and legend items. A number applies uniform padding; an object sets each side.
- spacing
PixelSizedefault: 30 - The spacing in pixels to use outside the legend. __Note:__ This only applies when `floating: false`.
- item
AgChartLegendItemOptions - Configuration for the legend items that consist of a marker and a label.
- reverseOrder
boolean - Reverse the display order of legend items if `true`.
- listeners
AgChartLegendListeners - Optional callbacks for specific legend-related events.
- pagination
AgChartLegendPaginationOptions - Configuration for the pagination controls.
- preventHidingAll
boolean - Set to `true` to prevent the last visible series from being toggled hidden.
- toggleSeries
boolean - Set to `false` to turn off toggling of the series visibility in the chart when a legend item is clicked.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- enabled
- gradientLegend
AgGradientLegendOptions - Configuration for the gradient legend.
-
- enabled
boolean - Whether to show the gradient legend. By default, the chart displays a gradient legend for series using a `colorKey`.
- position
AgChartLegendPositiondefault: 'bottom' - Position of the gradient legend. A placement keyword, or an object for fine-grained positioning.
- gradient
AgGradientLegendBarOptions - Gradient bar configuration.
- spacing
PixelSizedefault: 20 - The spacing in pixels to use outside the legend. __Note:__ This only applies when `floating: false`.
- reverseOrder
boolean - Reverse the display order of legend items if `true`.
- scale
AgGradientLegendScaleOptions - Options for the numbers that appear below or to the side of the gradient.
- border
BorderOptions - The border around the legend.
- cornerRadius
PixelSize - The corner radius of the legend.
- padding
Padding - The padding between the border and legend items. A number applies uniform padding; an object sets each side.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- enabled
- animation
AgAnimationOptions - Configuration for chart animations.
-
- enabled
boolean - Set to `true` to enable the animation module. Defaults to `false` when `flashOnUpdate.enabled` is `true`.
- duration
DurationMs - The total duration of the animation on initial load and updates.
- enabled
- flashOnUpdate
AgFlashOnUpdateOptions - Configuration for the flash on update effect.
-
- enabled
boolean - Whether the flash effect is enabled.
- item
AgFlashOnUpdateItem - What part of the chart to flash.
- fill
CssColor - The fill colour of the flash effect.
- fillOpacity
Opacity - The fill opacity of the flash effect.
- flashDuration
DurationMs - The flash hold duration in milliseconds before fading begins. Actual timing may vary when animations are enabled.
- fadeOutDuration
DurationMs - The fade-out duration in milliseconds. Actual timing may vary when animations are enabled.
- enabled
- dataSource
AgDataSourceOptions - Configuration for asynchronously loaded data.
-
- getData required
Function - Asynchronous callback to load data into the chart.
- getData required
- contextMenu
AgContextMenuOptions - Configuration for the context menu.
-
- enabled
booleandefault: true - Whether to show the context menu.
- items
AgContextMenuItem[]default: ['defaults'] - List of menu items (and submenus) for the context menu.
- getItems
AgContextMenuGetItemsCallbackdefault: undefined - Callback to list the menu items (and submenus) for the context menu. Overrides `items` if return-value is defined, otherwise `items` is used as a fallback.
- enabled
- context
TContext - Context object to use in callbacks.
- locale
AgLocaleOptions - Configuration for localisation.
-
- localeText
Record - A record of locale texts keyed by id.
- getLocaleText
Formatter - Formatter that generates the text displayed to the user.
- localeText
- ranges
AgRangesOptions - Configuration for the ranges buttons.
-
- enableOutOfRange
booleandefault: false - Whether out of range buttons should be enabled.
- gap
PixelSizedefault: 0 - The gap between each button.
- position
AgRangesPositiondefault: 'top-right' - The position of the range buttons on the chart.
- spacing
PixelSizedefault: 10 - The spacing between the range buttons and the series area or axis when positioned at the top or bottom, respectively.
- button
AgRangesButtonStyles - dropdown
AgRangesDropdown - buttons
AgRangesButton[] - The buttons to display.
- enabled
boolean - Whether the associated elements and properties should be used in the chart.
- cornerRadius
PixelSize - padding
Padding - The padding inside the range buttons. A number applies uniform padding; an object sets each side.
- textColor
CssColor - active
AgRangesStateStyles - disabled
AgRangesStateStyles - hover
AgRangesStateStyles - fill
CssColor - The colour for filling shapes.
- fillOpacity
Opacity - The opacity of the fill colour.
- fontSize
FontSize - The size of the font in pixels for text elements.
- fontFamily
FontFamily - The font family for text elements.
- fontStyle
FontStyle - The style to use for text elements.
- fontWeight
FontWeight - The font weight to use for text elements.
- stroke
AgCssColorOrRef - The colour for the stroke.
- strokeWidth
PixelSize - The width of the stroke in pixels.
- enableOutOfRange
- keyboard
AgKeyboardOptions - Keyboard navigation options.
-
- enabled
booleandefault: true - Toggles the keyboard navigation feature.
- tabIndex
numberdefault: 0 - Allows setting the tabIndex of the chart canvas.
- initialFocus
AgInitialFocusdefault: 'data-start' - Determines which datum receives focus when keyboard navigation first enters the chart. - `'data-start'` and `'data-end'` reference the full dataset - `'viewport-start'` and `'viewport-end'` reference the initial visible zoom viewport
- enabled
- touch
AgTouchOptions - Touch input options.
-
- dragAction
'none' | 'drag' | 'hover'default: 'drag' - Sets the input handling behaviour for single-finger touch drag events. - `'none'` - ignores these events, typically causing the default page-scrolling behaviour. - `'hover'` - makes these behave like mouse hover events, showing tooltip and crosshairs. - `'drag'` - makes these behave like mouse drag events (moving while holding left-button).
- dragAction
- selection
AgChartSelectionOptions - Data selection options
-
- enabled
booleandefault: false - Set to `true` to enable the data-selection module.
- enableClick
booleandefault: true - Set to `true` to enable click-to-select.
- enableDrag
booleandefault: false - Set to `true` to enable drag-to-select.
- enableClickAwayToClear
booleandefault: true - Set to `true` to clear the selection by clicking an empty space on the chart.
- clickMode
AgSelectionClickModedefault: 'single' - Click-to-select mode. `'single'` replaces the current selection; `'multiple'` toggles each click. Holding Control (or Command) temporarily promotes a single click to `'multiple'`.
- containment
AgSelectionContainmentdefault: 'any' - Drag-to-select containment rule. `'any'` selects a datum when any part overlaps the drag rectangle; `'all'` requires the datum to be fully enclosed.
- enabled
- suppressFieldDotNotation
booleandefault: false - Suppress treatment of series keys as JavaScript paths when `true`.
- styleNonce
stringdefault: 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.
-
- seriesNodeClick
Listener - The listener to call when a node (marker, column, bar, tile or a pie sector) in any series is clicked. Useful for a chart containing multiple series.
- seriesNodeDoubleClick
Listener - The listener to call when a node (marker, column, bar, tile or a pie sector) in any series is double-clicked. Useful for a chart containing multiple series.
- axisClick
Listener - The listener to call when any axis in the chart is clicked. Useful for a chart containing multiple axes.
- axisDoubleClick
Listener - The listener to call when any axis in the chart is double-clicked. Useful for a chart containing multiple axes.
- captionClick
Listener - The listener to call when any caption (title, subtitle or footnote) in the chart is clicked.
- captionDoubleClick
Listener - The listener to call when any caption (title, subtitle or footnote) in the chart is double-clicked.
- seriesVisibilityChange
Listener - The listener to call when a series visibility is changed.
- activeChange
Listener - The listener to call when the active state (highlight/tooltip) is changed.
- selectionChange
Listener - The listener to call when data selection is changed
- collapsedChange
Listener - The listener to call when collapsed items are changed.
- click
Listener - The listener to call when the chart is clicked.
- doubleClick
Listener - The listener to call when the chart is double-clicked.
- crossLineClick
Listener - The listener to call when a Cross Line on any axis is clicked.
- crossLineDoubleClick
Listener - The listener to call when a Cross Line on any axis is double-clicked.
- annotations
Listener - The listener to call when the annotations are changed.
- zoom
Listener - The listener to call when the zoom is changed.
- seriesNodeClick
- loadGoogleFonts
booleandefault: false - Load fonts automatically from Google's CDN.
- scrollbar
AgScrollbarOptions - Configuration for the Scrollbars.
-
- enableAxisScrolling
booleandefault: false - Whether scrolling on the axis should scroll the scrollbar.
- enableSeriesAreaScrolling
booleandefault: true - Whether scrolling on the series area should scroll the scrollbar.
- horizontal
AgScrollbarHorizontalOrientationOptions - Options applied to the horizontal scrollbar.
- vertical
AgScrollbarVerticalOrientationOptions - Options applied to the vertical scrollbar.
- enabled
boolean - Set to `true` to enable the scrollbar.
- thickness
number - Thickness of the scrollbar in pixels (height for horizontal, width for vertical).
- spacing
number - Spacing in pixels between the scrollbar and the series area or axis labels, depending on placement.
- tickSpacing
number - Spacing in pixels between ticks on the scrollbar (if applicable).
- track
AgScrollbarTrackStyle - Styling options for the scrollbar track.
- thumb
AgScrollbarThumbStyle - Styling options for the scrollbar thumb.
- visible
AgScrollbarVisibility - Controls when the scrollbar is shown.
- placement
AgScrollbarPlacement - Controls whether the scrollbar is placed inside the axis label and ticks or outside.
- enableAxisScrolling
- sync
AgChartSyncOptions - Configuration for synchronizing multiple charts.
-
- enabled
boolean - Toggles the synchronization feature. It is implicitly enabled when configuration options are provided; otherwise, it defaults to `false`.
- groupId
string - Specifies the synchronization group identifier for the chart. Omitting this assigns the chart to a default synchronization group.
- axes
'x' | 'y' | 'xy'default: x - Determines the axes to be synchronized across charts.
- nodeInteraction
booleandefault: true - Enables synchronization of node interactions across charts.
- zoom
booleandefault: true - Enables synchronization of zoom actions across charts.
- enabled
- zoom
AgZoomOptions - Configuration for the zoom options.
-
- anchorPointX
AgZoomAnchorPointdefault: end - The anchor point for the x-axis about which to zoom into when scrolling.
- anchorPointY
AgZoomAnchorPointdefault: middle - The anchor point for the y-axis about which to zoom into when scrolling.
- autoScaling
AgZoomAutoScaling - Zoom auto scaling options.
- axes
AgZoomAxesdefault: x - The axes on which to zoom when scrolling, one of `xy`, `x`, or `y`.
- axisDraggingMode
AgZoomAxisDraggingModedefault: zoom - Whether dragging an axis pans or zooms, if `enableAxisDragging` is enabled.
- buttons
AgZoomButtons - A set of buttons to perform common zoom actions.
- deceleration
AgZoomDecelerationdefault: short - Rate of deceleration of panning when dragging and releasing a zoomed chart.
- enabled
booleandefault: false - Set to `true` to enable the zoom module.
- enableAxisDragging
booleandefault: true - Set to `true` to enable dragging an axis to zoom series attached to that axis.
- enableAxisScrolling
booleandefault: true - Set to `true` to enable scrolling an axis to zoom series attached to that axis.
- enableDoubleClickToReset
booleandefault: true - Set to `true` to enable double-clicking to reset the chart to fully zoomed out.
- enablePanning
booleandefault: true - Set to `true` to enable panning while zoomed.
- enableScrolling
booleandefault: true - Set to `true` to enable zooming with the mouse wheel.
- enableSelecting
booleandefault: false - Set to `true` to enable selecting an area of the chart to zoom into.
- enableTwoFingerZoom
booleandefault: true - Set to `true` to enable zoom-panning with two touch points.
- keepAspectRatio
booleandefault: false - Set to `true` to keep the selection area matching the chart's aspect ratio.
- minVisibleItems
numberdefault: 2 - The minimum number of items to be shown, beyond which zooming is stopped. Set to `0` to allow unlimited zooming.
- panKey
AgZoomPanKeydefault: alt - The key that should be pressed to allow dragging to pan around while zoomed, one of `alt`, `ctrl`, `meta` or `shift`.
- scrollingMode
AgZoomScrollingModedefault: zoom - Whether scrolling the mouse wheel or track pad vertically zooms or pans.
- scrollingStep
Ratiodefault: 0.1 - The amount to zoom when scrolling with the mouse wheel, as a ratio of the full chart.
- onDataChange
AgZoomOnDataChange - Configuration for how the zoom-pan should respond to data changes
- anchorPointX
- 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.
AgChartOptions
- theme
AgChartTheme | AgChartThemeName - A predefined theme name or an object containing theme overrides. See: [Themes Reference](/themes-api/)
- seriesArea
AgCartesianSeriesAreaOptions - Configuration relating to the series area.
-
- backgroundRegions
AgSeriesAreaBackgroundRegion[] - Rectangular regions filled behind the series, each bounded by value ranges on an x-axis and a y-axis.
- border
BorderOptions - The border around the series area.
- clip
boolean - Controls whether to strictly clip the series rendering to the series area.
- cornerRadius
number - The corner radius of the series area.
- padding
Padding - Configuration for the padding inside the series area. A number applies uniform padding; an object sets each side.
- backgroundRegions
- 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.
-
- axesButtons
AgAnnotationAxesButtons - The options for the axes buttons
- toolbar
AgAnnotationsToolbar - Configuration for the toolbar for creating annotations.
- optionsToolbar
AgAnnotationOptionsToolbar - Configuration for the options toolbar for editing an annotation.
- enabled
boolean - Whether the associated elements and properties should be used in the chart.
- axesButtons
- 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.
-
- active
AgActiveState - The initial picked item.
- annotations
AgAnnotation[] - The initial set of annotations to display on the chart.
- chartType
AgInitialStateChartType - The initial chart type.
- collapsed
Array<string | number> - The initial collapsed datums by id, for Organization Charts.
- legend
AgInitialStateLegendOptions[] - The initial legend series visibility state.
- legendPagination
number - The initial legend pagination page as a zero-based index, restored on a best-effort like-for-like basis as the page count depends on the render size.
- zoom
AgInitialStateZoomOptions - The initial zoom state.
- active
- loading
boolean - Set to show or hide the loading overlay.
- validations
AgChartValidationsOptions - Configuration for how the chart reports invalid configuration and runtime problems.
-
- consoleOn
AgChartValidationSeverity[]default: ['error', 'warning', 'deprecation'] - The severities to write to the browser console.
- showOverlayOn
AgChartValidationSeverity[]default: [] - The severities to report in an overlay on the chart itself.
- throwOn
AgChartValidationSeverity[]default: [] - The severities that cause the chart to throw instead of warning and falling back to a default. Console output is never suppressed by this option.
- issueRaised
Functiondefault: undefined - Called for each validation issue the chart raises.
- consoleOn
- width
PixelSize - The width of the chart in pixels.
- height
PixelSize - The height of the chart in pixels.
- minHeight
PixelSizedefault: 300 - Sets the minimum height of the chart. Ignored if `height` is specified.
- minWidth
PixelSizedefault: 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.
- background
AgChartBackground - Configuration for the background shown behind the chart.
-
- visible
boolean - Whether the background should be visible.
- fill
CssColor - Colour of the chart background.
- image
AgChartBackgroundImage - Background image. May be combined with fill colour.
- visible
- title
AgChartCaptionOptions - Configuration for the title shown at the top of the chart.
-
- enabled
boolean - Whether the text should be shown.
- text
TextOrSegments - The text to display. Plain text, or an array of segments for rich content.
- textAlign
TextAlign - Horizontal position of the text.
- fontStyle
FontStyle - The font style to use for the text.
- fontWeight
FontWeight - The font weight to use for the text.
- fontSize
FontSize - The font size in pixels to use for the text.
- fontFamily
FontFamilyFull - The font family to use for the text. A single family name, or an array of names used as fallbacks.
- color
AgCssColorOrRef - The colour to use for the text. A colour string, or a theme-colour reference object.
- spacing
PixelSize - Spacing added to help position the text.
- maxWidth
PixelSize - Used to constrain the width of the title before text is wrapped or truncated.
- maxHeight
PixelSize - Used to constrain the height of the title before text is truncated.
- minimumFontSize
FontSize - If the text does not fit within the space available to it, setting this will allow the text to pick a font size between its normal `fontSize` and `minimumFontSize` to fit. The text is only truncated when it still does not fit at `minimumFontSize`.
- wrapping
TextWrapdefault: 'on-space' - Text wrapping strategy for long text. - `'always'` will always wrap text to fit within the `maxWidth`. - `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word. - `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the `maxWidth`, the text will be truncated. - `'never'` disables text wrapping.
- tooltip
AgCaptionTooltipOptions - Configuration for the caption tooltip shown on hover.
- listeners
AgCaptionListeners - A map of event names to event listeners.
- border
BorderOptions - Stroke options for the box border.
- cornerRadius
PixelSize - Apply rounded corners to the label box.
- padding
Padding - Distance between the label text and the border. A number applies uniform padding; an object sets each side.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- enabled
- subtitle
AgChartSubtitleOptions - Configuration for the subtitle shown beneath the chart title.
-
- enabled
boolean - Whether the text should be shown.
- text
TextOrSegments - The text to display. Plain text, or an array of segments for rich content.
- textAlign
TextAlign - Horizontal position of the text.
- fontStyle
FontStyle - The font style to use for the text.
- fontWeight
FontWeight - The font weight to use for the text.
- fontSize
FontSize - The font size in pixels to use for the text.
- fontFamily
FontFamilyFull - The font family to use for the text. A single family name, or an array of names used as fallbacks.
- color
AgCssColorOrRef - The colour to use for the text. A colour string, or a theme-colour reference object.
- spacing
PixelSize - Spacing added to help position the text.
- maxWidth
PixelSize - Used to constrain the width of the title before text is wrapped or truncated.
- maxHeight
PixelSize - Used to constrain the height of the title before text is truncated.
- minimumFontSize
FontSize - If the text does not fit within the space available to it, setting this will allow the text to pick a font size between its normal `fontSize` and `minimumFontSize` to fit. The text is only truncated when it still does not fit at `minimumFontSize`.
- wrapping
TextWrapdefault: 'on-space' - Text wrapping strategy for long text. - `'always'` will always wrap text to fit within the `maxWidth`. - `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word. - `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the `maxWidth`, the text will be truncated. - `'never'` disables text wrapping.
- tooltip
AgCaptionTooltipOptions - Configuration for the caption tooltip shown on hover.
- listeners
AgCaptionListeners - A map of event names to event listeners.
- border
BorderOptions - Stroke options for the box border.
- cornerRadius
PixelSize - Apply rounded corners to the label box.
- padding
Padding - Distance between the label text and the border. A number applies uniform padding; an object sets each side.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- enabled
- footnote
AgChartFooterOptions - Configuration for the footnote shown at the bottom of the chart.
-
- enabled
boolean - Whether the text should be shown.
- text
TextOrSegments - The text to display. Plain text, or an array of segments for rich content.
- textAlign
TextAlign - Horizontal position of the text.
- fontStyle
FontStyle - The font style to use for the text.
- fontWeight
FontWeight - The font weight to use for the text.
- fontSize
FontSize - The font size in pixels to use for the text.
- fontFamily
FontFamilyFull - The font family to use for the text. A single family name, or an array of names used as fallbacks.
- color
AgCssColorOrRef - The colour to use for the text. A colour string, or a theme-colour reference object.
- spacing
PixelSize - Spacing added to help position the text.
- maxWidth
PixelSize - Used to constrain the width of the title before text is wrapped or truncated.
- maxHeight
PixelSize - Used to constrain the height of the title before text is truncated.
- minimumFontSize
FontSize - If the text does not fit within the space available to it, setting this will allow the text to pick a font size between its normal `fontSize` and `minimumFontSize` to fit. The text is only truncated when it still does not fit at `minimumFontSize`.
- wrapping
TextWrapdefault: 'on-space' - Text wrapping strategy for long text. - `'always'` will always wrap text to fit within the `maxWidth`. - `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word. - `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the `maxWidth`, the text will be truncated. - `'never'` disables text wrapping.
- tooltip
AgCaptionTooltipOptions - Configuration for the caption tooltip shown on hover.
- listeners
AgCaptionListeners - A map of event names to event listeners.
- border
BorderOptions - Stroke options for the box border.
- cornerRadius
PixelSize - Apply rounded corners to the label box.
- padding
Padding - Distance between the label text and the border. A number applies uniform padding; an object sets each side.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- enabled
- highlight
AgChartHighlightOptions - Configuration for the chart highlighting.
-
- enabled
booleandefault: true - Set to `false` to disable highlighting for all series in the chart.
- range
AgChartHighlightRange - By default, nodes will be highlighted when the cursor is within the `tooltip.range`. Set this to `'node'` to highlight nodes when within the `series[].nodeClickRange`.
- mode
AgChartHighlightModedefault: 'single' - Determines which items are highlighted when hovering an item. - `'single'` highlights the hovered item only. - `'shared'` also highlights the item of every other series that shares the hovered item's category, using the same grouping as `tooltip.mode: 'shared'`. Series with no item at that category - including series with no category concept, such as scatter and bubble - are unhighlighted as a whole series.
- drawingMode
AgDrawingModedefault: 'cutout' - Determines the rendering behaviour of the highlight relative to existing chart content. - `'overlay'` renders the highlight above existing content, both layers remain visible where they overlap. - `'cutout'` removes existing content in overlapping areas, showing only the highlight.
- enabled
- overlays
AgChartOverlaysOptions - HTML overlays.
-
- loading
AgChartOverlayOptions - An overlay to be displayed when there is no data.
- noData
AgChartOverlayOptions - An overlay to be displayed when there is no data.
- noVisibleSeries
AgChartOverlayOptions - An overlay to be displayed when there are no series visible.
- unsupportedBrowser
AgChartOverlayOptions - An overlay to be displayed when chart is running in an unsupported browser.
- loading
- tooltip
AgChartTooltipOptions - Global configuration that applies to all tooltips in the chart.
-
- enabled
boolean - Set to `false` to disable tooltips for all series in the chart.
- mode
AgTooltipMode - Group multiple series into the same tooltip
- showArrow
boolean - The tooltip arrow is displayed by default, unless the container restricts it or a position offset is provided. To always display the arrow, set `showArrow` to `true`. To remove the arrow, set `showArrow` to `false`.
- range
InteractionRange - Range from a point that triggers the tooltip to show. This will be used unless overridden by the series `tooltip.range` option.
- position
AgTooltipPositionOptions - The position of the tooltip. This will be used unless overridden by the series `tooltip.range` option.
- pagination
boolean - The configuration for tooltip pagination.
- delay
DurationMs - The time interval (in milliseconds) after which the tooltip is shown.
- wrapping
TextWrapdefault: 'hyphenate' - Text wrapping strategy for tooltips. - `'always'` will always wrap text to fit within the tooltip. - `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word. - `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the tooltip dimensions, the text will be truncated. - `'never'` disables text wrapping.
- enabled
- legend
AgChartLegendOptions - Configuration for the chart legend.
-
- enabled
boolean - Whether to show the legend. By default, the chart displays a legend when there is more than one series present.
- position
AgChartLegendPositiondefault: 'bottom' - Where the legend should be positioned in relation to the chart. A placement keyword, or an object for fine-grained positioning.
- orientation
AgChartLegendOrientation - How the legend items should be arranged.
- maxWidth
PixelSize - Used to constrain the width of the legend.
- maxHeight
PixelSize - Used to constrain the height of the legend.
- border
BorderOptions - The border around the legend.
- cornerRadius
PixelSize - The corner radius of the legend.
- padding
Padding - The padding between the border and legend items. A number applies uniform padding; an object sets each side.
- spacing
PixelSizedefault: 30 - The spacing in pixels to use outside the legend. __Note:__ This only applies when `floating: false`.
- item
AgChartLegendItemOptions - Configuration for the legend items that consist of a marker and a label.
- reverseOrder
boolean - Reverse the display order of legend items if `true`.
- listeners
AgChartLegendListeners - Optional callbacks for specific legend-related events.
- pagination
AgChartLegendPaginationOptions - Configuration for the pagination controls.
- preventHidingAll
boolean - Set to `true` to prevent the last visible series from being toggled hidden.
- toggleSeries
boolean - Set to `false` to turn off toggling of the series visibility in the chart when a legend item is clicked.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- enabled
- gradientLegend
AgGradientLegendOptions - Configuration for the gradient legend.
-
- enabled
boolean - Whether to show the gradient legend. By default, the chart displays a gradient legend for series using a `colorKey`.
- position
AgChartLegendPositiondefault: 'bottom' - Position of the gradient legend. A placement keyword, or an object for fine-grained positioning.
- gradient
AgGradientLegendBarOptions - Gradient bar configuration.
- spacing
PixelSizedefault: 20 - The spacing in pixels to use outside the legend. __Note:__ This only applies when `floating: false`.
- reverseOrder
boolean - Reverse the display order of legend items if `true`.
- scale
AgGradientLegendScaleOptions - Options for the numbers that appear below or to the side of the gradient.
- border
BorderOptions - The border around the legend.
- cornerRadius
PixelSize - The corner radius of the legend.
- padding
Padding - The padding between the border and legend items. A number applies uniform padding; an object sets each side.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- enabled
- animation
AgAnimationOptions - Configuration for chart animations.
-
- enabled
boolean - Set to `true` to enable the animation module. Defaults to `false` when `flashOnUpdate.enabled` is `true`.
- duration
DurationMs - The total duration of the animation on initial load and updates.
- enabled
- flashOnUpdate
AgFlashOnUpdateOptions - Configuration for the flash on update effect.
-
- enabled
boolean - Whether the flash effect is enabled.
- item
AgFlashOnUpdateItem - What part of the chart to flash.
- fill
CssColor - The fill colour of the flash effect.
- fillOpacity
Opacity - The fill opacity of the flash effect.
- flashDuration
DurationMs - The flash hold duration in milliseconds before fading begins. Actual timing may vary when animations are enabled.
- fadeOutDuration
DurationMs - The fade-out duration in milliseconds. Actual timing may vary when animations are enabled.
- enabled
- dataSource
AgDataSourceOptions - Configuration for asynchronously loaded data.
-
- getData required
Function - Asynchronous callback to load data into the chart.
- getData required
- contextMenu
AgContextMenuOptions - Configuration for the context menu.
-
- enabled
booleandefault: true - Whether to show the context menu.
- items
AgContextMenuItem[]default: ['defaults'] - List of menu items (and submenus) for the context menu.
- getItems
AgContextMenuGetItemsCallbackdefault: undefined - Callback to list the menu items (and submenus) for the context menu. Overrides `items` if return-value is defined, otherwise `items` is used as a fallback.
- enabled
- context
TContext - Context object to use in callbacks.
- locale
AgLocaleOptions - Configuration for localisation.
-
- localeText
Record - A record of locale texts keyed by id.
- getLocaleText
Formatter - Formatter that generates the text displayed to the user.
- localeText
- ranges
AgRangesOptions - Configuration for the ranges buttons.
-
- enableOutOfRange
booleandefault: false - Whether out of range buttons should be enabled.
- gap
PixelSizedefault: 0 - The gap between each button.
- position
AgRangesPositiondefault: 'top-right' - The position of the range buttons on the chart.
- spacing
PixelSizedefault: 10 - The spacing between the range buttons and the series area or axis when positioned at the top or bottom, respectively.
- button
AgRangesButtonStyles - dropdown
AgRangesDropdown - buttons
AgRangesButton[] - The buttons to display.
- enabled
boolean - Whether the associated elements and properties should be used in the chart.
- cornerRadius
PixelSize - padding
Padding - The padding inside the range buttons. A number applies uniform padding; an object sets each side.
- textColor
CssColor - active
AgRangesStateStyles - disabled
AgRangesStateStyles - hover
AgRangesStateStyles - fill
CssColor - The colour for filling shapes.
- fillOpacity
Opacity - The opacity of the fill colour.
- fontSize
FontSize - The size of the font in pixels for text elements.
- fontFamily
FontFamily - The font family for text elements.
- fontStyle
FontStyle - The style to use for text elements.
- fontWeight
FontWeight - The font weight to use for text elements.
- stroke
AgCssColorOrRef - The colour for the stroke.
- strokeWidth
PixelSize - The width of the stroke in pixels.
- enableOutOfRange
- keyboard
AgKeyboardOptions - Keyboard navigation options.
-
- enabled
booleandefault: true - Toggles the keyboard navigation feature.
- tabIndex
numberdefault: 0 - Allows setting the tabIndex of the chart canvas.
- initialFocus
AgInitialFocusdefault: 'data-start' - Determines which datum receives focus when keyboard navigation first enters the chart. - `'data-start'` and `'data-end'` reference the full dataset - `'viewport-start'` and `'viewport-end'` reference the initial visible zoom viewport
- enabled
- touch
AgTouchOptions - Touch input options.
-
- dragAction
'none' | 'drag' | 'hover'default: 'drag' - Sets the input handling behaviour for single-finger touch drag events. - `'none'` - ignores these events, typically causing the default page-scrolling behaviour. - `'hover'` - makes these behave like mouse hover events, showing tooltip and crosshairs. - `'drag'` - makes these behave like mouse drag events (moving while holding left-button).
- dragAction
- selection
AgChartSelectionOptions - Data selection options
-
- enabled
booleandefault: false - Set to `true` to enable the data-selection module.
- enableClick
booleandefault: true - Set to `true` to enable click-to-select.
- enableDrag
booleandefault: false - Set to `true` to enable drag-to-select.
- enableClickAwayToClear
booleandefault: true - Set to `true` to clear the selection by clicking an empty space on the chart.
- clickMode
AgSelectionClickModedefault: 'single' - Click-to-select mode. `'single'` replaces the current selection; `'multiple'` toggles each click. Holding Control (or Command) temporarily promotes a single click to `'multiple'`.
- containment
AgSelectionContainmentdefault: 'any' - Drag-to-select containment rule. `'any'` selects a datum when any part overlaps the drag rectangle; `'all'` requires the datum to be fully enclosed.
- enabled
- suppressFieldDotNotation
booleandefault: false - Suppress treatment of series keys as JavaScript paths when `true`.
- styleNonce
stringdefault: 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.
-
- seriesNodeClick
Listener - The listener to call when a node (marker, column, bar, tile or a pie sector) in any series is clicked. Useful for a chart containing multiple series.
- seriesNodeDoubleClick
Listener - The listener to call when a node (marker, column, bar, tile or a pie sector) in any series is double-clicked. Useful for a chart containing multiple series.
- axisClick
Listener - The listener to call when any axis in the chart is clicked. Useful for a chart containing multiple axes.
- axisDoubleClick
Listener - The listener to call when any axis in the chart is double-clicked. Useful for a chart containing multiple axes.
- captionClick
Listener - The listener to call when any caption (title, subtitle or footnote) in the chart is clicked.
- captionDoubleClick
Listener - The listener to call when any caption (title, subtitle or footnote) in the chart is double-clicked.
- seriesVisibilityChange
Listener - The listener to call when a series visibility is changed.
- activeChange
Listener - The listener to call when the active state (highlight/tooltip) is changed.
- selectionChange
Listener - The listener to call when data selection is changed
- collapsedChange
Listener - The listener to call when collapsed items are changed.
- click
Listener - The listener to call when the chart is clicked.
- doubleClick
Listener - The listener to call when the chart is double-clicked.
- crossLineClick
Listener - The listener to call when a Cross Line on any axis is clicked.
- crossLineDoubleClick
Listener - The listener to call when a Cross Line on any axis is double-clicked.
- annotations
Listener - The listener to call when the annotations are changed.
- zoom
Listener - The listener to call when the zoom is changed.
- seriesNodeClick
- loadGoogleFonts
booleandefault: false - Load fonts automatically from Google's CDN.
- scrollbar
AgScrollbarOptions - Configuration for the Scrollbars.
-
- enableAxisScrolling
booleandefault: false - Whether scrolling on the axis should scroll the scrollbar.
- enableSeriesAreaScrolling
booleandefault: true - Whether scrolling on the series area should scroll the scrollbar.
- horizontal
AgScrollbarHorizontalOrientationOptions - Options applied to the horizontal scrollbar.
- vertical
AgScrollbarVerticalOrientationOptions - Options applied to the vertical scrollbar.
- enabled
boolean - Set to `true` to enable the scrollbar.
- thickness
number - Thickness of the scrollbar in pixels (height for horizontal, width for vertical).
- spacing
number - Spacing in pixels between the scrollbar and the series area or axis labels, depending on placement.
- tickSpacing
number - Spacing in pixels between ticks on the scrollbar (if applicable).
- track
AgScrollbarTrackStyle - Styling options for the scrollbar track.
- thumb
AgScrollbarThumbStyle - Styling options for the scrollbar thumb.
- visible
AgScrollbarVisibility - Controls when the scrollbar is shown.
- placement
AgScrollbarPlacement - Controls whether the scrollbar is placed inside the axis label and ticks or outside.
- enableAxisScrolling
- sync
AgChartSyncOptions - Configuration for synchronizing multiple charts.
-
- enabled
boolean - Toggles the synchronization feature. It is implicitly enabled when configuration options are provided; otherwise, it defaults to `false`.
- groupId
string - Specifies the synchronization group identifier for the chart. Omitting this assigns the chart to a default synchronization group.
- axes
'x' | 'y' | 'xy'default: x - Determines the axes to be synchronized across charts.
- nodeInteraction
booleandefault: true - Enables synchronization of node interactions across charts.
- zoom
booleandefault: true - Enables synchronization of zoom actions across charts.
- enabled
- zoom
AgZoomOptions - Configuration for the zoom options.
-
- anchorPointX
AgZoomAnchorPointdefault: end - The anchor point for the x-axis about which to zoom into when scrolling.
- anchorPointY
AgZoomAnchorPointdefault: middle - The anchor point for the y-axis about which to zoom into when scrolling.
- autoScaling
AgZoomAutoScaling - Zoom auto scaling options.
- axes
AgZoomAxesdefault: x - The axes on which to zoom when scrolling, one of `xy`, `x`, or `y`.
- axisDraggingMode
AgZoomAxisDraggingModedefault: zoom - Whether dragging an axis pans or zooms, if `enableAxisDragging` is enabled.
- buttons
AgZoomButtons - A set of buttons to perform common zoom actions.
- deceleration
AgZoomDecelerationdefault: short - Rate of deceleration of panning when dragging and releasing a zoomed chart.
- enabled
booleandefault: false - Set to `true` to enable the zoom module.
- enableAxisDragging
booleandefault: true - Set to `true` to enable dragging an axis to zoom series attached to that axis.
- enableAxisScrolling
booleandefault: true - Set to `true` to enable scrolling an axis to zoom series attached to that axis.
- enableDoubleClickToReset
booleandefault: true - Set to `true` to enable double-clicking to reset the chart to fully zoomed out.
- enablePanning
booleandefault: true - Set to `true` to enable panning while zoomed.
- enableScrolling
booleandefault: true - Set to `true` to enable zooming with the mouse wheel.
- enableSelecting
booleandefault: false - Set to `true` to enable selecting an area of the chart to zoom into.
- enableTwoFingerZoom
booleandefault: true - Set to `true` to enable zoom-panning with two touch points.
- keepAspectRatio
booleandefault: false - Set to `true` to keep the selection area matching the chart's aspect ratio.
- minVisibleItems
numberdefault: 2 - The minimum number of items to be shown, beyond which zooming is stopped. Set to `0` to allow unlimited zooming.
- panKey
AgZoomPanKeydefault: alt - The key that should be pressed to allow dragging to pan around while zoomed, one of `alt`, `ctrl`, `meta` or `shift`.
- scrollingMode
AgZoomScrollingModedefault: zoom - Whether scrolling the mouse wheel or track pad vertically zooms or pans.
- scrollingStep
Ratiodefault: 0.1 - The amount to zoom when scrolling with the mouse wheel, as a ratio of the full chart.
- onDataChange
AgZoomOnDataChange - Configuration for how the zoom-pan should respond to data changes
- anchorPointX
- 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.