com.aspose.gridweb

Class GridPivotTable

java.lang.Object

com.aspose.gridweb.GridPivotTable

public class GridPivotTable
extends java.lang.Object

Represents a PivotTable report on a worksheet. The PivotTable object is a member of the GridPivotTable collection. The PivotTables collection contains all the PivotTable objects on a control.

Method Summary

Methods

Modifier and Type	Method and Description
int	addFieldToArea(int fieldType, int baseFieldIndex) Adds the field to the specific area.
int	addFieldToArea(int fieldType, java.lang.String fieldName) Adds the field to the specific area.
void	calculateData() Calculates pivottable's data to cells.
void	clearAllFields() clear all pivot fields.
GridPivotFieldCollection	fields(int fieldType) Gets the specific fields by the field type.
GridPivotField	fields(java.lang.String fieldName) Gets the specific field by the field name.
void	refreshData() Refreshes pivottable's data and setting from it's data source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fields

public GridPivotFieldCollection fields(int fieldType)

Gets the specific fields by the field type.

Parameters:

fieldType - GridPivotFieldType. the field type.

Returns:

the specific fields

fields

public GridPivotField fields(java.lang.String fieldName)

Gets the specific field by the field name.

Parameters:

fieldName - the field name.

Returns:

the specific field

clearAllFields

public void clearAllFields()

clear all pivot fields.

addFieldToArea

public int addFieldToArea(int fieldType,
                 int baseFieldIndex)

Adds the field to the specific area.

Parameters:

fieldType - GridPivotFieldType. The fields area type.

baseFieldIndex - The field index in the base fields.

Returns:

The field position in the specific fields.

addFieldToArea

public int addFieldToArea(int fieldType,
                 java.lang.String fieldName)

Adds the field to the specific area.

Parameters:

fieldType - GridPivotFieldType. The fields area type.

fieldName - The name in the base fields.

Returns:

The field position in the specific fields.If there is no field named as it, return -1.

refreshData

public void refreshData()

Refreshes pivottable's data and setting from it's data source.

Remarks

We will gather data from data source to a pivot cache ,then calcualte the data in the cache to the cells. This method is only used to gather all data to a pivot cache.

calculateData

public void calculateData()

Calculates pivottable's data to cells.

Remarks

Cell.Value in the pivot range could not return the correct result if the method is not been called. This method caclulates data with an inner pivot cache,not original data source. So if the data source is changed, please call RefreshData() method first.