org.pepstock.charba.client.enums

Enum InteractionAxis

java.lang.Object

java.lang.Enum<InteractionAxis>

org.pepstock.charba.client.enums.InteractionAxis

All Implemented Interfaces:

Serializable, Comparable<InteractionAxis>, Key

public enum InteractionAxis
extends Enum<InteractionAxis>
implements Key

Can be set to 'x', 'y', or 'xy' to define which directions are used in calculating distances.
Defaults to 'x' for index mode and 'xy' in dataset and nearest modes.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
X X directions are used in calculating distances.
XY XY directions are used in calculating distances.
Y Y directions are used in calculating distances.

Method Summary

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

X

public static final InteractionAxis X

X directions are used in calculating distances.

Y

public static final InteractionAxis Y

Y directions are used in calculating distances.

XY

public static final InteractionAxis XY

XY directions are used in calculating distances.

Method Detail

values

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

Returns:

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

valueOf

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