scichart
Version:
Fast WebGL JavaScript Charting Library and Framework
38 lines (37 loc) • 1.81 kB
TypeScript
import { EAxisType } from "../../../types/AxisType";
import { TSciChart } from "../../../types/TSciChart";
import { CoordinateCalculatorBase } from "../../Numerics/CoordinateCalculators/CoordinateCalculatorBase";
import { AxisBase2D, IAxisBase2dOptions } from "./AxisBase2D";
import { ILabel2DOptions } from "./LabelProvider/LabelProviderBase2D";
/**
* Optional parameters used to configure a {@link NumericAxis} at construct time
*/
export interface INumericAxisOptions extends IAxisBase2dOptions, ILabel2DOptions {
}
/**
* @summary A 2D Chart Numeric / Value Axis type
* @description A Numeric axis uses the X-value to measure data-points on the XAxis.
* This is contrary to a {@link CategoryAxis} which uses X-index.
* @remarks
* Set a {@link NumericAxis} on the {@link SciChartSurface.xAxes} or {@link SciChartSurface.yAxes} property.
*
* ---
* 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/axis-api/axis-types/numeric-axis/}
*/
export declare class NumericAxis extends AxisBase2D {
readonly type: EAxisType;
/**
* Creates an instance of a {@link NumericAxis}
* @param webAssemblyContext The {@link TSciChart | SciChart 2D WebAssembly Context} containing native methods and
* access to our WebGL2 Engine and WebAssembly numerical methods
* @param options Optional parameters of type {@link INumericAxisOptions} used to configure the axis at instantiation time
*
* ---
* 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/axis-api/axis-types/numeric-axis/}
*/
constructor(webAssemblyContext: TSciChart, options?: INumericAxisOptions);
/**
* @inheritDoc
*/
protected getCurrentCoordinateCalculatorInternal(): CoordinateCalculatorBase;
}