scichart/Charting/Model/XDataSeries.d.ts

Fast WebGL JavaScript Charting Library and Framework

import { NumberRange } from "../../Core/NumberRange";
import { NumberArray } from "../../types/NumberArray";
import { TSciChart } from "../../types/TSciChart";
import { EYRangeMode } from "../../types/YRangeMode";
import { BaseDataSeries, IBaseDataSeriesOptions } from "./BaseDataSeries";
import { EDataSeriesType, EDataSeriesValueType } from "./IDataSeries";
import { IPointMetadata } from "./IPointMetadata";
/**
 * Options to pass to the {@link XDataSeries} constructor
 */
export interface IXDataSeriesOptions extends IBaseDataSeriesOptions {
    /**
     * Not used in an {@link XDataSeries}
     */
    yValues?: NumberArray;
}
/**
 * @summary XDataSeries is a DataSeries for holding X values only in SciChart's 2D
 * {@link https://www.scichart.com/javascript-chart-features | JavaScript Charts}
 * @description
 * The XDataSeries is primarily used to create Pie or Donut charts with our {@link PolarColumnRenderableSeries | JavaScript Polar Column Chart} in Width mode,
 * or to create a linear gauge using {@link FastBoxRenderableSeries | JavaScript Box Chart} in Width mode.
 *
 * @remarks
 * A DataSeries stores the data to render. This is independent from the {@link IRenderableSeries | RenderableSeries}
 * which defines how that data should be rendered.
 *
 * See derived types of {@link BaseDataSeries} to find out what data-series are available.
 * See derived types of {@link IRenderableSeries} to find out what 2D JavaScript Chart types are available.
 *
 * ---
 * 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/data-series-api/data-series-api-overview/}
 */
export declare class XDataSeries extends BaseDataSeries {
    /**
     * @inheritDoc
     */
    readonly type = EDataSeriesType.X;
    /**
     * Creates an instance of {@link XDataSeries}
     * @param webAssemblyContext the {@link TSciChart | SciChart WebAssembly Context} containing native methods
     * and access to our underlying WebGL2 WebAssembly rendering engine
     * @param options the {@link IXDataSeriesOptions} which can be passed to configure the DataSeries at construct time
     *
     * ---
     * 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/data-series-api/data-series-api-overview/}
     */
    constructor(webAssemblyContext: TSciChart, options?: IXDataSeriesOptions);
    /**
     * Appends a single X point to the DataSeries
     * @remarks
     * For best performance on drawing large datasets, use the {@link appendRange} method
     *
     * Any changes of the DataSeries will trigger a redraw on the parent {@link SciChartSurface}
     * @param x The X-value
     * @param metadata The point metadata
     */
    append(x: number, metadata?: IPointMetadata): void;
    /**
     * Appends a range of X points to the DataSeries
     * @remarks
     * This method is considerably higher performance than {@link append} which appends a single point
     *
     * Any changes of the DataSeries will trigger a redraw on the parent {@link SciChartSurface}
     * @param xValues The X-values
     * @param metadata The array of point metadata
     */
    appendRange(xValues: NumberArray, metadata?: IPointMetadata[]): void;
    /**
     * Updates a single X value by X-index. Might also need to set isSorted = false
     * @remarks Any changes of the DataSeries will trigger a redraw on the parent {@link SciChartSurface}
     * @param index The index to update
     * @param x The new X value
     * @param metadata The point metadata
     */
    updateX(index: number, x: number, metadata?: IPointMetadata): void;
    /**
     * @summary Inserts a single X value at the start index
     * @remarks
     * For best performance on drawing large datasets, use the {@link insertRange} method
     *
     * Any changes of the DataSeries will trigger a redraw on the parent {@link SciChartSurface}
     * @param startIndex the index to insert at
     * @param x the X value
     * @param metadata The point metadata
     */
    insert(startIndex: number, x: number, metadata?: IPointMetadata): void;
    /**
     * @summary Inserts a range of X values at the startIndex
     * @remarks
     * Any changes of the DataSeries will trigger a redraw on the parent {@link SciChartSurface}
     * @param startIndex the index to insert at
     * @param xValues the XValues
     * @param metadata The array of point metadata
     */
    insertRange(startIndex: number, xValues: NumberArray, metadata?: IPointMetadata[]): void;
    /** For XDataSeries this always returns (0, 1) */
    getWindowedYRange(xRange: NumberRange, getPositiveRange: boolean, isXCategoryAxis?: boolean, dataSeriesValueType?: EDataSeriesValueType, yRangeMode?: EYRangeMode): NumberRange;
    protected getOptions(excludeData?: boolean): IXDataSeriesOptions;
}