scichart/Charting/Visuals/RenderableSeries/Polar/PolarLineRenderableSeries.d.ts

Fast WebGL JavaScript Charting Library and Framework

import { NumberRange } from "../../../../Core/NumberRange";
import { ESeriesType } from "../../../../types/SeriesType";
import { TSciChart } from "../../SciChartSurface";
import { BaseLineRenderableSeries } from "../BaseLineRenderableSeries";
import { IFastLineRenderableSeriesOptions } from "../FastLineRenderableSeries";
import { IHitTestProvider } from "../HitTest/IHitTestProvider";
export interface IPolarLineRenderableSeriesOptions extends IFastLineRenderableSeriesOptions {
    /**
     * Sets how to draw the lines. If true draws lines as interpolated arc, otherwise draws normal lines
     */
    interpolateLine?: boolean;
    /**
     * Sets if to clip or draw data outside of the total angle. Default false
     */
    clipToTotalAngle?: boolean;
}
/**
 * Defines a polar line-series or polar line chart type in the SciChart's High Performance Real-time
 * {@link https://www.scichart.com/javascript-chart-features | JavaScript Charts}
 * @remarks
 * To add a polar line series to a {@link SciChartPolarSurface} you need to declare both the {@link PolarLineRenderableSeries | RenderableSeries}
 * and a {@link XyDataSeries | DataSeries}. Simplified code sample below:
 *
 * ```ts
 * const { sciChartSurface, wasmContext } = SciChartPolarSurface.create(rootId);
 *
 * // Create the renderableSeries
 * const polarLineSeries = new PolarLineRenderableSeries(wasmContext, {
 *      dataSeries: new XyDataSeries(wasmContext, {
 *          xValues: [1, 2, 3, 4],
 *          yValues: [3, 2, 4, 1],
 *      }),
 *      stroke: "#FFF"
 * });
 * // append to the SciChartSurface
 * sciChartPolarSurface.renderableSeries.add(polarLineSeries);
 * ```
 *
 * ---
 * 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/polar-line-renderable-series/}
 */
export declare class PolarLineRenderableSeries extends BaseLineRenderableSeries {
    readonly isPolar: boolean;
    readonly type = ESeriesType.PolarLineSeries;
    private clipToTotalAngleProperty;
    private interpolateLineProperty;
    /**
     * Creates an instance of the {@link PolarLineRenderableSeries}
     * @param webAssemblyContext The {@link TSciChart | SciChart WebAssembly Context} containing
     * native methods and access to our WebGL2 WebAssembly Drawing Engine
     * @param options optional parameters of type {@link IPolarLineRenderableSeriesOptions} applied when constructing the series type
     *
     * ---
     * 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/polar-line-renderable-series/}
     */
    constructor(webAssemblyContext: TSciChart, options?: IPolarLineRenderableSeriesOptions);
    /**
     * Gets or sets how to draw lines. If true draws lines as interpolated arc, otherwise draws normal lines
     */
    get interpolateLine(): boolean;
    set interpolateLine(value: boolean);
    /**
     * Gets or sets if to clip or draw data outside of the total angle. Default to draw
     */
    get clipToTotalAngle(): boolean;
    set clipToTotalAngle(value: boolean);
    /** @inheritDoc */
    getIndicesRange(xRange: NumberRange, isCategoryData?: boolean): NumberRange;
    /** @inheritDoc */
    toJSON(excludeData?: boolean): import("../../../..").TSeriesDefinition;
    /** @inheritDoc */
    protected addDrawingProviders(webAssemblyContext: TSciChart, options?: IPolarLineRenderableSeriesOptions): void;
    /** @inheritDoc */
    protected newHitTestProvider(): IHitTestProvider;
}