BarPlot API

API reference docs for the React BarPlot 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 { BarPlot } from '@mui/x-charts/BarChart';
// or
import { BarPlot } from '@mui/x-charts';
// or
import { BarPlot } from '@mui/x-charts-pro';
// or
import { BarPlot } from '@mui/x-charts-premium';

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

Props

Name	Type	Default	Description
barLabel	'value' \| func	-	If provided, the function will be used to format the label of the bar. It can be set to 'value' to display the current value.
borderRadius	number	-	Defines the border radius of the bar element.
onItemClick	func	-	Callback fired when a bar item is clicked. Signature:`function(event: React.MouseEvent, barItemIdentifier: BarItemIdentifier) => void` `event` The event source of the callback. `barItemIdentifier` The bar item identifier.
skipAnimation	bool	undefined	If `true`, animations are skipped.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.

The component cannot hold a ref.

Slots

Slot name	Class name	Default component	Description
bar		`BarElementPath`	The component that renders the bar.
barLabel		`BarLabel`	The component that renders the bar label.

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.