org.pepstock.charba.client.datalabels.enums

Enum Display

java.lang.Object

java.lang.Enum<Display>

org.pepstock.charba.client.datalabels.enums.Display

All Implemented Interfaces:

Serializable, Comparable<Display>, Key

public enum Display
extends Enum<Display>
implements Key

The display option controls the visibility of labels.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
auto 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.
isFalse The label is hidden.
isTrue This is default and the label is drawn.

Method Summary

Modifier and Type	Method and Description
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

name

Enum Constant Detail

isTrue

public static final Display isTrue

This is default and the label is drawn.

isFalse

public static final Display isFalse

The label is hidden.

auto

public static final Display auto

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