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/BarChart';
// or
import { BarLabel } from '@mui/x-charts-pro';
// or
import { BarLabel } from '@mui/x-charts-premium/BarChart';
// 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
color*	string	-
dataIndex*	number	-
height*	number	-	Height of the bar this label belongs to.
isFaded*	bool	-
isHighlighted*	bool	-
layout*	'horizontal' \| 'vertical'	-
seriesId*	string	-
skipAnimation*	bool	-
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	Partial	-	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.

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.