org.pepstock.charba.client.sankey.enums

Enum ColorMode

java.lang.Object

java.lang.Enum<ColorMode>

org.pepstock.charba.client.sankey.enums.ColorMode

All Implemented Interfaces:

Serializable, Comparable<ColorMode>, Key

public enum ColorMode
extends Enum<ColorMode>
implements Key

Enumerates the color mode of the flow to draw on the chart.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
FROM The mode to enable to use the "from" color between items.
GRADIENT This is the default.
TO The mode to enable to use the "to" color between items.

Method Summary

Modifier and Type	Method and Description
String	value() Returns the name value of property
static ColorMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ColorMode[]	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

Methods inherited from interface org.pepstock.charba.client.commons.Key

checkAndGetIfValid, checkIfValid, compare, create, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid

Enum Constant Detail

GRADIENT

public static final ColorMode GRADIENT

This is the default. The mode between "from" and "to" color will be a gradient.

FROM

public static final ColorMode FROM

The mode to enable to use the "from" color between items.

TO

public static final ColorMode TO

The mode to enable to use the "to" color between items.

Method Detail

values

public static ColorMode[] 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 (ColorMode c : ColorMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ColorMode 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

value

public String value()

Description copied from interface: Key

Returns the name value of property

Specified by:

value in interface Key

Returns:

the name value of property