org.xwiki.chart.plot
Enum PlotType

java.lang.Object
  java.lang.Enum<PlotType>
      org.xwiki.chart.plot.PlotType

All Implemented Interfaces:

Serializable, Comparable<PlotType>

public enum PlotType
extends Enum<PlotType>

Enumeration of supported plot types.

Since:

4.2M1

Version:

$Id: e1a6aadcd43674837dc553f381d6744bb03f9364 $

Enum Constant Summary

AREA
Area plot type.

BAR
Bar plot type.

BAR3D
3D bar plot type.

LINE
Line plot type.

LINE3D
3D line plot type.

PIE
Pie plot type.

XYAREA
xy area plot type.

XYLINE3D
xy line3D plot type.

XYLINEANDSHAPE
xy line and shape plot type.

XYSTEP
xy step plot type.

Method Summary

static PlotType	forName(String name)
AxisType[]	getDefaultAxisTypes()
DatasetType	getDefaultDatasetType()
String	getName()
static PlotType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PlotType[]	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

Enum Constant Detail

LINE

public static final PlotType LINE

Line plot type.

AREA

public static final PlotType AREA

Area plot type.

BAR

public static final PlotType BAR

Bar plot type.

PIE

public static final PlotType PIE

Pie plot type.

BAR3D

public static final PlotType BAR3D

3D bar plot type.

LINE3D

public static final PlotType LINE3D

3D line plot type.

XYAREA

public static final PlotType XYAREA

xy area plot type.

XYLINEANDSHAPE

public static final PlotType XYLINEANDSHAPE

xy line and shape plot type.

XYLINE3D

public static final PlotType XYLINE3D

xy line3D plot type.

XYSTEP

public static final PlotType XYSTEP

xy step plot type.

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

Returns:

the name (the string representation) of this dataset type.

getDefaultDatasetType

public DatasetType getDefaultDatasetType()

Returns:

the default dataset type used by this plot type.

forName

public static PlotType forName(String name)

Parameters:

name - A plot type.

Returns:

the plot type corresponding to the name, or null.

getDefaultAxisTypes

public AxisType[] getDefaultAxisTypes()

Returns:

the default axis types.