org.pepstock.charba.client.enums

Enum InteractionMode

java.lang.Object

java.lang.Enum<InteractionMode>

org.pepstock.charba.client.enums.InteractionMode

All Implemented Interfaces:

Serializable, Comparable<InteractionMode>, Key

public enum InteractionMode
extends Enum<InteractionMode>
implements Key

When configuring interaction with the graph via hover or tooltips, a number of different modes are available to set which elements appear via tooltip or hover.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
dataset Finds items in the same dataset.
index Finds item at the same index.
label Deprecated.
nearest Gets the item that is nearest to the point. The nearest item is determined based on the distance to the center of the chart item (point, bar). If 2 or more items are at the same distance, the one with the smallest area is used.
point Finds all of the items that intersect the point.
single Deprecated.
x Returns all items that would intersect based on the X coordinate of the position only. Note that this only applies to cartesian charts
y Returns all items that would intersect based on the Y coordinate of the position. Note that this only applies to cartesian charts.

Method Summary

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

name

Enum Constant Detail

point

public static final InteractionMode point

Finds all of the items that intersect the point.

nearest

public static final InteractionMode nearest

Gets the item that is nearest to the point.
The nearest item is determined based on the distance to the center of the chart item (point, bar).
If 2 or more items are at the same distance, the one with the smallest area is used.

label

@Deprecated
public static final InteractionMode label

Deprecated.

See 'index' mode.

single

@Deprecated
public static final InteractionMode single

Deprecated.

Finds the first item that intersects the point and returns it.

index

public static final InteractionMode index

Finds item at the same index. If the intersect setting is true, the first intersecting item is used to determine the index in the data.
If intersect false the nearest item, in the x direction, is used to determine the index.

dataset

public static final InteractionMode dataset

Finds items in the same dataset. If the intersect setting is true, the first intersecting item is used to determine the index in the data.
If intersect false the nearest item is used to determine the index.

x

public static final InteractionMode x

Returns all items that would intersect based on the X coordinate of the position only.
Note that this only applies to cartesian charts

y

public static final InteractionMode y

Returns all items that would intersect based on the Y coordinate of the position.
Note that this only applies to cartesian charts.

Method Detail

values

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

Returns:

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

valueOf

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