Skip to content

AxisConfig API

Extended documentation for the AxisConfig interface with detailed information on the module's properties and available APIs.

Demos

Import

import { AxisConfig } from '@mui/x-charts'

Properties

Id used to identify the axis.

Type:AxisId

Type:'band'

Optional

Type:OrdinalColorConfig | ContinuousColorConfig | PiecewiseColorConfig

Optional

The data used by 'band' and 'point' scales.

Type:V[]

Optional

The key used to retrieve data from the dataset prop.

Type:string

Optional

If true, hide this value in the tooltip

Type:boolean

Optional

The maximal value of the domain.
If not provided, it gets computed to display the entire chart data.

Type:number | Date

Optional

The minimal value of the domain.
If not provided, it gets computed to display the entire chart data.

Type:number | Date

Optional

If true, Reverse the axis scaleBand.

Type:boolean

Optional

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.

Type:'auto' | ((value: any, index: number) => boolean) | any[]

Default:'auto'

Optional

The placement of ticks label. Can be the middle of the band, or the tick position.
Only used if scale is 'band'.

Type:'middle' | 'tick'

Default:'middle'

Optional

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

Type:number

Optional

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

Type:number

Optional

The number of ticks. This number is not guaranteed.
Not supported by categorical axis (band, points).

Type:number

Optional

The placement of ticks in regard to the band interval.
Only used if scale is 'band'.

Type:'start' | 'end' | 'middle' | 'extremities'

Default:'extremities'

Optional

Formats the axis value.

Type:(value: V, context: AxisValueFormatterContext) => string