BarLabel API

API reference docs for the React BarLabel 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:

Charts - Bars

Import

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

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

Props

Name	Type	Default	Description
dataIndex*	number	-	The index of the data point in the series.
height*	number	-	Height of the bar this label belongs to.
isFaded*	bool	-	If `true`, the element is faded.
isHighlighted*	bool	-	If `true`, the element is highlighted.
layout*	'horizontal' \| 'vertical'	-	The orientation of the bar.
seriesId*	string	-	The id of the series the element belongs to.
skipAnimation*	bool	-	If `true`, animations are skipped.
width*	number	-	Width of the bar this label belongs to.
x*	number	-	Position in the x-axis of the bar this label belongs to.
xOrigin*	number	-	The x-coordinate of the stack this bar label belongs to.
y*	number	-	Position in the y-axis of the bar this label belongs to.
yOrigin*	number	-	The y-coordinate of the stack this bar label belongs to.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
hidden	bool	-	If true, the bar label is hidden.
placement	'center' \| 'outside'	'center'	The placement of the bar label. It controls whether the label is rendered in the center or outside the bar.

The component cannot hold a ref.

Slots

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

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiBarChart-element	element	Styles applied to an individual bar element.
.MuiBarChart-label	label	Styles applied to an individual bar label.
.MuiBarChart-labelAnimate	labelAnimate	Styles applied to a bar label when it is animated.
.MuiBarChart-root	root	Styles applied to the bar plot element.
.MuiBarChart-series	series	Styles applied to the group surrounding a series' bar elements.
.MuiBarChart-seriesLabels	seriesLabels	Styles applied to the group surrounding a series' labels.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

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.