Skip to content

PieArcPlot API

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

Component demos

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

Default:R_max The maximal radius that fit into the drawing area.

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, color?: string, cornerRadius?: number, innerRadius?: number, outerRadius?: number, paddingAngle?: number }

highlighted

Override the arc attibutes when it is highlighted.

Type:{ additionalRadius?: 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

onClick

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 skiped.

Type:bool

slotProps

The props used for each component slot.

Type:object

Default:{}

slots

Overridable component slots.

Type:object

Default:{}

The component cannot hold a ref.

Slots

pieArc