Skip to content

ChartsYAxis API

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

Demos

Import

import { ChartsYAxis } from '@mui/x-charts/ChartsYAxis';
// or
import { ChartsYAxis } from '@mui/x-charts';

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

Props

NameTypeDefaultDescription
axisIdnumber
| string		-

The id of the axis to render. If undefined, it will be the first defined axis.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

disableLineboolfalse

If true, the axis line is disabled.

disableTicksboolfalse

If true, the ticks are disabled.

fillstring'currentColor'

The fill color of the axis text.

labelstring-

The label of the axis.

labelFontSizenumber14

The font size of the axis label.

labelStyleobject-

The style applied to the axis label.

position'left'
| 'right'		-

Position of the axis.

slotPropsobject{}

The props used for each component slot.

slotsobject{}

Overridable component slots.

See Slots API below for more details.

strokestring'currentColor'

The stroke color of the axis line.

tickFontSizenumber12

The font size of the axis ticks text.

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'.

tickLabelStyleobject-

The style applied to ticks text.

tickMaxStepnumber-

Maximal step between two ticks. When using time data, the value is assumed to be in ms. Not supported by categorical axis (band, points).

tickMinStepnumber-

Minimal step between two ticks. When using time data, the value is assumed to be in ms. Not supported by categorical axis (band, points).

tickNumbernumber-

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'.

tickSizenumber6

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 nameRule nameDescription
.MuiChartsYAxis-bottombottomStyles applied to the bottom axis.
.MuiChartsYAxis-directionXdirectionXStyles applied to x-axes.
.MuiChartsYAxis-directionYdirectionYStyles applied to y-axes.
.MuiChartsYAxis-labellabelStyles applied to the group containing the axis label.
.MuiChartsYAxis-leftleftStyles applied to the left axis.
.MuiChartsYAxis-linelineStyles applied to the main line element.
.MuiChartsYAxis-rightrightStyles applied to the right axis.
.MuiChartsYAxis-rootrootStyles applied to the root element.
.MuiChartsYAxis-ticktickStyles applied to ticks.
.MuiChartsYAxis-tickContainertickContainerStyles applied to group including the tick and its label.
.MuiChartsYAxis-tickLabeltickLabelStyles applied to ticks label.
.MuiChartsYAxis-toptopStyles applied to the top axis.

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