ChartsPolarDataProvider API

API reference docs for the React ChartsPolarDataProvider 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:

Charts - Radial Lines

Import

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

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

Orchestrates the data providers for polar chart components and hooks.

Similar to ChartsDataProvider, but uses the polar axis plugin instead of the cartesian one, and only supports the line series config.

Props

Name	Type	Default	Description
colors	Array<string> \| func	rainbowSurgePalette	Color palette used to colorize multiple series.
height	number	-	The height of the chart in px. If not defined, it takes the height of the parent element.
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.
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`.
series	Array<object>	-	The array of series to display. Each type of series has its own specificity. Please refer to the appropriate docs page to learn more about it.
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 for the slots.
slots	object	-	Slots to customize charts' components. See Slots API below for more details.
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
baseIconButton

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.