Package com.illumon.iris.db.plot

Enum PlotStyle

java.lang.Object

java.lang.Enum<PlotStyle>

com.illumon.iris.db.plot.PlotStyle

All Implemented Interfaces:

Serializable, Comparable<PlotStyle>, java.lang.constant.Constable

public enum PlotStyle
extends Enum<PlotStyle>

The style of a plot (e.g. line, bar, etc.).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AREA	An area chart.
BAR	A bar chart.
ERROR_BAR	An error bar plot.
HISTOGRAM	A histogram chart.
LINE	A line chart.
OHLC	An open-high-low-close chart.
PIE	A pie chart.
SCATTER	A scatter plot.
STACKED_AREA	A stacked area chart.
STACKED_BAR	A stacked bar chart.
STEP

Method Summary

Modifier and Type	Method	Description
static PlotStyle	plotStyle(String style)	Returns the requested plot style.
static String[]	plotStyleNames()	Returns the names of available plot styles.
static PlotStyle	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PlotStyle[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BAR

public static final PlotStyle BAR

A bar chart.

STACKED_BAR

public static final PlotStyle STACKED_BAR

A stacked bar chart.

LINE

public static final PlotStyle LINE

A line chart. Does not display shapes at data points by default.

AREA

public static final PlotStyle AREA

An area chart. Does not display shapes at data points by default.

STACKED_AREA

public static final PlotStyle STACKED_AREA

A stacked area chart. Does not display shapes at data points by default.

PIE

public static final PlotStyle PIE

A pie chart.

HISTOGRAM

public static final PlotStyle HISTOGRAM

A histogram chart.

OHLC

public static final PlotStyle OHLC

An open-high-low-close chart.

SCATTER

public static final PlotStyle SCATTER

A scatter plot. Lines are not displayed by default.

STEP

public static final PlotStyle STEP

ERROR_BAR

public static final PlotStyle ERROR_BAR

An error bar plot. Points are not displayed by default.

Method Details

values

public static PlotStyle[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PlotStyle valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

plotStyle

public static PlotStyle plotStyle(String style)

Returns the requested plot style.

Parameters:

style - case insensitive style name

Returns:

PlotStyle with the given name

Throws:

IllegalArgumentException - style must not be null

plotStyleNames

public static String[] plotStyleNames()

Returns the names of available plot styles.

Returns:

array of the PlotStyle names