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

ConsolidationFunction

Enum Class ConsolidationFunction

java.lang.Object
java.lang.Enum<ConsolidationFunction>
com.grapecity.documents.excel.ConsolidationFunction
All Implemented Interfaces:
Serializable, Comparable<ConsolidationFunction>, Constable
public enum ConsolidationFunction extends Enum<ConsolidationFunction>
Specifies the subtotal function.

Use this enumeration to control how values are summarized in features such as IRange.subtotal(int,ConsolidationFunction,int[]) and PivotTable data fields.


 Object[][] sourceData = {
     {"Region", "Amount"},
     {"East", 120},
     {"East", 80},
     {"West", 90}
 };
 worksheet.getRange("A1:B4").setValue(sourceData);
 worksheet.getRange("A1:B4").subtotal(1, ConsolidationFunction.Sum, new int[] {2});

  • Enum Constant Details

  • Method Details

    • values

      public static ConsolidationFunction[] 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 ConsolidationFunction 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