org.pepstock.charba.client.enums

Enum TickSource

java.lang.Object

java.lang.Enum<TickSource>

org.pepstock.charba.client.enums.TickSource

All Implemented Interfaces:

Serializable, Comparable<TickSource>, Key

public enum TickSource
extends Enum<TickSource>
implements Key

Controls the ticks generation on cartesian time axis.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Generates "optimal" ticks based on scale size and time options.
DATA Generates ticks from data (including labels from data {t|x|y} objects).
LABELS Generates ticks from user given data.labels values ONLY.

Method Summary

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

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

Enum Constant Detail

AUTO

public static final TickSource AUTO

Generates "optimal" ticks based on scale size and time options.

DATA

public static final TickSource DATA

Generates ticks from data (including labels from data {t|x|y} objects).

LABELS

public static final TickSource LABELS

Generates ticks from user given data.labels values ONLY.

Method Detail

values

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

Returns:

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

valueOf

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