ChartsRadiusAxis API

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

Import

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

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

Props

Name	Type	Default	Description
axisId	number \| string	-	The id of the axis to render. If undefined, it will be the first defined axis.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
className	string	-	A CSS class name applied to the root element.
disableLine	bool	false	If true, the axis line is disabled.
disableTickLabel	bool	false	If true, the tick labels are not rendered.
disableTicks	bool	false	If true, the ticks are disabled.
label	string	-	The label of the axis.
labelStyle	object	-	The style applied to the axis label.
maxRadius	number \| string	'100%'	The maximal radius. Can be a number (in pixels), a pixel string (for example `'80px'`), or a percentage string (for example `'80%'`) relative to the available radius (half the smallest side of the drawing area).
minRadius	number \| string	0	The minimal radius. Can be a number (in pixels), a pixel string (for example `'20px'`), or a percentage string (for example `'20%'`) relative to the available radius (half the smallest side of the drawing area).
position	'end' \| 'none' \| 'start' \| number	'start'	The position of the axis in polar coordinates. It can be 'start', 'end', or a specific angle in degrees.
tickInterval	'auto' \| array \| func	'auto'	Defines which ticks are displayed. Its value can be: - 'auto' In such case the ticks are computed based on axis scale and other parameters. - a filtering function of the form `(value, index) => boolean` which is available only if the axis has "point" scale. - an array containing the values where ticks should be displayed.
tickLabelInterval	'auto' \| func	'auto'	Defines which ticks get its label displayed. Its value can be: - 'auto' In such case, labels are displayed if they do not overlap with the previous one. - a filtering function of the form (value, index) => boolean. Warning: the index is tick index, not data ones.
tickLabelPlacement	'middle' \| 'tick'	'middle'	The placement of ticks label. Can be the middle of the band, or the tick position. Only used if scale is 'band'.
tickLabelPosition	'after' \| 'auto' \| 'before' \| 'center'	'auto'	Set the position of the tick labels relative to the axis line. The before/after is defined based on clockwise direction. Using `'auto'` sets it to `'before'` if position is `'start'` and `'after'` otherwise.
tickLabelStyle	object	-	The style applied to ticks text.
tickMaxStep	number	-	Maximal step between two ticks. When using time data, the value is assumed to be in ms. Not supported by categorical axis (band, points).
tickMinStep	number	-	Minimal step between two ticks. When using time data, the value is assumed to be in ms. Not supported by categorical axis (band, points).
tickNumber	number	-	The number of ticks. This number is not guaranteed. Not supported by categorical axis (band, points).
tickPlacement	'end' \| 'extremities' \| 'middle' \| 'start'	'extremities'	The placement of ticks in regard to the band interval. Only used if scale is 'band'.
tickPosition	'after' \| 'before'	position === 'start' ? 'before' : 'after'	Set the position of the tick relative to the axis line. The before/after is defined based on clockwise direction.
tickSize	number	6	The size of the ticks.
tickSpacing	number	0	The minimum space between ticks when using an ordinal scale. It defines the minimum distance in pixels between two ticks.

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
.MuiChartsRadialAxis-centered	centered	Styles applied to the tick label when centered.
.MuiChartsRadialAxis-line	line	Styles applied to the main line element.
.MuiChartsRadialAxis-radius	radius	Styles applied to the root element of radius axis.
.MuiChartsRadialAxis-root	root	Styles applied to the root element.
.MuiChartsRadialAxis-rotation	rotation	Styles applied to the root element of rotation axis.
.MuiChartsRadialAxis-tick	tick	Styles applied to ticks.
.MuiChartsRadialAxis-tickContainer	tickContainer	Styles applied to the group including the tick and its label.
.MuiChartsRadialAxis-tickLabel	tickLabel	Styles applied to the tick label.

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.