Skip to content

RadarDataProvider API

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

Demos

Import

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

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

Props

NameTypeDefaultDescription
radar*{ max?: number, metrics: Array<string>
| Array<{ max?: number, min?: number, name: string }>, startAngle?: number }
-

The configuration of the radar scales.

series*Array<object>-

The series to display in the bar chart. An array of RadarSeriesType objects.

colorsArray<string>
| func
rainbowSurgePalette

Color palette used to colorize multiple series.

heightnumber-

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

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

The highlighted item. Used when the highlight is controlled.

idstring-

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.

marginnumber
| { 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.

onHighlightChangefunc-

The callback fired when the highlighted item changes.

Signature:function(highlightedItem: HighlightItemData | null) => void
  • highlightedItem The newly highlighted item.
skipAnimationbool-

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

widthnumber-

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

The component cannot hold a ref.

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.