aspose.cells

aspose.cells

Class PivotTableCollection

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

Property Getters/Setters Summary
functiongetCount()
functionget(index)
Gets the PivotTable report by index.
functionget(row, column)
Gets the PivotTable report by pivottable's position.
functionget(name)
Gets the PivotTable report by pivottable's name.
 
Method Summary
functionadd(pivotTable, row, column, tableName)
Adds a new PivotTable Object to the collection from another PivotTable.
functionadd(pivotTable, destCellName, tableName)
Adds a new PivotTable Object to the collection from another PivotTable.
functionadd(value)
Reserved for internal use.
functionadd(sourceData, row, column, tableName)
Adds a new PivotTable cache to a PivotCaches collection.
functionadd(sourceData, row, column, tableName, useSameSource)
Adds a new PivotTable cache to a PivotCaches collection.
functionadd(sourceData, destCellName, tableName)
Adds a new PivotTable cache to a PivotCaches collection.
functionadd(sourceData, destCellName, tableName, useSameSource)
Adds a new PivotTable cache to a PivotCaches collection.
functionadd(sourceData, isAutoPage, pageFields, row, column, tableName)
Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.
functionadd(sourceData, isAutoPage, pageFields, destCellName, tableName)
Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.
functionclear()
Clear all pivot tables.
functioncontains(value)
Reserved for internal use.
functiondispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
functionget(index)
Reserved for internal use.
functionindexOf(value)
Reserved for internal use.
functioniterator()
functionremove(pivotTable)
Deletes the specified PivotTable and delete the PivotTable data
functionremove(pivotTable, keepData)
Deletes the specified PivotTable
functionremoveAt(index)
Deletes the PivotTable at the specified index and delete the PivotTable data
functionremoveAt(index, keepData)
Deletes the PivotTable at the specified index
 

    • Property Getters/Setters Detail

      • getCount : Number 

        function getCount()

      • get : PivotTable 

        function get(index)
        Gets the PivotTable report by index.

      • get : PivotTable 

        function get(name)
        Gets the PivotTable report by pivottable's name.

      • get : PivotTable 

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

    • Method Detail

      • dispose

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

      • add

        function 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

        function 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

        function 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: Number - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
        column: Number - 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

        function 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: Number - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
        column: Number - 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

        function 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

        function add(pivotTable, row, column, tableName)
        Adds a new PivotTable Object to the collection from another PivotTable.
        Parameters:
        pivotTable: PivotTable - The source pivotTable.
        row: Number - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
        column: Number - 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

        function 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

        function 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: Number - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
        column: Number - 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

        function clear()
        Clear all pivot tables.

      • remove

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

      • remove

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

      • removeAt

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

      • removeAt

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

      • iterator

        function iterator()

      • get

        function get(index)
        Reserved for internal use.

      • contains

        function contains(value)
        Reserved for internal use.

      • add

        function add(value)
        Reserved for internal use.

      • indexOf

        function indexOf(value)
        Reserved for internal use.