org.pepstock.charba.client.enums

Enum DefaultPluginId

java.lang.Object

java.lang.Enum<DefaultPluginId>

org.pepstock.charba.client.enums.DefaultPluginId

All Implemented Interfaces:

Serializable, Comparable<DefaultPluginId>, Key

public enum DefaultPluginId
extends Enum<DefaultPluginId>
implements Key

Contains the GLOBAL plugin IDs of the default CHART.JS plugins, provided out of the box.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
DECIMATION CHART.JS plugin to be used with line charts to automatically decimate data at the start of the chart lifecycle.
FILLER CHART.JS plugin to manage color filling on the chart.
LEGEND CHART.JS plugin to manage the legend.
SUBTITLE CHART.JS plugin to manage the subtitle.
TITLE CHART.JS plugin to manage the title.
TOOLTIP CHART.JS plugin to manage the tooltips.

Method Summary

Modifier and Type	Method and Description
static boolean	is(Key pluginId) Returns true if the argument is equals to a default plugin id. The FILLER is not considered a default plugin because does not have a specific namespace in the options.
static boolean	is(String pluginId) Returns true if the argument is equals to a default plugin id.
String	value() Returns the name value of property
static DefaultPluginId	valueOf(String name) Returns the enum constant of this type with the specified name.
static DefaultPluginId[]	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

LEGEND

public static final DefaultPluginId LEGEND

CHART.JS plugin to manage the legend.

FILLER

public static final DefaultPluginId FILLER

CHART.JS plugin to manage color filling on the chart.

DECIMATION

public static final DefaultPluginId DECIMATION

CHART.JS plugin to be used with line charts to automatically decimate data at the start of the chart lifecycle.

TITLE

public static final DefaultPluginId TITLE

CHART.JS plugin to manage the title.

SUBTITLE

public static final DefaultPluginId SUBTITLE

CHART.JS plugin to manage the subtitle.

TOOLTIP

public static final DefaultPluginId TOOLTIP

CHART.JS plugin to manage the tooltips.

Method Detail

values

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

Returns:

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

valueOf

public static DefaultPluginId 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(Key pluginId)

Returns true if the argument is equals to a default plugin id.
The FILLER is not considered a default plugin because does not have a specific namespace in the options.

Parameters:

pluginId - the plugin id to check

Returns:

true if the argument is equals to a default plugin id

is

public static boolean is(String pluginId)

Returns true if the argument is equals to a default plugin id.

Parameters:

pluginId - the plugin id to check

Returns:

true if the argument is equals to a default plugin id