asposecells.api

asposecells.api

Class PivotTableCollection

Represents the collection of all the PivotTable objects on the specified worksheet.

Property Getters/Setters Summary
methodgetCount()
methodget(index)
Gets the PivotTable report by index.
methodget(row, column)
Gets the PivotTable report by pivottable's position.
methodget(name)
Gets the PivotTable report by pivottable's name.
 
Method Summary
methodadd(pivotTable, row, column, tableName)
Adds a new PivotTable Object to the collection from another PivotTable.
methodadd(pivotTable, destCellName, tableName)
Adds a new PivotTable Object to the collection from another PivotTable.
methodadd(value)
Reserved for internal use.
methodadd(sourceData, row, column, tableName)
Adds a new PivotTable cache to a PivotCaches collection.
methodadd(sourceData, row, column, tableName, useSameSource)
Adds a new PivotTable cache to a PivotCaches collection.
methodadd(sourceData, destCellName, tableName)
Adds a new PivotTable cache to a PivotCaches collection.
methodadd(sourceData, destCellName, tableName, useSameSource)
Adds a new PivotTable cache to a PivotCaches collection.
methodadd(sourceData, isAutoPage, pageFields, row, column, tableName)
Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.
methodadd(sourceData, isAutoPage, pageFields, destCellName, tableName)
Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.
methodclear()
Clear all pivot tables.
methodcontains(value)
Reserved for internal use.
methoddispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
methodget(index)
Reserved for internal use.
methodindexOf(value)
Reserved for internal use.
methoditerator()
methodremove(pivotTable)
Deletes the specified PivotTable and delete the PivotTable data
methodremove(pivotTable, keepData)
Deletes the specified PivotTable
methodremoveAt(index)
Deletes the PivotTable at the specified index and delete the PivotTable data
methodremoveAt(index, keepData)
Deletes the PivotTable at the specified index
 

    • Property Getters/Setters Detail

      • getCount : int 

        int getCount()

      • get : PivotTable 

        PivotTable get(row, column)
        Gets the PivotTable report by pivottable's position.

    • Method Detail

      • dispose

         dispose()
        Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

      • add

        int add(sourceData, destCellName, tableName)
        Adds a new PivotTable cache to a PivotCaches collection.
        Parameters:
        sourceData: String - The data for the new PivotTable cache.
        destCellName: String - The cell in the upper-left corner of the PivotTable report's destination range.
        tableName: String - The name of the new PivotTable report.
        Returns:
        The new added cache index.

      • add

        int add(sourceData, destCellName, tableName, useSameSource)
        Adds a new PivotTable cache to a PivotCaches collection.
        Parameters:
        sourceData: String - The data for the new PivotTable cache.
        destCellName: String - The cell in the upper-left corner of the PivotTable report's destination range.
        tableName: String - The name of the new PivotTable report.
        useSameSource: boolean - Indicates whether using same data source when another existing pivot table has used this data source. If the property is true, it will save memory.
        Returns:
        The new added cache index.

      • add

        int add(sourceData, row, column, tableName)
        Adds a new PivotTable cache to a PivotCaches collection.
        Parameters:
        sourceData: String - The data cell range for the new PivotTable.Example : Sheet1!A1:C8
        row: int - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
        column: int - Column index of the cell in the upper-left corner of the PivotTable report's destination range.
        tableName: String - The name of the new PivotTable report.
        Returns:
        The new added cache index.

      • add

        int add(sourceData, row, column, tableName, useSameSource)
        Adds a new PivotTable cache to a PivotCaches collection.
        Parameters:
        sourceData: String - The data cell range for the new PivotTable.Example : Sheet1!A1:C8
        row: int - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
        column: int - Column index of the cell in the upper-left corner of the PivotTable report's destination range.
        tableName: String - The name of the new PivotTable report.
        useSameSource: boolean - Indicates whether using same data source when another existing pivot table has used this data source. If the property is true, it will save memory.
        Returns:
        The new added cache index.

      • add

        int add(pivotTable, destCellName, tableName)
        Adds a new PivotTable Object to the collection from another PivotTable.
        Parameters:
        pivotTable: PivotTable - The source pivotTable.
        destCellName: String - The cell in the upper-left corner of the PivotTable report's destination range.
        tableName: String - The name of the new PivotTable report.
        Returns:
        The new added PivotTable index.

      • add

        int add(pivotTable, row, column, tableName)
        Adds a new PivotTable Object to the collection from another PivotTable.
        Parameters:
        pivotTable: PivotTable - The source pivotTable.
        row: int - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
        column: int - Column index of the cell in the upper-left corner of the PivotTable report's destination range.
        tableName: String - The name of the new PivotTable report.
        Returns:
        The new added PivotTable index.

      • add

        int add(sourceData, isAutoPage, pageFields, destCellName, tableName)
        Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.
        Parameters:
        sourceData: String[] - The multiple consolidation ranges,such as {"Sheet1!A1:C8","Sheet2!A1:B8"}
        isAutoPage: boolean - Whether auto create a single page field. If true,the following param pageFields will be ignored.
        pageFields: PivotPageFields - The pivot page field items.
        destCellName: String - destCellName The name of the new PivotTable report.
        tableName: String - the name of the new PivotTable report.
        Returns:
        The new added PivotTable index.

      • add

        int add(sourceData, isAutoPage, pageFields, row, column, tableName)
        Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.
        Parameters:
        sourceData: String[] - The multiple consolidation ranges,such as {"Sheet1!A1:C8","Sheet2!A1:B8"}
        isAutoPage: boolean - Whether auto create a single page field. If true,the following param pageFields will be ignored
        pageFields: PivotPageFields - The pivot page field items.
        row: int - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
        column: int - Column index of the cell in the upper-left corner of the PivotTable report's destination range.
        tableName: String - The name of the new PivotTable report.
        Returns:
        The new added PivotTable index.

      • clear

         clear()
        Clear all pivot tables.

      • remove

         remove(pivotTable)
        Deletes the specified PivotTable and delete the PivotTable data
        Parameters:
        pivotTable: PivotTable - PivotTable object

      • remove

         remove(pivotTable, keepData)
        Deletes the specified PivotTable
        Parameters:
        pivotTable: PivotTable - PivotTable object
        keepData: boolean - Whether to keep the PivotTable data

      • removeAt

         removeAt(index)
        Deletes the PivotTable at the specified index and delete the PivotTable data
        Parameters:
        index: int - the position index in PivotTable collection

      • removeAt

         removeAt(index, keepData)
        Deletes the PivotTable at the specified index
        Parameters:
        index: int - the position index in PivotTable collection
        keepData: boolean - Whether to keep the PivotTable data

      • iterator

        Iterator iterator()

      • get

        Object get(index)
        Reserved for internal use.

      • contains

        boolean contains(value)
        Reserved for internal use.

      • add

        int add(value)
        Reserved for internal use.

      • indexOf

        int indexOf(value)
        Reserved for internal use.