Package io.deephaven.web.client.api.widget.plot

Class JsSeries

java.lang.Object
io.deephaven.web.client.api.widget.plot.JsSeries
@TsInterface @JsType(namespace="dh.plot", name="Series") public class JsSeries extends Object
Provides access to the data for displaying in a figure.

  • Constructor Details

  • Method Details

    • initSources

      @JsIgnore public void initSources(Map<Integer,JsTable> tables, Map<Integer,JsPartitionedTable> partitionedTables)
      Post-construct initialization, once we have tables loaded, allowing js to get the type of the data that it will be consuming. This is safe to do post-construction, since we don't actually return the JsFigure etc until tables are loaded.

    • subscribe

      @JsIgnore public void subscribe()
      JS doesn't support method overloads, so we just ignore this one and mark the arg as optional in the JS version. Enable updates for this Series.

    • subscribe

      public void subscribe(@JsOptional @JsNullable DownsampleOptions forceDisableDownsample)
      Enables updates for this series.

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

      Parameters:
      forceDisableDownsample - optional downsample options

    • unsubscribe

      public void unsubscribe()
      Disables updates for this series.

    • markUnsubscribed

      @JsIgnore public void markUnsubscribed()

    • getDownsampleOptions

      @JsIgnore public DownsampleOptions getDownsampleOptions()

    • isSubscribed

      @JsIgnore public boolean isSubscribed()

    • getPlotStyle

      @JsProperty @TsTypeRef(JsSeriesPlotStyle.class) public @com.vertispan.tsdefs.annotations.TsTypeRef(io.deephaven.web.client.api.widget.plot.enums.JsSeriesPlotStyle.class) int getPlotStyle()
      The plotting style to use for this series. See SeriesPlotStyle enum for more details.
      Returns:
      int

    • getName

      @JsProperty public String getName()
      The name for this series.
      Returns:
      String

    • getLinesVisible

      @JsProperty(name="isLinesVisible") public @JsNullable Boolean getLinesVisible()
      Whether lines are visible for this series.

    • getShapesVisible

      @JsProperty(name="isShapesVisible") public @JsNullable Boolean getShapesVisible()
      Whether shapes are visible for this series.

    • isGradientVisible

      @JsProperty public boolean isGradientVisible()
      Whether a gradient fill is visible for this series.

    • getLineColor

      @JsProperty public String getLineColor()
      The line color for this series.

    • getPointLabelFormat

      @JsProperty public @JsNullable String getPointLabelFormat()
      A format string for point labels.

    • getXToolTipPattern

      @JsProperty public @JsNullable String getXToolTipPattern()
      A format string for the x-axis tooltip.

    • getYToolTipPattern

      @JsProperty public @JsNullable String getYToolTipPattern()
      A format string for the y-axis tooltip.

    • getShapeLabel

      @JsProperty public String getShapeLabel()
      The label for shapes in this series.

    • getShapeSize

      @JsProperty public @JsNullable Double getShapeSize()
      The size of shapes in this series.

    • getShapeColor

      @JsProperty public String getShapeColor()
      The color used to render shapes in this series.

    • getShape

      @JsProperty public String getShape()
      The shape used to render points in this series.

    • getSources

      @JsProperty public SeriesDataSource[] getSources()
      Contains details on how to access data within the chart for this series. keyed with the way that this series uses the axis.
      Returns:
      SeriesDataSource

    • getDescriptor

      @JsIgnore public FigureDescriptor.SeriesDescriptor getDescriptor()

    • setMultiSeries

      @JsIgnore public void setMultiSeries(JsMultiSeries multiSeries)

    • getMultiSeries

      @JsProperty public JsMultiSeries getMultiSeries()
      Indicates that this series belongs to a MultiSeries, null otherwise
      Returns:
      dh.plot.MultiSeries

    • getOneClick

      @JsProperty public OneClick getOneClick()
      The one-click configuration for this series.