51 lines
2.5 KiB
TypeScript
51 lines
2.5 KiB
TypeScript
import { AxisId, ChartsRadiusAxisProps, ChartsRotationAxisProps, PolarAxisDefaultized, ScaleName } from "../models/axis.js";
|
|
/**
|
|
* Get all the x-axes.
|
|
*
|
|
* - `xAxis` is an object with the shape `{ [axisId]: axis }`.
|
|
* - `xAxisIds` is an array of axis IDs.
|
|
*
|
|
* If access to a specific X axis is needed, use the `useXAxis` hook instead.
|
|
*
|
|
* @returns `{ xAxis, xAxisIds }` - The x-axes and their IDs.
|
|
*/
|
|
export declare function useXAxes(): {
|
|
xAxis: import("../internals/index.js").ComputedAxisConfig<import("../index.js").ChartsXAxisProps>;
|
|
xAxisIds: AxisId[];
|
|
};
|
|
/**
|
|
* Get all the y-axes.
|
|
*
|
|
* - `yAxis` is an object with the shape `{ [axisId]: axis }`.
|
|
* - `yAxisIds` is an array of axis IDs.
|
|
*
|
|
* If access to a specific Y axis is needed, use the `useYAxis` hook instead.
|
|
*
|
|
* @returns `{ yAxis, yAxisIds }` - The y-axes and their IDs.
|
|
*/
|
|
export declare function useYAxes(): {
|
|
yAxis: import("../internals/index.js").ComputedAxisConfig<import("../index.js").ChartsYAxisProps>;
|
|
yAxisIds: AxisId[];
|
|
};
|
|
/**
|
|
* Get the X axis.
|
|
* @param {AxisId | undefined} axisId - If provided returns the x axis with axisId, else returns the values for the default x axis.
|
|
* @returns The X axis.
|
|
*/
|
|
export declare function useXAxis(axisId?: AxisId): import("../internals/index.js").ComputedAxis<keyof import("../internals/index.js").AxisScaleConfig, any, import("../index.js").ChartsXAxisProps>;
|
|
/**
|
|
* Get the Y axis.
|
|
* @param {AxisId | undefined} axisId - If provided returns the y axis with axisId, else returns the values for the default y axis.
|
|
* @returns The Y axis.
|
|
*/
|
|
export declare function useYAxis(axisId?: AxisId): import("../internals/index.js").ComputedAxis<keyof import("../internals/index.js").AxisScaleConfig, any, import("../index.js").ChartsYAxisProps>;
|
|
export declare function useRotationAxes(): {
|
|
rotationAxis: import("../internals/plugins/featurePlugins/useChartPolarAxis/computeAxisValue.js").DefaultizedAxisConfig<ChartsRotationAxisProps>;
|
|
rotationAxisIds: string[];
|
|
};
|
|
export declare function useRadiusAxes(): {
|
|
radiusAxis: import("../internals/plugins/featurePlugins/useChartPolarAxis/computeAxisValue.js").DefaultizedAxisConfig<ChartsRadiusAxisProps>;
|
|
radiusAxisIds: string[];
|
|
};
|
|
export declare function useRotationAxis(identifier?: number | string): PolarAxisDefaultized<ScaleName, any, ChartsRotationAxisProps> | undefined;
|
|
export declare function useRadiusAxis(identifier?: number | string): PolarAxisDefaultized<ScaleName, any, ChartsRadiusAxisProps> | undefined; |