ChartsContainer API

API reference docs for the React ChartsContainer component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import { ChartsContainer } from '@mui/x-charts/ChartsContainer';
// or
import { ChartsContainer } from '@mui/x-charts';
// or
import { ChartsContainer } from '@mui/x-charts-pro/ChartsContainer';
// or
import { ChartsContainer } from '@mui/x-charts-pro';
// or
import { ChartsContainer } from '@mui/x-charts-premium/ChartsContainer';
// or
import { ChartsContainer } from '@mui/x-charts-premium';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Name	Type	Default	Description
axesGap	number	0	A gap added between axes when multiple axes are rendered on the same side of the chart.
brushConfig	{ enabled?: bool, preventHighlight?: bool, preventTooltip?: bool }	-	Configuration for the brush interaction.
colors	Array<string> \| func	rainbowSurgePalette	Color palette used to colorize multiple series.
dataset	Array<DatasetElementType>	-	An array of objects that can be used to populate series and axes data using their `dataKey` property.
desc	string	-	The description of the chart. Used to provide an accessible description for the chart.
disableAxisListener	bool	false	If `true`, the charts will not listen to the mouse move event. It might break interactive features, but will improve performance.
disableHitArea	bool	-	If true, the hit area interaction is disabled and falls back to hover events.
disableKeyboardNavigation	bool	-	If `true`, disables keyboard navigation for the chart.
experimentalFeatures	any	-	Options to enable features planned for the next major.
height	number	-	The height of the chart in px. If not defined, it takes the height of the parent element.
hiddenItems	Array<any \| { seriesId: any, type?: any }>	-	List of hidden series and/or items. Different chart types use different keys.
highlightedAxis	Array<{ axisId: number \| string, dataIndex: number }>	-	The controlled axis highlight. Identified by the axis id, and data index.
highlightedItem	any \| any	-	The highlighted item. Used when the highlight is controlled.
hitAreaRadius	'item' \| number	-	Defines the maximum distance between a scatter point and the pointer that triggers the interaction. If set to `'item'`, the radius is the `markerSize`. If `undefined`, the radius is assumed to be infinite.
id	string	-	This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.
initialHiddenItems	Array<any \| { seriesId: any, type?: any }>	-	List of initially hidden series and/or items. Used for uncontrolled state. Different chart types use different keys.
localeText	Partial	-	Localized text for chart components.
margin	number \| { bottom?: number, left?: number, right?: number, top?: number }	-	The margin between the SVG and the drawing area. It's used for leaving some space for extra information such as the x- and y-axis or legend. Accepts a `number` to be used on all sides or an object with the optional properties: `top`, `bottom`, `left`, and `right`.
onAxisClick	func	-	The function called for onClick events. The second argument contains information about all line/bar elements at the current mouse position. Signature:`function(event: MouseEvent, data: null \| ChartsAxisData) => void` `event` The mouse event recorded on the element. `data` The data about the clicked axis and items associated with it.
onHiddenItemsChange	func	-	Callback fired when any hidden identifiers change. Signature:`function(hiddenItems: Array<VisibilityIdentifierWithType>) => void` `hiddenItems` The new list of hidden identifiers.
onHighlightChange	func	-	The callback fired when the highlighted item changes. Signature:`function(highlightedItem: HighlightItemIdentifierWithType<SeriesType> \| null) => void` `highlightedItem` The newly highlighted item.
onHighlightedAxisChange	func	-	The function called when the pointer position corresponds to a new axis data item. This update can either be caused by a pointer movement, or an axis update. In case of multiple axes, the function is called if at least one axis is updated. The argument contains the identifier for all axes with a `data` property. Signature:`function(axisItems: Array<AxisItemIdentifier>) => void` `axisItems` The array of axes item identifiers.
onItemClick	func	-	Callback fired when clicking close to an item. This is only available for scatter plot for now. Signature:`function(event: MouseEvent, scatterItemIdentifier: ScatterItemIdentifier) => void` `event` Mouse event caught at the svg level `scatterItemIdentifier` Identify which item got clicked
onTooltipAxisChange	func	-	The function called when the pointer position corresponds to a new axis data item. This update can either be caused by a pointer movement, or an axis update. In case of multiple axes, the function is called if at least one axis is updated. The argument contains the identifier for all axes with a `data` property. Signature:`function(axisItems: Array<AxisItemIdentifier>) => void` `axisItems` The array of axes item identifiers.
onTooltipItemChange	func	-	The callback fired when the tooltip item changes. Signature:`function(tooltipItem: SeriesItemIdentifier<SeriesType> \| null) => void` `tooltipItem` The newly highlighted item.
plugins	{}	-	Array of plugins used to add features to the chart.
radiusAxis	Array<AxisConfig<'linear', any, ChartsRadiusAxisProps>>	-	The configuration of the radial-axes. If not provided, a default axis config is used. An array of AxisConfig objects.
rotationAxis	Array<AxisConfig<'band', any, ChartsRotationAxisProps> \| AxisConfig<'linear', any, ChartsRotationAxisProps> \| AxisConfig<'log', any, ChartsRotationAxisProps> \| AxisConfig<'point', any, ChartsRotationAxisProps> \| AxisConfig<'pow', any, ChartsRotationAxisProps> \| AxisConfig<'sqrt', any, ChartsRotationAxisProps> \| AxisConfig<'symlog', any, ChartsRotationAxisProps> \| AxisConfig<'time', any, ChartsRotationAxisProps> \| AxisConfig<'utc', any, ChartsRotationAxisProps>>	-	The configuration of the rotation-axes. If not provided, a default axis config is used. An array of AxisConfig objects.
series	Array<BarSeriesType \| LineSeriesType \| ScatterSeriesType \| PieSeriesType> \| RadarSeriesType \| HeatmapSeriesType \| FunnelSeriesType \| SankeySeriesType \| RangeBarSeriesType \| OHLCSeriesType>	-	The array of series to display. Each type of series has its own specificity. Please refer to the appropriate docs page to learn more about it.
seriesConfig	ChartSeriesConfig & ChartSeriesConfig	-	The configuration for the series types. This is used to define how each series type should be processed, colored, and displayed.
skipAnimation	bool	-	If `true`, animations are skipped. If unset or `false`, the animations respects the user's `prefers-reduced-motion` setting.
slotProps	Partial	-	The props for the slots.
slots	Partial	-	Slots to customize charts' components. See Slots API below for more details.
title	string	-	The title of the chart. Used to provide an accessible label for the chart.
tooltipAxis	Array<{ axisId: number \| string, dataIndex: number }>	-	The controlled axis tooltip. Identified by the axis id, and data index.
tooltipItem	any \| any	-	The tooltip item. Used when the tooltip is controlled.
width	number	-	The width of the chart in px. If not defined, it takes the width of the parent element.
xAxis	Array<MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'>>	-	The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects.
yAxis	Array<MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'> \| MakeOptional, 'id'>>	-	The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects.
zAxis	Array<{ colorMap?: { color: any \| any, max?: any \| any, min?: any \| any, type: 'continuous' } \| { colors: Array<any>, thresholds: Array<any>, type: 'piecewise' } \| { colors: Array<any>, type: 'ordinal', unknownColor?: string, values?: Array<any> }, data?: Array<any>, dataKey?: string, id?: string, max?: number, min?: number, valueGetter?: func }>	-	The configuration of the z-axes.

The component cannot hold a ref.

Slots

Slot name	Class name	Default component	Description
baseButton
baseIconButton

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.