UNPKG

scichart

Version:

Fast WebGL JavaScript Charting Library and Framework

39 lines (38 loc) 2.18 kB
import { ESeriesType } from "../../../types/SeriesType"; import { TSciChart } from "../../../types/TSciChart"; import { IPointSeries } from "../../Model/PointSeries/IPointSeries"; import { ResamplingParams } from "../../Numerics/Resamplers/ResamplingParams"; import { BaseLineRenderableSeries, IBaseLineRenderableSeriesOptions } from "./BaseLineRenderableSeries"; import { IHitTestProvider } from "./HitTest/IHitTestProvider"; export interface IFastLineSegmentRenderableSeriesOptions extends IBaseLineRenderableSeriesOptions { } /** * Defines a line-series or 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 line series to a {@link SciChartSurface} you need to declare both the {@link FastLineSegmentRenderableSeries | RenderableSeries} * and a {@link XyDataSeries | DataSeries}. Simplified code sample below: * * --- * 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/fast-line-segment-renderable-series/} */ export declare class FastLineSegmentRenderableSeries extends BaseLineRenderableSeries { readonly type = ESeriesType.LineSegmentSeries; /** * Creates an instance of the {@link FastLineSegmentRenderableSeries} * @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 IFastLineSegmentRenderableSeriesOptions} applied when constructing the series type * * --- * 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/fast-line-segment-renderable-series/} */ constructor(webAssemblyContext: TSciChart, options?: IFastLineSegmentRenderableSeriesOptions); /** @inheritDoc */ toPointSeries(rp?: ResamplingParams): IPointSeries; protected addDrawingProviders(webAssemblyContext: TSciChart, options?: IBaseLineRenderableSeriesOptions): void; /** * @inheritDoc */ protected newHitTestProvider(): IHitTestProvider; }