Package io.deephaven.plot.datasets.category

Class CategoryDataSeriesMap

java.lang.Object

io.deephaven.plot.AbstractSeriesInternal

io.deephaven.plot.datasets.AbstractDataSeries

io.deephaven.plot.datasets.category.AbstractCategoryDataSeries

io.deephaven.plot.datasets.category.AbstractMapBasedCategoryDataSeries

io.deephaven.plot.datasets.category.CategoryDataSeriesMap

All Implemented Interfaces:

CategoryDataSeries, CategoryDataSeriesInternal, DataSeries, DataSeriesInternal, PlotExceptionCause, Series, SeriesInternal, Serializable

public class CategoryDataSeriesMap
extends AbstractMapBasedCategoryDataSeries

A dataset for categorical data which maps a category to it's numerical value.

The number of categories and the number of values must be the same. Does not support repeat categories.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface io.deephaven.plot.datasets.category.CategoryDataSeries

CAT_SERIES_ORDER_COLUMN

Constructor Summary

Constructors

Constructor	Description
CategoryDataSeriesMap(AxesImpl axes, int id, Comparable<?> name, IndexableData<T> categories, IndexableNumericData values)	Creates an instance of CategoryDataSeriesMap, which maps a category to it's numerical value.
CategoryDataSeriesMap(AxesImpl axes, int id, Comparable<?> name, IndexableData<T> categories, IndexableNumericData values, AbstractCategoryDataSeries series)

Method Summary

Modifier and Type	Method	Description
Collection<Comparable>	categories()	Gets the categories of the dataset.
CategoryDataSeriesMap	copy(AxesImpl axes)	Create a copy of the series on a different set of axes.
long	getCategoryLocation(Comparable category)	Get the row key of the specified series.
Number	getValue(Comparable category)	Gets the numeric value corresponding to the given category.
int	size()	Gets the size of this data set.

Methods inherited from class io.deephaven.plot.datasets.category.AbstractMapBasedCategoryDataSeries

pointColor, pointColorInteger, pointLabel, pointShape, pointSize

Methods inherited from class io.deephaven.plot.datasets.category.AbstractCategoryDataSeries

colorsSetSpecific, errorBarColor, errorBarColor, errorBarColor, getColor, getGroup, getLabel, getLabel, getPiePercentLabelFormat, getPointShape, getPointShape, getPointSize, getPointSize, getSeriesColor, gradientVisible, group, labelsSetSpecific, lineColor, lineColor, lineColor, lineStyle, linesVisible, piePercentLabelFormat, pointColor, pointColor, pointColor, pointColor, pointColor, pointColor, pointColor, pointColor, pointColor, pointColorInteger, pointLabel, pointLabel, pointLabel, pointLabel, pointLabel, pointLabelFormat, pointShape, pointShape, pointShape, pointShape, pointShape, pointShape, pointShape, pointSize, pointSize, pointSize, pointSize, pointSize, pointSize, pointSize, pointSize, pointSize, pointSize, pointSize, pointSize, pointSize, pointSize, pointSize, pointsVisible, seriesColor, seriesColor, seriesColor, setPiePercentLabelFormat, shapesSetSpecific, sizesSetSpecific, toolTipPattern, xToolTipPattern, yToolTipPattern

Methods inherited from class io.deephaven.plot.datasets.AbstractDataSeries

chart, getErrorBarColor, getGradientVisible, getLineColor, getLineStyle, getLinesVisible, getPointLabelFormat, getPointsVisible, getXToolTipPattern, getYToolTipPattern, setErrorBarColor, setErrorBarColor, setErrorBarColor, setGradientVisible, setLineColor, setLineColor, setLineColor, setLineStyle, setLinesVisible, setPointLabelFormat, setPointsVisible, setXToolTipPattern, setYToolTipPattern

Methods inherited from class io.deephaven.plot.AbstractSeriesInternal

addPartitionedTableHandle, addSwappableTable, addTableHandle, axes, getPartitionedTableHandles, getSwappableTables, getTableHandles, id, name, removeTableHandle

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.plot.datasets.category.CategoryDataSeries

pointColor, pointColorInteger, pointLabel, pointShape, pointSize

Methods inherited from interface io.deephaven.plot.datasets.category.CategoryDataSeriesInternal

drawYError, getEndY, getStartY

Methods inherited from interface io.deephaven.plot.datasets.DataSeriesInternal

axes, chart, getErrorBarColor, getGradientVisible, getLineColor, getLineStyle, getLinesVisible, getPlotInfo, getPointLabelFormat, getPointsVisible, getXToolTipPattern, getYToolTipPattern, id, name

Methods inherited from interface io.deephaven.plot.SeriesInternal

addPartitionedTableHandle, addSwappableTable, addTableHandle, getPartitionedTableHandles, getSwappableTables, getTableHandles, removeTableHandle

Constructor Details

CategoryDataSeriesMap

public CategoryDataSeriesMap(AxesImpl axes,
 int id,
 Comparable<?> name,
 IndexableData<T> categories,
 IndexableNumericData values)

Creates an instance of CategoryDataSeriesMap, which maps a category to it's numerical value.

The number of categories and the number of values must be the same. Does not support null or repeat categories.

Type Parameters:

T - type of the categorical data

Parameters:

axes - AxesImpl on which this dataset is being plotted

id - data series id

name - series name

categories - categorical data

values - numerical data

Throws:

IllegalArgumentException - categories and values must not be null categories and values must have equal sizes

UnsupportedOperationException - categories must not contain null values categories must not contain repeat values

CategoryDataSeriesMap

public CategoryDataSeriesMap(AxesImpl axes,
 int id,
 Comparable<?> name,
 IndexableData<T> categories,
 IndexableNumericData values,
 AbstractCategoryDataSeries series)

Method Details

copy

public CategoryDataSeriesMap copy(AxesImpl axes)

Description copied from interface: SeriesInternal

Create a copy of the series on a different set of axes.

Parameters:

axes - new axes.

Returns:

copy of the series on a different set of axes.

size

public int size()

Description copied from interface: DataSeriesInternal

Gets the size of this data set.

Returns:

size of this data set

categories

public Collection<Comparable> categories()

Description copied from interface: CategoryDataSeriesInternal

Gets the categories of the dataset.

Returns:

all categories in the dataset

getValue

public Number getValue(Comparable category)

Description copied from interface: CategoryDataSeriesInternal

Gets the numeric value corresponding to the given category.

Parameters:

category - category

Returns:

numeric value corresponding to the given category

getCategoryLocation

public long getCategoryLocation(Comparable category)

Description copied from interface: CategoryDataSeriesInternal

Get the row key of the specified series.

Returns: