org.pepstock.charba.client.enums

Enum DefaultTransitionKey

java.lang.Object

java.lang.Enum<DefaultTransitionKey>

org.pepstock.charba.client.enums.DefaultTransitionKey

All Implemented Interfaces:

Serializable, Comparable<DefaultTransitionKey>, Key, TransitionKey

public enum DefaultTransitionKey
extends Enum<DefaultTransitionKey>
implements TransitionKey

Cores animation update modes (transition) provided out of the box by CHART.JS.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE Uses to configure the animation when an element is hovering.
DEFAULT Uses to configure the animation to the default.
HIDE Uses to configure the animation when a data set is hidden using legend or IsChart.hide(int).
NONE Uses to configure the animation to ignore the animation.
RESET Uses to configure the animation when an element is resetting.
RESIZE Uses to configure the animation when an element is resizing.
SHOW Uses to configure the animation when a data set is shown using legend or IsChart.show(int).

Method Summary

Modifier and Type	Method and Description
static boolean	is(String mode) Returns true if the argument is equals to a default animation mode.
static boolean	is(TransitionKey mode) Returns true if the argument is equals to a default animation mode.
String	value() Returns the name value of property
static DefaultTransitionKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static DefaultTransitionKey[]	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.options.TransitionKey

checkAndGetIfValid, checkIfValid, create, isValid

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

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

Enum Constant Detail

DEFAULT

public static final DefaultTransitionKey DEFAULT

Uses to configure the animation to the default.

ACTIVE

public static final DefaultTransitionKey ACTIVE

Uses to configure the animation when an element is hovering.

HIDE

public static final DefaultTransitionKey HIDE

Uses to configure the animation when a data set is hidden using legend or IsChart.hide(int).

RESET

public static final DefaultTransitionKey RESET

Uses to configure the animation when an element is resetting.

RESIZE

public static final DefaultTransitionKey RESIZE

Uses to configure the animation when an element is resizing.

SHOW

public static final DefaultTransitionKey SHOW

Uses to configure the animation when a data set is shown using legend or IsChart.show(int).

NONE

public static final DefaultTransitionKey NONE

Uses to configure the animation to ignore the animation.

Method Detail

values

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

Returns:

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

valueOf

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

is

public static boolean is(TransitionKey mode)

Returns true if the argument is equals to a default animation mode.

Parameters:

mode - the animation mode to check

Returns:

true if the argument is equals to a default animation mode

is

public static boolean is(String mode)

Returns true if the argument is equals to a default animation mode.

Parameters:

mode - the animation mode to check

Returns:

true if the argument is equals to a default animation mode