Package io.deephaven.plot

Class SeriesCollection

java.lang.Object

io.deephaven.plot.SeriesCollection

All Implemented Interfaces:

PlotExceptionCause, Serializable

public class SeriesCollection
extends Object
implements Serializable, PlotExceptionCause

A collection of data series.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SeriesCollection.SeriesDescription	Description of a data series.
static enum	SeriesCollection.SeriesType	Type of data series.

Constructor Summary

Constructors

Constructor	Description
SeriesCollection(PlotInfo plotInfo)

Method Summary

Modifier and Type	Method	Description
void	add(SeriesCollection.SeriesType type, boolean isMultiSeries, SeriesInternal series)	Add a new Series.
SeriesCollection	copy(AxesImpl axes)	Creates a copy of this series collection on a new set of axes.
PlotInfo	getPlotInfo()
Map<Comparable,SeriesCollection.SeriesDescription>	getSeriesDescriptions()	Gets the descriptions of the series in the collection.
Set<SwappableTable>	getSwappableTables()
void	remove(Comparable... names)	Removes the series with the specified names.
SeriesInternal	series(int id)	Gets the series with the given series ID.
SeriesInternal	series(Comparable name)	Gets the series with the given series name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SeriesCollection

public SeriesCollection(PlotInfo plotInfo)

Method Details

getPlotInfo

public PlotInfo getPlotInfo()

Specified by:

getPlotInfo in interface PlotExceptionCause

copy

public SeriesCollection copy(AxesImpl axes)

Creates a copy of this series collection on a new set of axes.

Parameters:

axes - axes to create a copy of this series on.

Returns:

copy of the series collection on the new set of axes.

getSeriesDescriptions

public Map<Comparable,SeriesCollection.SeriesDescription> getSeriesDescriptions()

Gets the descriptions of the series in the collection. The result is a map between series name and description.

Returns:

descriptions of the series in the collection

series

public SeriesInternal series(int id)

Gets the series with the given series ID.

Parameters:

id - series id

Returns:

series

series

public SeriesInternal series(Comparable name)

Gets the series with the given series name.

Parameters:

name - series name

Returns:

series

getSwappableTables

public Set<SwappableTable> getSwappableTables()

add

public void add(SeriesCollection.SeriesType type,
 boolean isMultiSeries,
 SeriesInternal series)

Add a new Series.

Parameters:

type - type of series

isMultiSeries - true for multi-series; false for standard mono-series.

series - series

remove

public void remove(Comparable... names)

Removes the series with the specified names.

Parameters:

names - series names