Skip to contentSkip to content

BarChartPro API

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

Demos

Import

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

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

Props

Props of the native component are also available.

Name Type Default Description
series* Array<object> -

The series to display in the bar chart. An array of BarSeries objects.

axesGap number 0

A gap added between axes when multiple axes are rendered on the same side of the chart.

axisHighlight { x?: 'band'
| 'line'
| 'none', y?: 'band'
| 'line'
| 'none' }
-

The configuration of axes highlight. Default is set to 'band' in the bar direction. Depends on layout prop.

See highlighting docs for more details.

borderRadius number -

Defines the border radius of the bar element.

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<object> -

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.

disableKeyboardNavigation bool -

If true, disables keyboard navigation for the chart.

experimentalFeatures object -

Options to enable features planned for the next major.

grid { horizontal?: bool, vertical?: bool } -

Option to display a cartesian grid in the background.

height number -

The height of the chart in px. If not defined, it takes the height of the parent element.

hiddenItems Array<{ dataIndex?: number, seriesId: string, type: 'bar' }
| { dataIndex?: number, seriesId: string, type?: 'bar' }>
-

List of hidden series and/or items.
Different chart types use different keys.

hideLegend bool -

If true, the legend is not rendered.

highlightedAxis Array<{ axisId: number
| string, dataIndex: number }>
-

The controlled axis highlight. Identified by the axis id, and data index.

highlightedItem { dataIndex?: number, seriesId: string }
| { dataIndex?: number, seriesId: string, type: 'bar' }
-

The highlighted item. Used when the highlight is controlled.

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<{ dataIndex?: number, seriesId: string, type: 'bar' }
| { dataIndex?: number, seriesId: string, type?: 'bar' }>
-

List of initially hidden series and/or items. Used for uncontrolled state.
Different chart types use different keys.

initialZoom Array<{ axisId: number
| string, end: number, start: number }
| { axisId: number
| string, value?: Array<Date>
| Array<string>
| func
| { step?: number, unit: 'day'
| 'hour'
| 'microsecond'
| 'millisecond'
| 'minute'
| 'month'
| 'second'
| 'week'
| 'year' } }>
-

The list of zoom data related to each axis. Used to initialize the zoom in a specific configuration without controlling it.
Each entry is either explicit zoom percentages ({ axisId, start, end }) or a range value ({ axisId, value }) resolved against the axis domain.

layout 'horizontal'
| 'vertical'
'vertical'

The direction of the bar elements.

loading bool false

If true, a loading overlay is displayed.

localeText object -

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 <svg/> 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 a bar item is clicked.

Signature:function(event: MouseEvent, barItemIdentifier: BarItemIdentifier) => void
  • event The event source of the callback.
  • barItemIdentifier The bar item identifier.
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.
onZoomChange func -

Callback fired when the zoom has changed.

Signature:function(zoomData: Array<ZoomData>) => void
  • zoomData Updated zoom data.
renderer 'svg-batch'
| 'svg-single'
'svg-single'

The type of renderer to use for the bar plot. - svg-single: Renders every bar in a <rect /> element. - svg-batch: Batch renders bars in <path /> elements for better performance with large datasets, at the cost of some limitations. Read more: https://mui.com/x/react-charts/bars/#performance

sampling 'minmax'
| 'none'
'none'

Sampling method used to render large datasets when zoomed out. - 'none': render every bar (no sampling). - 'minmax': keep the min and max per bucket and draw one merged bar.

showToolbar bool false

If true, shows the default chart toolbar.

skipAnimation bool -

If true, animations are skipped. If unset or false, the animations respects the user's prefers-reduced-motion setting.

slotProps object {}

The props used for each component slot.

slots object {}

Overridable component slots.

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 { dataIndex: number, seriesId: string }
| { dataIndex: number, seriesId: string, type: 'bar' }
-

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<object> -

The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects.

yAxis Array<object> -

The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects.

zAxis Array<{ colorMap?: { color: Array<string>
| func, max?: Date
| number, min?: Date
| number, type: 'continuous', unknownColor?: string }
| { colors: Array<string>, thresholds: Array<Date
| number>, type: 'piecewise', unknownColor?: string }
| { colors: Array<string>, type: 'ordinal', unknownColor?: string, values?: Array<Date
| number
| string> }, data?: array, dataKey?: string, id?: string, max?: number, min?: number, sizeMap?: { interpolator?: 'linear'
| 'log'
| 'sqrt', max?: Date
| number, min?: Date
| number, size: Array<number>, type: 'continuous' }
| { max?: Date
| number, min?: Date
| number, size: func, type: 'continuous' }
| { sizes: Array<number>, thresholds: Array<Date
| number>, type: 'piecewise' }
| { sizes: Array<number>, type: 'ordinal', unknownSize?: number, values?: Array<Date
| number
| string> }, valueGetter?: func }>
-

The configuration of the z-axes.

zoomData Array<{ axisId: number
| string, end: number, start: number }>
-

The list of zoom data related to each axis.

zoomInteractionConfig { pan?: Array<'drag'
| 'pressAndDrag'
| 'wheel'
| { allowedDirection?: 'x'
| 'xy'
| 'y', pointerMode?: any, requiredKeys?: Array<string>, type: 'wheel' }
| { pointerMode?: 'mouse'
| 'touch', requiredKeys?: Array<string>, type: 'drag' }
| { pointerMode?: 'mouse'
| 'touch', requiredKeys?: Array<string>, type: 'pressAndDrag' }>, zoom?: Array<'brush'
| 'doubleTapReset'
| 'pinch'
| 'tapAndDrag'
| 'wheel'
| { pointerMode?: 'mouse'
| 'touch', requiredKeys?: Array<string>, type: 'brush' }
| { pointerMode?: 'mouse'
| 'touch', requiredKeys?: Array<string>, type: 'doubleTapReset' }
| { pointerMode?: 'mouse'
| 'touch', requiredKeys?: Array<string>, type: 'tapAndDrag' }
| { pointerMode?: any, requiredKeys?: array, type: 'pinch' }
| { pointerMode?: any, requiredKeys?: Array<string>, type: 'wheel' }> }
-

Configuration for zoom interactions.

The component cannot hold a ref.

Slots

Slot name Class name Default component Description
axisLabel ChartsText Custom component for axis label.
axisLine 'line' Custom component for the axis main line.
axisTick 'line' Custom component for the axis tick.
axisTickLabel ChartsText Custom component for tick label.
bar BarElementPath The component that renders the bar.
barLabel BarLabel The component that renders the bar label.
baseButton
baseDivider
baseIconButton
baseMenuItem
baseMenuList
basePopper
baseToggleButton Note: MUI's ToggleButton has an incompatible href prop, so it must be cast: ToggleButton as unknown as React.ComponentType<ChartBaseToggleButtonProps & BaseToggleButtonPropsOverrides>.
baseToggleButtonGroup
baseTooltip
exportIcon ChartsExportIcon Icon displayed on the toolbar's export button.
legend ChartsLegend Custom rendering of the legend.
loadingOverlay ChartsLoadingOverlay Overlay component rendered when the chart is in a loading state.
noDataOverlay ChartsNoDataOverlay Overlay component rendered when the chart has no data to display.
toolbar ChartsToolbar Custom component for the toolbar.
tooltip ChartsTooltipRoot Custom component for the tooltip popper.
xAxis ChartsXAxis Custom component for the x-axis.
yAxis ChartsYAxis Custom component for the y-axis.
zoomInIcon ChartsZoomInIcon Icon displayed on the toolbar's zoom in button.
zoomOutIcon ChartsZoomOutIcon Icon displayed on the toolbar's zoom out button.

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.