Package com.jbstrap.ui.components.charts.params.enums

Enum Class LegendPosition

java.lang.Object

java.lang.Enum<LegendPosition>

com.jbstrap.ui.components.charts.params.enums.LegendPosition

All Implemented Interfaces:

Serializable, Comparable<LegendPosition>, Constable

public enum LegendPosition
extends Enum<LegendPosition>

Legend positions.

Since:

4.0

Author:

JBStrap

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM	The legend is displayed below the chart.
LEFT	The legend is displayed on the left side of the chart.
RIGHT	The legend is displayed on the right side of the chart.
TOP	The legend is displayed above the chart.

Method Summary

Modifier and Type	Method	Description
static LegendPosition	fromName(String name)	Determines the legend’s position by its name.
String	toString()
static LegendPosition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LegendPosition[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LEFT

public static final LegendPosition LEFT

The legend is displayed on the left side of the chart.

RIGHT

public static final LegendPosition RIGHT

The legend is displayed on the right side of the chart.

TOP

public static final LegendPosition TOP

The legend is displayed above the chart.

BOTTOM

public static final LegendPosition BOTTOM

The legend is displayed below the chart.

Method Details

values

public static LegendPosition[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LegendPosition valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<LegendPosition>

Returns:

The JavaScript parameter value for the current position

fromName

public static LegendPosition fromName(String name)

Determines the legend’s position by its name.

Parameters:

name - Legend position name

Returns:

The corresponding position name or null, if there is no legend position by the specified name