PieArcLabel API

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

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

Props

Name	Type	Description
arcLabelRadius*	number	The radius between circle center and the arc label in px.
color*	string	The color of the element.
cornerRadius*	number	The radius applied to arc corners (similar to border radius).
endAngle*	number	The end angle (deg).
isFaded*	bool	If `true`, the element is faded.
isHighlighted*	bool	If `true`, the element is highlighted.
paddingAngle*	number	The padding angle (deg) between two arcs.
seriesId*	string	The id of the series the element belongs to.
skipAnimation*	bool	If `true`, animations are skipped.
startAngle*	number	The start angle (deg).
classes	object	Override or extend the styles applied to the component. See CSS classes API below for more details.
formattedArcLabel	string	The text of the arc label.
hidden	bool	If `true`, the element is hidden.

The component cannot hold a ref.

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
.MuiPieChart-animate	animate	Styles applied when animation is not skipped.
.MuiPieChart-arc	arc	Styles applied to an individual pie arc element.
.MuiPieChart-arcLabel	arcLabel	Styles applied to an individual pie arc label element.
.MuiPieChart-focusIndicator	focusIndicator	Styles applied to the focused pie arc element.
.MuiPieChart-root	root	Styles applied to the root element.
.MuiPieChart-series	series	Styles applied to the `g` element that contains all pie arcs of a series.
.MuiPieChart-seriesLabels	seriesLabels	Styles applied to the `g` element that contains all pie arc labels of a series.

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.