[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

PivotFieldCalculation

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 how a PivotTable data field is calculated.

Use this enumeration with IPivotField.setCalculation(PivotFieldCalculation) to change a data field from the default calculation to a custom calculation such as percentage, difference, running total, or rank. These calculation types apply only to data fields.


 Object[][] sourceData = {
     {"Product", "Country", "Amount"},
     {"Bike", "Australia", 100},
     {"Bike", "Canada", 80}
 };
 worksheet.getRange("A1:C3").setValue(sourceData);
 IPivotCache pivotCache = workbook.getPivotCaches().create(worksheet.getRange("A1:C3"));
 IPivotTable pivotTable = worksheet.getPivotTables().add(pivotCache, worksheet.getRange("E1"));
 pivotTable.getPivotFields().get("Country").setOrientation(PivotFieldOrientation.RowField);
 pivotTable.getPivotFields().get("Amount").setOrientation(PivotFieldOrientation.DataField);
 IPivotField dataField = pivotTable.getDataFields().get("Sum of Amount");
 dataField.setCalculation(PivotFieldCalculation.PercentOfTotal);

  • 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)