PieArcPlot API

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

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

onItemClick

Callback fired when a pie item is clicked.

Type:func

Signature:

function(event: React.MouseEvent, pieItemIdentifier: PieItemIdentifier, item: DefaultizedPieValueType) => void

event The event source of the callback.
pieItemIdentifier The pie item identifier.
item The pie item.

paddingAngle

The padding angle (deg) between two arcs.

Type:number

Default:0

skipAnimation

If true, animations are skipped.

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

pieArc