@deephaven/jsapi-types
    Preparing search index...

    Interface Series

    Provides access to the data for displaying in a figure.

    interface Series {
        isLinesVisible?: boolean;
        isShapesVisible?: boolean;
        pointLabelFormat?: string;
        shapeSize?: number;
        xToolTipPattern?: string;
        yToolTipPattern?: string;
        get gradientVisible(): boolean;
        get lineColor(): string;
        get multiSeries(): MultiSeries;
        get name(): string;
        get oneClick(): OneClick;
        get plotStyle(): number;
        get shape(): string;
        get shapeColor(): string;
        get shapeLabel(): string;
        get sources(): SeriesDataSource[];
        subscribe(forceDisableDownsample?: DownsampleOptions): void;
        unsubscribe(): void;
    }
    Index
    isLinesVisible?: boolean

    Whether lines are visible for this series.

    isShapesVisible?: boolean

    Whether shapes are visible for this series.

    pointLabelFormat?: string

    A format string for point labels.

    shapeSize?: number

    The size of shapes in this series.

    xToolTipPattern?: string

    A format string for the x-axis tooltip.

    yToolTipPattern?: string

    A format string for the y-axis tooltip.

    • get gradientVisible(): boolean

      Whether a gradient fill is visible for this series.

      Returns boolean

    • get lineColor(): string

      The line color for this series.

      Returns string

    • get multiSeries(): MultiSeries

      Indicates that this series belongs to a MultiSeries, null otherwise

      Returns MultiSeries

      dh.plot.MultiSeries

    • get name(): string

      The name for this series.

      Returns string

      String

    • get oneClick(): OneClick

      The one-click configuration for this series.

      Returns OneClick

    • get plotStyle(): number

      The plotting style to use for this series. See SeriesPlotStyle enum for more details.

      Returns number

      int

    • get shape(): string

      The shape used to render points in this series.

      Returns string

    • get shapeColor(): string

      The color used to render shapes in this series.

      Returns string

    • get shapeLabel(): string

      The label for shapes in this series.

      Returns string

    • Enables updates for this series.

      If forceDisableDownsample is provided, the series will use the given downsample options.

      Parameters

      Returns void

    • Disables updates for this series.

      Returns void