scichart
Version:
Fast WebGL JavaScript Charting Library and Framework
34 lines (33 loc) • 1.99 kB
TypeScript
import { NumberRange } from "../../../Core/NumberRange";
import { TSciChart } from "../../../types/TSciChart";
import { TSciChart3D } from "../../../types/TSciChart3D";
import { CoordinateCalculatorBase } from "../CoordinateCalculators/CoordinateCalculatorBase";
import { TickProvider } from "./TickProvider";
/**
* @summary The IndexTickProvider is a {@link TickProvider} implementation for Index Axis.
* @description TickProviders are responsible for calculating the interval between major and minor gridlines, ticks and labels.
*
* * The method {@link getMajorTicks} returns an array of major ticks (data-values values where SciChart will place labels and major gridlines.
* * The method {@link getMinorTicks} returns an array of minor ticks (data-values values where SciChart will place minor gridlines.
* * The method {@link isParamsValid} performs some sanity checks.
* * The method {@link calculateTicks} performs the actual calculation
*
* Override these methods to create custom implementations of Tick intervals in SciChart
* @remarks
* See also {@link TickProvider} for the base implementation.
*/
export declare class IndexTickProvider extends TickProvider {
private webAssemblyContext;
private numericTickProvider;
/**
* Creates an instance of an IndexTickProvider
* @param webAssemblyContext The {@link TSciChart | SciChart 2D WebAssembly Context} or {@link TSciChart | SciChart 3D WebAssembly Context}
* containing native methods and access to our WebGL2 WebAssembly Rendering Engine
*/
constructor(webAssemblyContext: TSciChart | TSciChart3D);
/** @inheritDoc */
getMinorTicks(minorDelta: number, majorDelta: number, visibleRange: NumberRange, coordCalc: CoordinateCalculatorBase): number[];
/** @inheritDoc */
getMajorTicks(minorDelta: number, majorDelta: number, visibleRange: NumberRange, coordCalc: CoordinateCalculatorBase): number[];
private getIndexRange;
}