@progress/kendo-angular-charts
Version:
Kendo UI Charts for Angular - A comprehensive package for creating beautiful and interactive data visualization. Every chart type, stock charts, and sparklines are included.
40 lines (39 loc) • 1.69 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2024 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { geometry } from '@progress/kendo-drawing';
import { AxisRange } from './axis-range.interface';
/**
* An interface for the Chart axes API.
*/
export interface ChartAxis {
/**
* Returns the axis range.
*
* @returns {AxisRange} The axis range.
*/
range(): AxisRange;
/**
* Returns a slot based on the specified `from` and `to` values.
*
* @param from The slot start value.
* @param to The end slot value. If not specified, the `from` value is used.
* @param limit The parameters for the exported image.
* @returns {Promise<string>} Indicates whether the slot is limited to the current range. By default, the range is limited.
*/
slot(from: string | number | Date, to?: string | number | Date, limit?: boolean): geometry.Rect | geometry.Arc;
/**
* Returns the value that corresponds to the passed surface point.
*
* @param { Point } point The surface point of the Chart.
* @returns {string | number | Date} The value that corresponds to the point.
*/
value(point: geometry.Point): string | number | Date;
/**
* Returns the axis range which is determined by the minimum and maximum point values that are associated with the axis.
*
* @returns {AxisRange} The value range.
*/
valueRange(): AxisRange;
}