Package com.grapecity.documents.excel

Enum Class PivotFieldCalculation

java.lang.Object

java.lang.Enum<PivotFieldCalculation>

com.grapecity.documents.excel.PivotFieldCalculation

All Implemented Interfaces:

Serializable, Comparable<PivotFieldCalculation>, Constable

public enum PivotFieldCalculation
extends Enum<PivotFieldCalculation>

Specifies the subtotal function.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DifferenceFrom	The difference from the value of the Base item in the Base field.
Index	Data calculated as ((value in cell) x (Grand Total of Grand Totals)) / ((Grand Row Total) x (Grand Column Total)).
NoAdditionalCalculation	No calculation.
PercentDifferenceFrom	Percentage difference from the value of the Base item in the Base field.
PercentOf	Percentage of the value of the Base item in the Base field.
PercentOfColumn	Percentage of the total for the column or series.
PercentOfParent	Percentage of the total of the specified parent Base field.
PercentOfParentColumn	Percentage of the total of the parent column.
PercentOfParentRow	Percentage of the total of the parent row.
PercentOfRow	Percentage of the total for the row or category.
PercentOfTotal	Percentage of the grand total of all the data or data points in the report.
PercentRunningTotal	Percentage of the running total of the specified Base field.
RankAscending	Rank smallest to largest.
RankDecending	Rank largest to smallest.
RunningTotal	Data for successive items in the Base field as a running total.

Method Summary

Modifier and Type	Method	Description
static PivotFieldCalculation	forValue(int value)
int	getValue()
static PivotFieldCalculation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PivotFieldCalculation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DifferenceFrom

public static final PivotFieldCalculation DifferenceFrom

The difference from the value of the Base item in the Base field.

Index

public static final PivotFieldCalculation Index

Data calculated as ((value in cell) x (Grand Total of Grand Totals)) / ((Grand Row Total) x (Grand Column Total)).

NoAdditionalCalculation

public static final PivotFieldCalculation NoAdditionalCalculation

No calculation.

PercentDifferenceFrom

public static final PivotFieldCalculation PercentDifferenceFrom

Percentage difference from the value of the Base item in the Base field.

PercentOf

public static final PivotFieldCalculation PercentOf

Percentage of the value of the Base item in the Base field.

PercentOfColumn

public static final PivotFieldCalculation PercentOfColumn

Percentage of the total for the column or series.

PercentOfParent

public static final PivotFieldCalculation PercentOfParent

Percentage of the total of the specified parent Base field.

PercentOfParentColumn

public static final PivotFieldCalculation PercentOfParentColumn

Percentage of the total of the parent column.

PercentOfParentRow

public static final PivotFieldCalculation PercentOfParentRow

Percentage of the total of the parent row.

PercentOfRow

public static final PivotFieldCalculation PercentOfRow

Percentage of the total for the row or category.

PercentOfTotal

public static final PivotFieldCalculation PercentOfTotal

Percentage of the grand total of all the data or data points in the report.

PercentRunningTotal

public static final PivotFieldCalculation PercentRunningTotal

Percentage of the running total of the specified Base field.

RankAscending

public static final PivotFieldCalculation RankAscending

Rank smallest to largest.

RankDecending

public static final PivotFieldCalculation RankDecending

Rank largest to smallest.

RunningTotal

public static final PivotFieldCalculation RunningTotal

Data for successive items in the Base field as a running total.

Method Details

values

public static PivotFieldCalculation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PivotFieldCalculation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

forValue

public static PivotFieldCalculation forValue(int value)