com.sap.tc.webdynpro.clientserver.uielib.analytics.api

Class WDChartRange

java.lang.Object
  com.sap.tc.webdynpro.clientserver.uielib.analytics.api.WDChartRange

public final class WDChartRange

extends Object

Enumeration type WDChartRange. Defines how the chart's value range is determined.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND IT!

Type Classification:

This class is part of the Web Dynpro API, so applications may reference it or call any method of this type, but they must not subclass it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Field Summary

static WDChartRange	AUTO Automatically calculate the values range based on the actual data.
static WDChartRange	FIXED Fix the value range according to the maximum and minimum attributes.
static WDChartRange	LIVE Same as slider, except the chart is continuously updated while the user is dragging the range slider (and not just upon release of the mouse).
static WDChartRange	SLIDER Set the initial value range to minimum and maximum, but let the user change the range at any time by dragging a range slider.
static WDChartRange	ZERO Similar to auto, but also ensures that the range starts or ends on the zero baseline.

Method Summary

static Iterator	iterateValues() Returns an iterator over the values of the WDChartRange type.
int	ordinal() Returns the ordinal of this enumeration value (its position in its enum declaration, where the first value is assigned an ordinal of zero).
String	toString() Returns the string representation of this enumeration value.
static WDChartRange	valueOf(int ordinal) Returns the enumeration value for the given ordinal.
static WDChartRange	valueOf(String name) Returns the enumeration value for the given name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

AUTO

public static final WDChartRange AUTO

Automatically calculate the values range based on the actual data.

FIXED

public static final WDChartRange FIXED

Fix the value range according to the maximum and minimum attributes.

LIVE

public static final WDChartRange LIVE

Same as slider, except the chart is continuously updated while the user is dragging the range slider (and not just upon release of the mouse).

SLIDER

public static final WDChartRange SLIDER

Set the initial value range to minimum and maximum, but let the user change the range at any time by dragging a range slider.

ZERO

public static final WDChartRange ZERO

Similar to auto, but also ensures that the range starts or ends on the zero baseline.

Method Detail

ordinal

public int ordinal()

Returns the ordinal of this enumeration value (its position in its enum declaration, where the first value is assigned an ordinal of zero). Most programmers will have no use for this method. It is designed for use by sophisticated enum-based data structures.

Returns:

the ordinal of this enumeration value

toString

public String toString()

Returns the string representation of this enumeration value.

Returns:

the string value of this enumeration value

valueOf

public static WDChartRange valueOf(int ordinal)

Returns the enumeration value for the given ordinal.

Parameters:

ordinal - an ordinal

Returns:

the enumeration value for the given ordinal

valueOf

public static WDChartRange valueOf(String name)

Returns the enumeration value for the given name. Ignores case.

Parameters:

name - a name

Returns:

the enumeration value for the given name

iterateValues

public static Iterator iterateValues()

Returns an iterator over the values of the WDChartRange type.

Returns:

a read-only iterator over the values of this enumeration type