PieArcLabelPlot API

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

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

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

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

Props

outerRadiusRequired

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

Type:number

arcLabel

The label displayed into the arc.

Type:'formattedValue' | 'label' | 'value' | func

arcLabelMinAngle

The minimal angle required to display the arc label.

Type:number

Default:0

arcLabelRadius

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

Type:number

Default:(innerRadius - outerRadius) / 2

cornerRadius

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

Type:number

Default:0

faded

Override the arc attibutes when it is faded.

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

Default:{ additionalRadius: -5 }

highlighted

Override the arc attibutes when it is highlighted.

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

innerRadius

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

Type:number

Default:0

paddingAngle

The padding angle (deg) between two arcs.

Type:number

Default:0

skipAnimation

If true, animations are skiped.

Type:bool

Default:false

slotProps

The props used for each component slot.

Type:object

Default:{}

slots

Overridable component slots.

See Slots API below for more details.

Type:object

Default:{}

The component cannot hold a ref.

Slots

pieArcLabel