scichart
Version:
Fast WebGL JavaScript Charting Library and Framework
63 lines (62 loc) • 2.97 kB
TypeScript
import { NumberRange } from "../../../../Core/NumberRange";
import { ESeriesType } from "../../../../types/SeriesType";
import { TSciChart } from "../../../../types/TSciChart";
import { IHitTestProvider } from "../HitTest/IHitTestProvider";
import { IXyScatterRenderableSeriesOptions, XyScatterRenderableSeries } from "../XyScatterRenderableSeries";
/**
* Optional parameters passed to the constructor of {@link PolarXyScatterRenderableSeries}
*/
export interface IPolarXyScatterRenderableSeriesOptions extends IXyScatterRenderableSeriesOptions {
}
/**
* Defines a polar scatter-series or scatter chart type in the SciChart's High Performance Real-time
* {@link https://www.scichart.com/javascript-chart-features | JavaScript Charts}
* @remarks
* To add a scatter series to a {@link SciChartPolarSurface} you need to declare both the {@link PolarXyScatterRenderableSeries | RenderableSeries}
* and a {@link XyDataSeries | DataSeries}. Simplified code sample below:
*
* ```ts
* const { sciChartSurface, wasmContext } = SciChartPolarSurface.create(rootId);
*
* // Create the renderableSeries
* const polarScatterSeries = new PolarXyScatterRenderableSeries(wasmContext, {
* dataSeries: new XyDataSeries(wasmContext, {
* xValues: [1, 2, 3],
* yValues: [3, 2, 4],
* }),
* pointMarker: new EllipsePointMarker(wasmContext, {
* width: 9,
* height: 9,
* fill: "#FF0000",
* stroke: "#0000FF",
* strokeThickness: 1
* })
* });
* // append to the SciChartSurface
* sciChartPolarSurface.renderableSeries.add(polarScatterSeries);
* ```
*
* ---
* 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/polar-xy-scatter-renderable-series/}
*/
export declare class PolarXyScatterRenderableSeries extends XyScatterRenderableSeries {
readonly isPolar: boolean;
readonly type: ESeriesType;
clipToTotalAngle: boolean;
/**
* Creates an instance of the {@link PolarXyScatterRenderableSeries}
* @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 IPolarXyScatterRenderableSeriesOptions} to configure the series
*
* ---
* 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/polar-xy-scatter-renderable-series/}
*/
constructor(webAssemblyContext: TSciChart, options?: IPolarXyScatterRenderableSeriesOptions);
/** @inheritDoc */
getIndicesRange(xRange: NumberRange, isCategoryData?: boolean): NumberRange;
/** @inheritDoc */
protected addDrawingProviders(webAssemblyContext: TSciChart, options?: IPolarXyScatterRenderableSeriesOptions): void;
/** @inheritDoc */
protected newHitTestProvider(): IHitTestProvider;
}