UNPKG

@mui/x-charts

Version:

The community edition of MUI X Charts components.

mui.com/x/react-charts/

mui/mui-x

22 lines • 1.4 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import { AxisId, AxisScaleComputedConfig, ScaleName } from "../models/axis.js"; /** * Get the X axis color scale. * * @param {AxisId | undefined} axisId - If provided returns color scale for axisId, else returns the values for the default axis. * @returns {AxisScaleComputedConfig[S]['colorScale'] | undefined} The color scale for the specified X axis, or undefined if not found. */ export declare function useXColorScale<S extends ScaleName>(axisId?: AxisId): AxisScaleComputedConfig[S]['colorScale'] | undefined; /** * Get the Y axis color scale. * * @param {AxisId | undefined} axisId - If provided returns color scale for axisId, else returns the values for the default axis. * @returns {AxisScaleComputedConfig[S]['colorScale'] | undefined} The color scale for the specified Y axis, or undefined if not found. */ export declare function useYColorScale<S extends ScaleName>(axisId?: AxisId): AxisScaleComputedConfig[S]['colorScale'] | undefined; /** * Get the Z axis color scale. * * @param {AxisId | undefined} axisId - If provided returns color scale for axisId, else returns the values for the default axis. * @returns {AxisScaleComputedConfig[S]['colorScale'] | undefined} The color scale for the specified Z axis, or undefined if not found. */ export declare function useZColorScale<S extends ScaleName>(axisId?: AxisId): AxisScaleComputedConfig[S]['colorScale'] | undefined;