Package org.apache.poi.xssf.usermodel

Class XSSFPivotTable

java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.xssf.usermodel.XSSFPivotTable
public class XSSFPivotTable extends POIXMLDocumentPart

  • Method Details

    • readFrom

      @Beta public void readFrom(InputStream is) throws IOException
      Throws:
      IOException

    • setPivotCache

      @Beta public void setPivotCache(XSSFPivotCache pivotCache)

    • getPivotCache

      @Beta public XSSFPivotCache getPivotCache()

    • getParentSheet

      @Beta public Sheet getParentSheet()

    • setParentSheet

      @Beta public void setParentSheet(XSSFSheet parentSheet)

    • getCTPivotTableDefinition

      @Beta @Internal public CTPivotTableDefinition getCTPivotTableDefinition()

    • setCTPivotTableDefinition

      @Beta @Internal public void setCTPivotTableDefinition(CTPivotTableDefinition pivotTableDefinition)

    • getPivotCacheDefinition

      @Beta public XSSFPivotCacheDefinition getPivotCacheDefinition()

    • setPivotCacheDefinition

      @Beta public void setPivotCacheDefinition(XSSFPivotCacheDefinition pivotCacheDefinition)

    • getPivotCacheRecords

      @Beta public XSSFPivotCacheRecords getPivotCacheRecords()

    • setPivotCacheRecords

      @Beta public void setPivotCacheRecords(XSSFPivotCacheRecords pivotCacheRecords)

    • getDataSheet

      @Beta public Sheet getDataSheet()

    • addRowLabel

      @Beta public void addRowLabel(int columnIndex)
      Add a row label using data from the given column.
      Parameters:
      columnIndex - the index of the source column to be used as row label. columnIndex is 0-based indexed and relative to the first column in the source.

    • getRowLabelColumns

      @Beta public List<Integer> getRowLabelColumns()

    • addColLabel

      @Beta public void addColLabel(int columnIndex, String valueFormat)
      Add a col label using data from the given column.
      Parameters:
      columnIndex - the index of the source column to be used as row label. columnIndex is 0-based indexed and relative to the first column in the source.
      valueFormat - format of column value (e.g. for date: "DD.MM.YYYY")

    • addColLabel

      @Beta public void addColLabel(int columnIndex)
      Add a col label using data from the given column.
      Parameters:
      columnIndex - the index of the source column to be used as row label. columnIndex is 0-based indexed and relative to the first column in the source.

    • getColLabelColumns

      @Beta public List<Integer> getColLabelColumns()

    • addColumnLabel

      @Beta public void addColumnLabel(DataConsolidateFunction function, int columnIndex, String valueFieldName, String valueFormat)
      Add a column label using data from the given column and specified function
      Parameters:
      function - the function to be used on the data The following functions exists: Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
      columnIndex - the index of the source column to be used as column label. columnIndex is 0-based indexed and relative to the first column in the source.
      valueFieldName - the name of pivot table value field
      valueFormat - format of value field (e.g. "#,##0.00")

    • addColumnLabel

      @Beta public void addColumnLabel(DataConsolidateFunction function, int columnIndex, String valueFieldName)
      Add a column label using data from the given column and specified function
      Parameters:
      function - the function to be used on the data The following functions exists: Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
      columnIndex - the index of the source column to be used as column label. columnIndex is 0-based indexed and relative to the first column in the source.
      valueFieldName - the name of pivot table value field

    • addColumnLabel

      @Beta public void addColumnLabel(DataConsolidateFunction function, int columnIndex)
      Add a column label using data from the given column and specified function
      Parameters:
      function - the function to be used on the data The following functions exists: Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
      columnIndex - the index of the source column to be used as column label columnIndex is 0-based indexed and relative to the first column in the source..

    • addDataColumn

      @Beta public void addDataColumn(int columnIndex, boolean isDataField)
      Add column containing data from the referenced area.
      Parameters:
      columnIndex - the index of the column containing the data
      isDataField - true if the data should be displayed in the pivot table.

    • addReportFilter

      @Beta public void addReportFilter(int columnIndex)
      Add filter for the column with the corresponding index and cell value
      Parameters:
      columnIndex - index of column to filter on