ChartsYAxis API

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

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.
disableLine	bool	false	If true, the axis line is disabled.
disableTicks	bool	false	If true, the ticks are disabled.
fill	string	'currentColor'	The fill color of the axis text.
label	string	-	The label of the axis.
labelFontSize	number	14	The font size of the axis label. Deprecated－Consider using `labelStyle.fontSize` instead.
labelStyle	object	-	The style applied to the axis label.
position	'left' \| 'right'	-	Position of the axis.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.
stroke	string	'currentColor'	The stroke color of the axis line.
tickFontSize	number	12	The font size of the axis ticks text. Deprecated－Consider using `tickLabelStyle.fontSize` instead.
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'.
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.

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
.MuiChartsYAxis-bottom	bottom	Styles applied to the bottom axis.
.MuiChartsYAxis-directionX	directionX	Styles applied to x-axes.
.MuiChartsYAxis-directionY	directionY	Styles applied to y-axes.
.MuiChartsYAxis-label	label	Styles applied to the group containing the axis label.
.MuiChartsYAxis-left	left	Styles applied to the left axis.
.MuiChartsYAxis-line	line	Styles applied to the main line element.
.MuiChartsYAxis-right	right	Styles applied to the right axis.
.MuiChartsYAxis-root	root	Styles applied to the root element.
.MuiChartsYAxis-tick	tick	Styles applied to ticks.
.MuiChartsYAxis-tickContainer	tickContainer	Styles applied to group including the tick and its label.
.MuiChartsYAxis-tickLabel	tickLabel	Styles applied to ticks label.
.MuiChartsYAxis-top	top	Styles applied to the top axis.

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.