Skip to main content
Version: Python

plot_cat

The plot_cat method uses data from Deephaven tables to create a plot with discrete categories on the X axis.

Syntax

plot_cat(
series_name: str,
t: Union[Table, SelectableDataSet],
category: Union[str, list[str], list[int], list[float]],
y: Union[str, list[int], list[float], list[DateTime]],
y_low: Union[str, list[int], list[float], list[DateTime]] = None,
y_high: Union[str, list[int], list[float], list[DateTime]] = None,
by: list[str] = None,
) -> Figure

Parameters

ParameterTypeDescription
series_namestr

The name (as a String) you want to use to identify the series on the plot itself.

tUnion[Table, SelectableDataSet]

The table (or other selectable data set) that holds the data to be plotted.

categoryUnion[str, list[str], list[int], list[float]]

The names of the columns to be used for the categories.

yUnion[str, list[int], list[float], list[DateTime]]

The name of the column containing the discrete values.

y_low optionalUnion[str, list[int], list[float], list[DateTime]]

The name of the column containing lower Y error bar data.

y_high optionalUnion[str, list[int], list[float], list[DateTime]]

The name of the column containing upper Y error bar data.

by optionallist[str]

A list of one or more columns that contain grouping data.

Returns

A category plot.

Examples

The following example plots data from a Deephaven table.

from deephaven.plot.figure import Figure
from deephaven import new_table
from deephaven.column import int_col, string_col

source = new_table(
[string_col("Categories", ["A", "B", "C"]), int_col("Values", [1, 3, 5])]
)

new_plot = (
Figure()
.plot_cat(
series_name="Cagetories Plot", t=source, category="Categories", y="Values"
)
.chart_title(title="Categories and Values")
.show()
)