Class XSSFPivotTable

    • Method Detail

      • readFrom

        @Beta
        public void readFrom​(java.io.InputStream is)
                      throws java.io.IOException
        Throws:
        java.io.IOException
      • getParentSheet

        @Beta
        public Sheet getParentSheet()
      • setParentSheet

        @Beta
        public void setParentSheet​(XSSFSheet parentSheet)
      • 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 java.util.List<java.lang.Integer> getRowLabelColumns()
      • addColLabel

        @Beta
        public void addColLabel​(int columnIndex,
                                java.lang.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 java.util.List<java.lang.Integer> getColLabelColumns()
      • addColumnLabel

        @Beta
        public void addColumnLabel​(DataConsolidateFunction function,
                                   int columnIndex,
                                   java.lang.String valueFieldName,
                                   java.lang.String valueFormat)
        Add a column label using data from the given column and specified function
        Parameters:
        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.
        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
        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,
                                   java.lang.String valueFieldName)
        Add a column label using data from the given column and specified function
        Parameters:
        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.
        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
        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:
        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..
        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
      • 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