com.grapecity.documents.excel

Enum SparkScale

java.lang.Object

java.lang.Enum<SparkScale>

com.grapecity.documents.excel.SparkScale

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SparkScale>

public enum SparkScale
extends java.lang.Enum<SparkScale>

Specifies how the minimum or maximum value of the vertical axis of the sparkline is scaled relative to other sparklines in the group.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SparkScaleCustom Specifies that the minimum or maximum value for the vertical axis of the sparkline has a user-defined value.
SparkScaleGroup Specifies that the minimum or maximum value for the vertical axes of all of the sparklines in the group have the same value.
SparkScaleSingle Specifies that the minimum or maximum value for the vertical axis of each sparkline in the group is automatically set to its own calculated value.

Method Summary

Modifier and Type	Method and Description
static SparkScale	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SparkScale[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SparkScaleGroup

public static final SparkScale SparkScaleGroup

Specifies that the minimum or maximum value for the vertical axes of all of the sparklines in the group have the same value.

SparkScaleSingle

public static final SparkScale SparkScaleSingle

Specifies that the minimum or maximum value for the vertical axis of each sparkline in the group is automatically set to its own calculated value.

SparkScaleCustom

public static final SparkScale SparkScaleCustom

Specifies that the minimum or maximum value for the vertical axis of the sparkline has a user-defined value.

Method Detail

values

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

Returns:

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

valueOf

public static SparkScale valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null