org.pepstock.charba.client.enums

Enum Display

java.lang.Object

java.lang.Enum<Display>

org.pepstock.charba.client.enums.Display

All Implemented Interfaces:

Serializable, Comparable<Display>, Key

public enum Display
extends Enum<Display>
implements Key

The display option controls the visibility of axis and the display option controls the visibility of data labels plugin.
Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO The axis is visible only if at least one associated dataset is visible. For plugin, the label is hidden if it overlap with another label. The display 'auto' option can be used to prevent overlapping labels, based on the following rules when two labels overlap: if both labels are display: true, they will be drawn overlapping if both labels are display: 'auto', the one with the highest data index will be hidden.
FALSE The axis is hidden. For plugin, the label is hidden.
TRUE This is default and the axis is drawn. For plugin, this is default and the label is drawn.

Method Summary

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

TRUE

public static final Display TRUE

This is default and the axis is drawn.
For plugin, this is default and the label is drawn.

FALSE

public static final Display FALSE

The axis is hidden.
For plugin, the label is hidden.

AUTO

public static final Display AUTO

The axis is visible only if at least one associated dataset is visible.
For plugin, the label is hidden if it overlap with another label.
The display 'auto' option can be used to prevent overlapping labels, based on the following rules when two labels overlap:

• if both labels are display: true, they will be drawn overlapping
• if both labels are display: 'auto', the one with the highest data index will be hidden. If labels are at the same data index, the one with the lowest dataset index will be hidden.
• if one label is display: true and the other one is display: 'auto', the one with 'auto' will be hidden (whatever the data/dataset indices).

Method Detail

values

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

Returns:

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

valueOf

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