Skip to contentSkip to content

PieChartPro API

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

Demos

Import

import { PieChartPro } from '@mui/x-charts-pro/PieChartPro';
// or
import { PieChartPro } from '@mui/x-charts-pro';

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

Props

Name Type Default Description
series* Array<object> -

The series to display in the pie chart. An array of PieSeries objects.

colors Array<string>
| func
rainbowSurgePalette

Color palette used to colorize multiple series.

dataset Array<object> -

An array of objects that can be used to populate series and axes data using their dataKey property.

desc string -

The description of the chart. Used to provide an accessible description for the chart.

disableKeyboardNavigation bool -

If true, disables keyboard navigation for the chart.

experimentalFeatures object -

Options to enable features planned for the next major.

height number -

The height of the chart in px. If not defined, it takes the height of the parent element.

hiddenItems Array<{ dataIndex?: number, seriesId: string, type: 'pie' }
| { dataIndex?: number, seriesId: string, type?: 'pie' }>
-

List of hidden series and/or items.
Different chart types use different keys.

hideLegend bool -

If true, the legend is not rendered.

highlightedItem { dataIndex?: number, seriesId: string }
| { dataIndex?: number, seriesId: string, type: 'pie' }
-

The highlighted item. Used when the highlight is controlled.

id string -

This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.

initialHiddenItems Array<{ dataIndex?: number, seriesId: string, type: 'pie' }
| { dataIndex?: number, seriesId: string, type?: 'pie' }>
-

List of initially hidden series and/or items. Used for uncontrolled state.
Different chart types use different keys.

loading bool false

If true, a loading overlay is displayed.

localeText object -

Localized text for chart components.

margin number
| { bottom?: number, left?: number, right?: number, top?: number }
-

The margin between the SVG and the drawing area. It's used for leaving some space for extra information such as the x- and y-axis or legend.
Accepts a number to be used on all sides or an object with the optional properties: top, bottom, left, and right.

onHiddenItemsChange func -

Callback fired when any hidden identifiers change.

Signature:function(hiddenItems: Array<VisibilityIdentifierWithType>) => void
  • hiddenItems The new list of hidden identifiers.
onHighlightChange func -

The callback fired when the highlighted item changes.

Signature:function(highlightedItem: HighlightItemIdentifierWithType<SeriesType> | null) => void
  • highlightedItem The newly highlighted item.
onItemClick func -

Callback fired when a pie arc is clicked.

onTooltipItemChange func -

The callback fired when the tooltip item changes.

Signature:function(tooltipItem: SeriesItemIdentifier<SeriesType> | null) => void
  • tooltipItem The newly highlighted item.
showToolbar bool false

If true, shows the default chart toolbar.

skipAnimation bool -

If true, animations are skipped. If unset or false, the animations respects the user's prefers-reduced-motion setting.

slotProps object {}

The props used for each component slot.

slots object {}

Overridable component slots.

See Slots API below for more details.

title string -

The title of the chart. Used to provide an accessible label for the chart.

tooltipItem { dataIndex: number, seriesId: string }
| { dataIndex: number, seriesId: string, type: 'pie' }
-

The tooltip item. Used when the tooltip is controlled.

width number -

The width of the chart in px. If not defined, it takes the width of the parent element.

The component cannot hold a ref.

Slots

Slot name Class name Default component Description
baseButton
baseDivider
baseIconButton
baseMenuItem
baseMenuList
basePopper
baseToggleButton Note: MUI's ToggleButton has an incompatible href prop, so it must be cast: ToggleButton as unknown as React.ComponentType<ChartBaseToggleButtonProps & BaseToggleButtonPropsOverrides>.
baseToggleButtonGroup
baseTooltip
exportIcon ChartsExportIcon Icon displayed on the toolbar's export button.
legend ChartsLegend Custom rendering of the legend.
loadingOverlay ChartsLoadingOverlay Overlay component rendered when the chart is in a loading state.
noDataOverlay ChartsNoDataOverlay Overlay component rendered when the chart has no data to display.
pieArc
pieArcLabel
toolbar ChartsToolbar Custom component for the toolbar.
tooltip ChartsTooltipRoot Custom component for the tooltip popper.
zoomInIcon ChartsZoomInIcon Icon displayed on the toolbar's zoom in button.
zoomOutIcon ChartsZoomOutIcon Icon displayed on the toolbar's zoom out button.

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.