Package io.keikai.axyra.sheets.content

Enum Class LegendPosition

java.lang.Object

java.lang.Enum<LegendPosition>

io.keikai.axyra.sheets.content.LegendPosition

All Implemented Interfaces:

Serializable, Comparable<LegendPosition>, Constable

public enum LegendPosition
extends Enum<LegendPosition>

Chart legend placement. NONE keeps a legend element marked deleted (<c:delete val="1"/>); to drop the legend element instead, use Chart.Builder.legendVisible(false) or ChartView.setLegendVisible(false).

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	Below the plot area.
LEFT	Left of the plot area.
NONE	No legend shown; saved as a deleted legend element.
RIGHT	Right of the plot area; the default.
TOP	Above the plot area.
TOP_RIGHT	In the top-right corner of the chart.

Method Summary

Modifier and Type	Method	Description
static LegendPosition	from(String token)	The position for an engine token such as "topRight"; RIGHT for an unknown, empty or null token.
String	token()	The OOXML legendPos token sent to the engine, or "none".
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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BOTTOM

public static final LegendPosition BOTTOM

Below the plot area.

TOP

public static final LegendPosition TOP

Above the plot area.

LEFT

public static final LegendPosition LEFT

Left of the plot area.

RIGHT

public static final LegendPosition RIGHT

Right of the plot area; the default.

TOP_RIGHT

public static final LegendPosition TOP_RIGHT

In the top-right corner of the chart.

NONE

public static final LegendPosition NONE

No legend shown; saved as a deleted legend element.

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

token

public String token()

The OOXML legendPos token sent to the engine, or "none".

from

public static LegendPosition from(String token)

The position for an engine token such as "topRight"; RIGHT for an unknown, empty or null token.