scichart
Version:
Fast WebGL JavaScript Charting Library and Framework
25 lines (24 loc) • 1.15 kB
TypeScript
import { EAxisType } from "../../../types/AxisType";
import { TSciChart } from "../../../types/TSciChart";
import { CategoryAxisBase, ICategoryAxisBaseOptions } from "./CategoryAxisBase";
/**
* Optional parameters used to configure a {@link CategoryAxis} at construct time
*/
export interface ICategoryAxisOptions extends ICategoryAxisBaseOptions {
labels?: string[];
}
/**
* @summary A 2D Chart Category Axis type
* @description A category axis uses the X-index not the X-value to measure data-points on the XAxis.
* For example this can be used in stock chart applications to ensure weekend or overnight gaps are collapsed
* and each data-point is spaced equidistantly
* @remarks
* Set a {@link CategoryAxis} on the {@link SciChartSurface.xAxes} property. This axis type is not valid for YAxis
*
* ---
* 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/axis-api/axis-types/category-axis/}
*/
export declare class CategoryAxis extends CategoryAxisBase {
readonly type = EAxisType.CategoryAxis;
constructor(webAssemblyContext: TSciChart, options?: ICategoryAxisOptions);
}