org.pepstock.charba.client.enums

Enum AxisType

java.lang.Object

java.lang.Enum<AxisType>

org.pepstock.charba.client.enums.AxisType

All Implemented Interfaces:

Serializable, Comparable<AxisType>, Key

public enum AxisType
extends Enum<AxisType>
implements Key

Axes are an integral part of a chart. They are used to determine how data maps to a pixel value on the chart.
These are the possible types of an axis.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
CATEGORY The labels are drawn from one of the label arrays included in the chart data. Where not specified, this is the default.
LINEAR The linear scale is use to chart numerical data.
LOGARITHMIC The logarithmic scale is use to chart numerical data.
RADIAL_LINEAR Radial axes are used specifically for the radar and polar area chart types. These axes overlay the chart area, rather than being positioned on one of the edges. The linear scale is use to chart numerical data. The linear interpolation is used to determine where a value lies in relation the center of the axis.
TIME The time scale is used to display times and dates.

Method Summary

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

checkIfValid, compare, create, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid

Enum Constant Detail

LINEAR

public static final AxisType LINEAR

The linear scale is use to chart numerical data. It can be placed on either the x or y axis.
The linear interpolation is used to determine where a value lies on the axis.

LOGARITHMIC

public static final AxisType LOGARITHMIC

The logarithmic scale is use to chart numerical data. It can be placed on either the x or y axis.
The logarithmic interpolation is used to determine where a value lies on the axis.

CATEGORY

public static final AxisType CATEGORY

The labels are drawn from one of the label arrays included in the chart data.
Where not specified, this is the default.

TIME

public static final AxisType TIME

The time scale is used to display times and dates. When building its ticks, it will automatically calculate the most comfortable unit base on the size of the scale.
Not implemented

RADIAL_LINEAR

public static final AxisType RADIAL_LINEAR

Radial axes are used specifically for the radar and polar area chart types.
These axes overlay the chart area, rather than being positioned on one of the edges.
The linear scale is use to chart numerical data.
The linear interpolation is used to determine where a value lies in relation the center of the axis.

Method Detail

values

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

Returns:

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

valueOf

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