ChartsXAxis API

API reference docs for the React ChartsXAxis 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 - Axis

Import

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

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

Props

Props of the native component are also available.

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.
disableLine	bool	false	If true, the axis line is disabled.
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.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.
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.
tickLabelMinGap	number	4	The minimum gap in pixels between two tick labels. If two tick labels are closer than this minimum gap, one of them will be hidden.
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'.
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'.
tickSize	number	6	The size of the ticks.

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.