BarPlot API
API reference docs for the React BarPlot component. Learn about the props, CSS, and other APIs of this exported module.
Demos
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 of the native component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| borderRadius | number | - |
Defines the border radius of the bar element. |
| className | string | - |
A CSS class name applied to the root element. |
| onItemClick | func | - |
Callback fired when a bar item is clicked.
Signature:
function(event:
MouseEvent |
React.MouseEvent<SVGElement,
MouseEvent>,
barItemIdentifier:
BarItemIdentifier) =>
void
|
| renderer |
'svg-batch' | 'svg-single' |
'svg-single' |
The type of renderer to use
for the bar plot. -
|
| skipAnimation | bool | undefined |
If |
| slotProps | object | {} |
The props used for each component slot. |
| slots | object | {} |
Overridable component slots. See Slots API below for more details. |
| 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.