aspose.cells
Class PivotTableCollection

function getCount()

function get(index)

Gets the PivotTable report by index.

function get(name)

Gets the PivotTable report by pivottable's name.

function get(row, column)

Gets the PivotTable report by pivottable's position.

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.

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.

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.

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.

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.

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.

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.

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.

function clear()

Clear all pivot tables.

function remove(pivotTable)

Deletes the specified PivotTable

Parameters:

pivotTable: PivotTable - PivotTable object

function removeAt(index)

Deletes the PivotTable at the specified index

Parameters:

index: Number - the position index in PivotTable collection

function iterator()

function get(index)

Reserved for internal use.

function contains(value)

Reserved for internal use.

function add(value)

Reserved for internal use.

function indexOf(value)

Reserved for internal use.