跳到内容

AxisConfigAPI

AxisConfig 接口的扩展文档，其中包含有关模块属性和可用 API 的详细信息。

演示

导入

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

属性

用于标识轴的 ID。

类型：AxisId

类型：'band'

可选

类型：OrdinalColorConfig | ContinuousColorConfig | PiecewiseColorConfig

可选

'band' 和 'point' 比例尺使用的数据。

类型：V[]

可选

用于从 dataset 属性中检索 data 的键。

类型：string

可选

根据与其关联的系列最小值/最大值定义轴比例域。
- 'nice'：将域四舍五入为对人类友好的值。
- 'strict'：将域设置为提供的最小值/最大值。不添加额外的空间。
- 函数：接收计算出的极值作为参数，并应返回轴域。

类型：'nice' | 'strict' | ((min: number, max: number) => { min: number; max: number })

可选

如果为 true，则在工具提示中隐藏此值

类型：boolean

可选

域的最大值。
如果未提供，则会计算得出以显示整个图表数据。

类型：number | Date

可选

域的最小值。
如果未提供，则会计算得出以显示整个图表数据。

类型：number | Date

可选

如果为 true，则反转轴比例带。

类型：boolean

可选

定义要显示的刻度。
其值可以是
- 'auto' 在这种情况下，刻度是根据轴比例和其他参数计算得出的。
- 形式为 (value, index) => boolean 的过滤函数，仅当轴具有“point”比例时才可用。
- 包含应显示刻度的值的数组。

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

默认值：'auto'

可选

刻度标签的位置。可以是条带的中间，也可以是刻度位置。
仅当比例为 'band' 时使用。

类型：'middle' | 'tick'

默认值：'middle'

可选

两个刻度之间的最大步长。
当使用时间数据时，该值被假定为毫秒。
分类轴（band、points）不支持。

类型：number

可选

两个刻度之间的最小步长。
当使用时间数据时，该值被假定为毫秒。
分类轴（band、points）不支持。

类型：number

可选

刻度的数量。此数量不能保证。
分类轴（band、points）不支持。

类型：number

可选

刻度相对于条带间隔的位置。
仅当比例为 'band' 时使用。

类型：'start' | 'end' | 'middle' | 'extremities'

默认值：'extremities'

可选

格式化轴值。

类型：(value: V, context: AxisValueFormatterContext) => string