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>

public enum PlotStyle
extends Enum<PlotStyle>

Style of plot (e.g. line, bar, etc.).

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static PlotStyle	plotStyle(String style) Gets the corresponding PlotStyle of style.
static String[]	plotStyleNames() Gets the names of available PlotStyles.
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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static PlotStyle[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PlotStyle c : PlotStyle.values())
    System.out.println(c);

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)

Gets the corresponding PlotStyle of style.

Parameters:

style - case insensitive style name

Returns:

the PlotStyle with the given name

Throws:

IllegalArgumentException - style must not be null

plotStyleNames

public static String[] plotStyleNames()

Gets the names of available PlotStyles.

Returns:

an array of the PlotStyle names