Package io.keikai.axyra.sheets

Enum Class PivotShowDataAsType

java.lang.Object
java.lang.Enum<PivotShowDataAsType>
io.keikai.axyra.sheets.PivotShowDataAsType
All Implemented Interfaces:
Serializable, Comparable<PivotShowDataAsType>, Constable
public enum PivotShowDataAsType extends Enum<PivotShowDataAsType>
Show-Values-As display mode for a pivot values-area field — Excel's "Show Values As" menu (ECMA-376 Part 1 §18.10.1.18 dataField@showDataAs). The transformation is applied post-aggregation on PivotTableView.refresh(); percent modes produce fractions (0.25 = 25%).

  • Enum Constant Details

    • NORMAL

      public static final PivotShowDataAsType NORMAL
      Raw aggregate (no transformation).

    • PERCENT_OF_TOTAL

      public static final PivotShowDataAsType PERCENT_OF_TOTAL
      Cell / grand total.

    • PERCENT_OF_ROW

      public static final PivotShowDataAsType PERCENT_OF_ROW
      Cell / row total.

    • PERCENT_OF_COLUMN

      public static final PivotShowDataAsType PERCENT_OF_COLUMN
      Cell / column total.

    • PERCENT_OF_PARENT

      public static final PivotShowDataAsType PERCENT_OF_PARENT
      Cell / base-field-level ancestor subtotal (needs a base field).

    • DIFFERENCE_FROM

      public static final PivotShowDataAsType DIFFERENCE_FROM
      Cell - base item's cell (needs base field + base item).

    • PERCENT_DIFFERENCE_FROM

      public static final PivotShowDataAsType PERCENT_DIFFERENCE_FROM
      (Cell - base item's cell) / base item's cell (Excel's "% Difference From"). The base item and the total across the base field are blank, and so is a cell whose base is 0. Needs a base field and a base item. For the plain ratio, see PERCENT_OF.

    • RUNNING_TOTAL

      public static final PivotShowDataAsType RUNNING_TOTAL
      Cumulative sum along the base field in display order.

    • RANK_ASCENDING

      public static final PivotShowDataAsType RANK_ASCENDING
      Standard rank, smallest = 1; ties share a rank.

    • RANK_DESCENDING

      public static final PivotShowDataAsType RANK_DESCENDING
      Standard rank, largest = 1; ties share a rank.

    • INDEX

      public static final PivotShowDataAsType INDEX
      (cell x grand total) / (row total x column total).

    • PERCENT_OF

      public static final PivotShowDataAsType PERCENT_OF
      Cell / the base item's cell, shown as a percentage (Excel's "% Of"). The base item reads 100%; the total across the base field is blank. Needs a base field and a base item.

    • PERCENT_OF_PARENT_ROW

      public static final PivotShowDataAsType PERCENT_OF_PARENT_ROW
      Cell / the value of its next-outer row group in the same column (Excel's "% of Parent Row Total"). The outermost row field divides by the column total, so the grand total row reads 100%.

    • PERCENT_OF_PARENT_COLUMN

      public static final PivotShowDataAsType PERCENT_OF_PARENT_COLUMN
      Cell / the value of its next-outer column group in the same row (Excel's "% of Parent Column Total"). The grand total column reads 100%.

    • RUNNING_TOTAL_PERCENT

      public static final PivotShowDataAsType RUNNING_TOTAL_PERCENT
      The running total along the base field as a share of that field's total (Excel's "% Running Total In"), so the last item reads 100%. Needs a base field; the total across the base field is blank.

  • Method Details

    • values

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

    • wire

      public String wire()
      The OOXML showDataAs token, also used across the FFI.