Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class PivotTables

java.lang.Object
  extended by com.aspose.cells.PivotTables

public class PivotTables
extends java.lang.Object

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


Method Summary
 int add(PivotTable pivotTable, int row, int column, java.lang.String tableName)
          Adds a new PivotTable Object to the collection from another PivotTable.
 int add(PivotTable pivotTable, java.lang.String destCellName, java.lang.String tableName)
          Adds a new PivotTable Object to the collection from another PivotTable.
 int add(java.lang.String[] sourceData, boolean isAutoPage, PivotPageFields pageFields, int row, int column, java.lang.String tableName)
          Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.
 int add(java.lang.String[] sourceData, boolean isAutoPage, PivotPageFields pageFields, java.lang.String destCellName, java.lang.String tableName)
          Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.
 int add(java.lang.String sourceData, int row, int column, java.lang.String tableName)
          Adds a new PivotTable object to the collection.
 int add(java.lang.String sourceData, java.lang.String destCellName, java.lang.String tableName)
          Adds a new PivotTable object to the collection.
 PivotTable get(int index)
          Gets the PivotTable report by index.
 int size()
          Gets the number of the PivotTable reports in the worksheet.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

add

public int add(java.lang.String sourceData,
               java.lang.String destCellName,
               java.lang.String tableName)
Adds a new PivotTable object to the collection.

Parameters:
sourceData - The data cell range for the new PivotTable.Example : Sheet1!A1:C8
destCellName - The cell in the upper-left corner of the PivotTable report's destination range.
tableName - The name of the new PivotTable report.
Returns:
The new added PivotTable index.
Throws:
CellsException - if the worksheet has bean removed.

add

public int add(java.lang.String sourceData,
               int row,
               int column,
               java.lang.String tableName)
Adds a new PivotTable object to the collection.

Parameters:
sourceData - The data cell range for the new PivotTable.Example : Sheet1!A1:C8
row - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
column - Column index of the cell in the upper-left corner of the PivotTable report's destination range.
tableName - The name of the new PivotTable report.
Returns:
The new added PivotTable index.
Throws:
CellsException - if the worksheet has bean removed.

add

public int add(PivotTable pivotTable,
               java.lang.String destCellName,
               java.lang.String tableName)
Adds a new PivotTable Object to the collection from another PivotTable.

Parameters:
pivotTable - The source pivotTable.
destCellName - The cell in the upper-left corner of the PivotTable report's destination range.
tableName - The name of the new PivotTable report.
Returns:
The new added PivotTable index.

add

public int add(PivotTable pivotTable,
               int row,
               int column,
               java.lang.String tableName)
Adds a new PivotTable Object to the collection from another PivotTable.

Parameters:
pivotTable - The source pivotTable.
row - Row index of the cell in the upper-left corner of the PivotTable report's destination range.
column - Column index of the cell in the upper-left corner of the PivotTable report's destination range.
tableName - The name of the new PivotTable report.
Returns:
The new added PivotTable index.

add

public int add(java.lang.String[] sourceData,
               boolean isAutoPage,
               PivotPageFields pageFields,
               java.lang.String destCellName,
               java.lang.String tableName)
Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.

Parameters:
sourceData - The multiple consolidation ranges,such as {"Sheet1!A1:C8","Sheet2!A1:B8"}.
isAutoPage - Whether auto create a single page field. If true,the following param pageFields will be ignored.
pageFields - The pivot page field items.
destCellName - The name of the new PivotTable report.
tableName - the name of the new PivotTable report.
Returns:
The new added PivotTable index.

add

public int add(java.lang.String[] sourceData,
               boolean isAutoPage,
               PivotPageFields pageFields,
               int row,
               int column,
               java.lang.String tableName)
Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.

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

get

public PivotTable get(int index)
Gets the PivotTable report by index.

Parameters:
index - Index of the PivotTable object.
Returns:
the PivotTable object at the specified index.
Throws:
java.lang.IllegalArgumentException - if index is out of range.
CellsException - if the worksheet has bean removed.

size

public int size()
Gets the number of the PivotTable reports in the worksheet.

Returns:
The number of the PivotTable reports in the worksheet.
Throws:
CellsException - if the worksheet has bean removed.