Skip to content

PieSeriesType API

Extended documentation for the PieSeriesType interface with detailed information on the module's properties and available APIs.

Demos

Import

import { PieSeriesType } from '@mui/x-charts'

Properties

Type:TData[]


Type:'pie'


Optional

The label displayed into the arc.

Type:'formattedValue' | 'label' | 'value' | ((item: Omit<DefaultizedPieValueType, 'label'> & { label?: string }) => string)


Optional

The minimal angle required to display the arc label.

Type:number

Default:0


Optional

The radius between circle center and the arc label.
Can be a number (in px) or a string with a percentage such as '50%'.
The '100%' is the maximal radius that fit into the drawing area.

Type:number | string

Default:(innerRadius - outerRadius) / 2


Optional

Type:string


Optional

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

Type:number

Default:0


Optional

The x coordinate of the pie center.
Can be a number (in px) or a string with a percentage such as '50%'.
The '100%' is the width the drawing area.

Type:number | string

Default:'50%'


Optional

The y coordinate of the pie center.
Can be a number (in px) or a string with a percentage such as '50%'.
The '100%' is the height the drawing area.

Type:number | string

Default:'50%'


Optional

The end angle (deg) of the last item.

Type:number

Default:360


Optional

Override the arc attributes when it is faded.

Type:{
/**
* Value added to the default `outerRadius`.
* Can be negative. It is ignored if you provide a `faded.outerRadius` value.
*/
additionalRadius?: number
innerRadius?: number
outerRadius?: number
cornerRadius?: number
paddingAngle?: number
arcLabelRadius?: number
color?: string
}


Optional

Override the arc attributes when it is highlighted.

Type:{
/**
* Value added to the default `outerRadius`.
* Can be negative. It is ignored if you provide a `highlighted.outerRadius` value.
*/
additionalRadius?: number
innerRadius?: number
outerRadius?: number
cornerRadius?: number
paddingAngle?: number
arcLabelRadius?: number
color?: string
}


Optional

The scope to apply when the series is highlighted.

Type:Partial<HighlightScope>


Optional

Type:SeriesId


Optional

The radius between circle center and the beginning of the arc.
Can be a number (in px) or a string with a percentage such as '50%'.
The '100%' is the maximal radius that fit into the drawing area.

Type:number | string

Default:0


Optional

The radius between circle center and the end of the arc.
Can be a number (in px) or a string with a percentage such as '50%'.
The '100%' is the maximal radius that fit into the drawing area.

Type:number | string

Default:'100%'


Optional

The padding angle (deg) between two arcs.

Type:number

Default:0


Optional

The sorting strategy used to order pie slices.
Can be 'none', 'asc', 'desc', or a sorting function.

Type:ChartsPieSorting

Default:'none'


Optional

The start angle (deg) of the first item.

Type:number

Default:0


Optional

Formatter used to render values in tooltip or other data display.

Type:SeriesValueFormatter<TValue>