org.pepstock.charba.client.enums

Enum AxisPosition

java.lang.Object

java.lang.Enum<AxisPosition>

org.pepstock.charba.client.enums.AxisPosition

All Implemented Interfaces:

Serializable, Comparable<AxisPosition>, Key

public enum AxisPosition
extends Enum<AxisPosition>
implements Key

An axis can either be positioned at the edge of the chart, at the center of the chart area, or dynamically with respect to a data value.
To position the axis at the edge of the chart, set the position option to one of: 'top', 'left', 'bottom', 'right'.
To position the axis at the center of the chart area, set the position option to 'center'.
In this mode, either the axis option is specified or the axis ID starts with the letter 'x' or 'y'.
To position the axis with respect to a data value, set the position option to an object such as -20.
This will position the axis at a value of -20 on the axis with ID "x".
For cartesian axes, only 1 axis may be specified.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM Sets the edge of an axis to a unit below its normal position.
CENTER Sets the edge of an axis to a unit center to its normal position.
CHART_AREA Sets the edge of an axis to a unit to the chart area to its normal position.
LEFT Sets the edge of an axis to a unit to the left to to its normal position.
RIGHT Sets the edge of an axis to a unit to the right to its normal position.
TOP Sets the edge of an axis to a unit above to its normal position.

Method Summary

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

CENTER

public static final AxisPosition CENTER

Sets the edge of an axis to a unit center to its normal position.

TOP

public static final AxisPosition TOP

Sets the edge of an axis to a unit above to its normal position.

LEFT

public static final AxisPosition LEFT

Sets the edge of an axis to a unit to the left to to its normal position.

BOTTOM

public static final AxisPosition BOTTOM

Sets the edge of an axis to a unit below its normal position.

RIGHT

public static final AxisPosition RIGHT

Sets the edge of an axis to a unit to the right to its normal position.

CHART_AREA

public static final AxisPosition CHART_AREA

Sets the edge of an axis to a unit to the chart area to its normal position.

Method Detail

values

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

Returns:

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

valueOf

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