Skip to content

PieArcLabelPlot API

API reference docs for the React PieArcLabelPlot component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import { PieArcLabelPlot } from '@mui/x-charts/PieChart';
// or
import { PieArcLabelPlot } from '@mui/x-charts';
// or
import { PieArcLabelPlot } from '@mui/x-charts-pro';

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

Props

NameTypeDefaultDescription
outerRadius*number-

The radius between circle center and the end of the arc.

arcLabel'formattedValue'
| 'label'
| 'value'
| func
-

The label displayed into the arc.

arcLabelMinAnglenumber0

The minimal angle required to display the arc label.

arcLabelRadiusnumber(innerRadius - outerRadius) / 2

The radius between circle center and the arc label in px.

cornerRadiusnumber0

The radius applied to arc corners (similar to border radius).

faded{ additionalRadius?: number, arcLabelRadius?: number, color?: string, cornerRadius?: number, innerRadius?: number, outerRadius?: number, paddingAngle?: number }{ additionalRadius: -5 }

Override the arc attributes when it is faded.

highlighted{ additionalRadius?: number, arcLabelRadius?: number, color?: string, cornerRadius?: number, innerRadius?: number, outerRadius?: number, paddingAngle?: number }-

Override the arc attributes when it is highlighted.

innerRadiusnumber0

The radius between circle center and the beginning of the arc.

paddingAnglenumber0

The padding angle (deg) between two arcs.

skipAnimationboolfalse

If true, animations are skipped.

slotPropsobject{}

The props used for each component slot.

slotsobject{}

Overridable component slots.

See Slots API below for more details.

The component cannot hold a ref.

Slots

Slot nameClass nameDefault componentDescription
pieArcLabel