ChartsPolarGrid API

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

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

Renders a polar grid with radial lines and concentric circular rings.

Props

Name	Type	Default	Description
circular	bool	true	Displays concentric circular grid rings.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
divisions	number	5	The number of concentric circular divisions in the grid.
radial	bool	true	Displays radial lines from center to edge.

The component cannot hold a ref.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiChartsPolarGrid-circularLine	circularLine	Styles applied to circular grid rings.
.MuiChartsPolarGrid-line	line	Styles applied to every line element.
.MuiChartsPolarGrid-radialLine	radialLine	Styles applied to radial lines (from center to edge).
.MuiChartsPolarGrid-root	root	Styles applied to the root element.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

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.