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

IPivotCell

Interface IPivotCell

public interface IPivotCell
Represents a cell in a PivotTable report. 

 worksheet.getRange("A1:C4").setValue(new Object[][] {
     {"Category", "Product", "Amount"},
     {"Fruit", "Apple", 100},
     {"Fruit", "Orange", 200},
     {"Vegetable", "Carrot", 150}
 });
 IPivotCache pivotCache = workbook.getPivotCaches().create(worksheet.getRange("A1:C4"));
 IPivotTable pivotTable = worksheet.getPivotTables().add(pivotCache, worksheet.getRange("E1"), "SalesPivot");
 pivotTable.getPivotFields().get("Category").setOrientation(PivotFieldOrientation.RowField);
 pivotTable.getPivotFields().get("Amount").setOrientation(PivotFieldOrientation.DataField);
 IPivotValueCell valueCell = pivotTable.pivotValueCell(0, 0);
 IPivotCell pivotCell = valueCell.getPivotCell();
 PivotCellType cellType = pivotCell.getPivotCellType();

  • Method Summary

    Modifier and Type
    Method
    Description
    IPivotItemList
    getColumnItems()
    Returns a PivotItemList collection that corresponds to the items on the column axis that represent the selected range.
    ConsolidationFunction
    getCustomSubtotalFunction()
    Returns the custom subtotal function field setting of a PivotCell object.
    IPivotField
    getDataField()
    Returns a PivotField object that corresponds to the selected data field.
    PivotCellType
    getPivotCellType()
    Returns a constant that identifies the PivotTable entity the cell corresponds to.
    IPivotLine
    getPivotColumnLine()
    Returns the PivotLine corresponding to the column where the PivotCell is located.
    IPivotField
    getPivotField()
    Returns a PivotField object that represents the PivotTable field that contains the upper-left corner of the specified range.
    IPivotItem
    getPivotItem()
    Returns a PivotItem object that represents the PivotTable item containing the upper-left corner of the specified range.
    IPivotLine
    getPivotRowLine()
    Returns the PivotLine corresponding to the row where the PivotCell is located.
    IPivotTable
    getPivotTable()
    Returns the PivotTable that contains this pivot cell, or the PivotTable associated with a PivotChart.
    IRange
    getRange()
    Returns a Range object that represents the range the specified PivotCell applies to.
    IPivotItemList
    getRowItems()
    Returns a PivotItemList collection that corresponds to the items on the category axis that represent the selected cell.

  • Method Details

    • getRowItems

      IPivotItemList getRowItems()
      Returns a PivotItemList collection that corresponds to the items on the category axis that represent the selected cell. 
      
 IPivotValueCell valueCell = pivotTable.pivotValueCell(0, 0);
 IPivotCell pivotCell = valueCell.getPivotCell();
 IPivotItemList rowItems = pivotCell.getRowItems();
      Returns:
      A PivotItemList collection that corresponds to the items on the category axis that represent the selected cell.

    • getColumnItems

      IPivotItemList getColumnItems()
      Returns a PivotItemList collection that corresponds to the items on the column axis that represent the selected range. 
      
 IPivotValueCell valueCell = pivotTable.pivotValueCell(0, 0);
 IPivotCell pivotCell = valueCell.getPivotCell();
 IPivotItemList columnItems = pivotCell.getColumnItems();
      Returns:
      A PivotItemList collection that corresponds to the items on the column axis that represent the selected range.

    • getCustomSubtotalFunction

      ConsolidationFunction getCustomSubtotalFunction()
      Returns the custom subtotal function field setting of a PivotCell object. 
      
 IPivotValueCell valueCell = pivotTable.pivotValueCell(0, 0);
 IPivotCell pivotCell = valueCell.getPivotCell();
 ConsolidationFunction function = pivotCell.getCustomSubtotalFunction();
      Returns:
      The custom subtotal function field setting of a PivotCell object.

    • getDataField

      IPivotField getDataField()
      Returns a PivotField object that corresponds to the selected data field. 
      
 IPivotValueCell valueCell = pivotTable.pivotValueCell(0, 0);
 IPivotCell pivotCell = valueCell.getPivotCell();
 IPivotField dataField = pivotCell.getDataField();
      Returns:
      A PivotField object that corresponds to the selected data field.

    • getPivotCellType

      PivotCellType getPivotCellType()
      Returns a constant that identifies the PivotTable entity the cell corresponds to. 
      
 IPivotValueCell valueCell = pivotTable.pivotValueCell(0, 0);
 IPivotCell pivotCell = valueCell.getPivotCell();
 PivotCellType cellType = pivotCell.getPivotCellType();
      Returns:
      A constant that identifies the PivotTable entity the cell corresponds to.

    • getPivotColumnLine

      IPivotLine getPivotColumnLine()
      Returns the PivotLine corresponding to the column where the PivotCell is located. 
      
 IPivotValueCell valueCell = pivotTable.pivotValueCell(0, 0);
 IPivotCell pivotCell = valueCell.getPivotCell();
 IPivotLine columnLine = pivotCell.getPivotColumnLine();
      Returns:
      The PivotLine corresponding to the column where the PivotCell is located.

    • getPivotField

      IPivotField getPivotField()
      Returns a PivotField object that represents the PivotTable field that contains the upper-left corner of the specified range. 
      
 IPivotValueCell valueCell = pivotTable.pivotValueCell(0, 0);
 IPivotCell pivotCell = valueCell.getPivotCell();
 IPivotField field = pivotCell.getPivotField();
      Returns:
      A PivotField object that represents the PivotTable field that contains the upper-left corner of the specified range.

    • getPivotItem

      IPivotItem getPivotItem()
      Returns a PivotItem object that represents the PivotTable item containing the upper-left corner of the specified range. 
      
 IPivotValueCell valueCell = pivotTable.pivotValueCell(0, 0);
 IPivotCell pivotCell = valueCell.getPivotCell();
 IPivotItem item = pivotCell.getPivotItem();
      Returns:
      A PivotItem object that represents the PivotTable item containing the upper-left corner of the specified range.

    • getPivotRowLine

      IPivotLine getPivotRowLine()
      Returns the PivotLine corresponding to the row where the PivotCell is located. 
      
 IPivotValueCell valueCell = pivotTable.pivotValueCell(0, 0);
 IPivotCell pivotCell = valueCell.getPivotCell();
 IPivotLine rowLine = pivotCell.getPivotRowLine();
      Returns:
      The PivotLine corresponding to the row where the PivotCell is located.

    • getPivotTable

      IPivotTable getPivotTable()
      Returns the PivotTable that contains this pivot cell, or the PivotTable associated with a PivotChart. 
      
 IPivotValueCell valueCell = pivotTable.pivotValueCell(0, 0);
 IPivotCell pivotCell = valueCell.getPivotCell();
 IPivotTable parentPivotTable = pivotCell.getPivotTable();
      Returns:
      The IPivotTable that contains this pivot cell, or the PivotTable associated with a PivotChart.

    • getRange

      IRange getRange()
      Returns a Range object that represents the range the specified PivotCell applies to. 
      
 IPivotValueCell valueCell = pivotTable.pivotValueCell(0, 0);
 IPivotCell pivotCell = valueCell.getPivotCell();
 IRange range = pivotCell.getRange();
      Returns:
      A Range object that represents the range the specified PivotCell applies to.