PieArcPlot API

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

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

Props

Name	Type	Default	Description
data*	Array<{ color: string, endAngle: number, formattedValue: string, hidden: bool, id?: number \| string, index: number, label?: func \| string, labelMarkType?: 'circle' \| 'line' \| 'line+mark' \| 'square' \| func \| { contextType?: func, defaultProps?: Partial, displayName?: string, getDerivedStateFromError?: func, getDerivedStateFromProps?: func, propTypes?: any }, padAngle: number, startAngle: number, value: number }>	-
outerRadius*	number	-	The radius between circle center and the end of the arc.
seriesId*	string	-	The id of this series.
arcLabelRadius	number	(innerRadius - outerRadius) / 2	The radius between circle center and the arc label in px.
cornerRadius	number	0	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.
innerRadius	number	0	The radius between circle center and the beginning of the arc.
onItemClick	func	-	Callback fired when a pie item is clicked. Signature:`function(event: React.MouseEvent<SVGPathElement, MouseEvent>, pieItemIdentifier: PieItemIdentifier, item: DefaultizedPieValueType) => void` `event` The event source of the callback. `pieItemIdentifier` The pie item identifier. `item` The pie item.
paddingAngle	number	0	The padding angle (deg) between two arcs.
skipAnimation	bool	false	If `true`, animations are skipped.
slotProps	PieArcPlotSlotProps	{}	The props used for each component slot.
slots	PieArcPlotSlots	{}	Overridable component slots. See Slots API below for more details.

The component cannot hold a ref.

Slots

Slot name	Class name	Default component	Description
pieArc

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.