Package io.deephaven.plot.datasets.multiseries

Interface MultiSeriesInternal<T extends DataSeriesInternal>

All Superinterfaces:
MultiSeries, PlotExceptionCause, Serializable, Series, SeriesInternal
All Known Implementing Classes:
AbstractMultiSeries, AbstractPartitionedTableHandleMultiSeries, AbstractSwappableMultiSeries, MultiCatErrorBarSeries, MultiCatErrorBarSeriesSwappable, MultiCatSeries, MultiCatSeriesSwappable, MultiOHLCSeries, MultiOHLCSeriesSwappable, MultiXYErrorBarSeries, MultiXYErrorBarSeriesSwappable, MultiXYSeries, MultiXYSeriesSwappable
public interface MultiSeriesInternal<T extends DataSeriesInternal> extends MultiSeries, SeriesInternal, PlotExceptionCause
A parent data series that spawns a DataSeries for each unique key in the parent series.

  • Method Details

    • copy

      MultiSeriesInternal<T> copy(AxesImpl axes)
      Description copied from interface: SeriesInternal
      Create a copy of the series on a different set of axes.
      Specified by:
      copy in interface SeriesInternal
      Parameters:
      axes - new axes.
      Returns:
      copy of the series on a different set of axes.

    • name

      Comparable name()
      Gets the name of this data set.
      Specified by:
      name in interface SeriesInternal
      Returns:
      name of this data set

    • chart

      ChartImpl chart()
      Gets the chart on which this data will be plotted.
      Returns:
      chart on which this data will be plotted

    • axes

      AxesImpl axes()
      Gets the axes on which this data will be plotted.
      Specified by:
      axes in interface SeriesInternal
      Returns:
      axes on which this data will be plotted

    • id

      int id()
      Gets the id for the multi series.
      Specified by:
      id in interface SeriesInternal

    • getByColumns

      String[] getByColumns()
      Gets the by columns for the multi-series.
      Returns:
      by columns for the multi-series.

    • getSeriesCount

      int getSeriesCount()
      Gets the number of series in this multi-series.
      Returns:
      number of series in this multi-series

    • get

      T get(int series)
      Gets the specified series from this multi-series.
      Parameters:
      series - series index
      Returns:
      specified series

    • createSeries

      T createSeries(String seriesName, BaseTable t)
      Creates a new series for this multi-series.
      Parameters:
      seriesName - name for the series
      t - client side source table
      Returns:
      new series for this multi-series

    • createSeries

      T createSeries(String seriesName, BaseTable t, DynamicSeriesNamer dynamicSeriesNamer)
      Creates a new series for this multi-series.
      Parameters:
      seriesName - name for the series
      t - client side source table
      dynamicSeriesNamer - creates the name for the newly generated series. Ensures unique names.
      Returns:
      new series for this multi-series

    • getDynamicSeriesNamer

      DynamicSeriesNamer getDynamicSeriesNamer()
      Gets a utility to make certain that all dynamic series have unique names.
      Returns:
      utility to make certain that all dynamic series have unique names.

    • setDynamicSeriesNamer

      void setDynamicSeriesNamer(DynamicSeriesNamer seriesNamer)

    • initializeSeries

      void initializeSeries(T series)
      Assigns series modifiers, e.g. point color, to the given series
      Parameters:
      series - series to initialize

    • getPartitionedTable

      PartitionedTable getPartitionedTable()
      Returns:
      the underlying PartitionedTable

    • addSeries

      void addSeries(T series, Object key)
      Add the given series to this MultiSeries
      Parameters:
      series - series
      key - key used to determine the name of the series

    • getPlotInfo

      default PlotInfo getPlotInfo()
      Specified by:
      getPlotInfo in interface PlotExceptionCause

    • applyTransform

      void applyTransform(String columnName, String update, Class[] classesToImport, Map<String,Object> params, boolean columnTypesPreserved)
      Calls a .update() on the underlying table with the given formula: underlyingTable.update(columnName = update)
      Parameters:
      columnName - the resulting column
      update - the formula inside
      classesToImport - classes to import into the query scope
      params - parameters to add to the query scope
      columnTypesPreserved - set to true if the update clause is 'add only' with respect to columns. This allows the copying of ACLs

    • getX

      String getX()
      Returns:
      the x-axis data column

    • getY

      String getY()
      Returns:
      the y-axis data column