scichart/Charting/Visuals/Axis/Polar/PolarNumericAxis.d.ts

Fast WebGL JavaScript Charting Library and Framework

import { EAxisType } from "../../../../types/AxisType";
import { TSciChart } from "../../../../types/TSciChart";
import { CoordinateCalculatorBase } from "../../../Numerics/CoordinateCalculators/CoordinateCalculatorBase";
import { INumericAxisOptions } from "../NumericAxis";
import { IPolarAxisOptions, PolarAxisBase } from "./PolarAxisBase";
/**
 * Optional parameters used to configure a {@link PolarNumericAxis} at construct time
 */
export interface IPolarNumericAxisOptions extends INumericAxisOptions, IPolarAxisOptions {
}
/**
 * @summary A 2D Chart Numeric / Value Axis type for use with Polar Charts.
 * @description A Polar Numeric axis converts to angles around a circle.
 * @remarks
 * Set a {@link PolarNumericAxis} on the {@link SciChartPolarSurface.xAxes} or {@link SciChartPolarSurface.yAxes} property.
 *
 * ---
 * 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/axis-api/axis-types/polar-numeric-axis/}
 */
export declare class PolarNumericAxis extends PolarAxisBase {
    readonly type = EAxisType.PolarNumericAxis;
    /**
     * Creates an instance of a {@link PolarNumericAxis}
     * @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 IPolarNumericAxisOptions} used to configure the axis at instantiation time
     *
     * ---
     * 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/axis-api/axis-types/polar-numeric-axis/}
     */
    constructor(webAssemblyContext: TSciChart, options?: IPolarNumericAxisOptions);
    /** @inheritDoc */
    protected getCurrentCoordinateCalculatorInternal(): CoordinateCalculatorBase;
}