AQPivotDataSet (OpenAPI)

```
public interface AQPivotDataSet
```
This interface provides a means to represent a AQDataSet in a pivot table.
Sorting is supported and can be applied to the following areas:
- columns containing values associated with pivot row fields,
- columns containing values associated with pivot data fields,
- columns containing grand total values,
- rows containing values associated with pivot column fields.
Please note that the sortDataColumn methods will override the sorting specification of the inner most row field in the pivot table.
When rendering in HTML, custom hyperlinks can be defined and attached to the most of cells contained in the pivot table. Trend charts can also be generated for values contained in each row. Please see AQDataSetSettings for more information.
An instance of the object that implements the AQPivotDataSet interface can be instantiated via aqua.data.newPivotDataSet() alias.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addColumnField(java.lang.String fieldName)` Adds a column field to the pivot table.
`void`	`addColumnFieldSubtotalCount(java.lang.String fieldName)` Includes showing subtotal as the number of records stored in the database for the specified field when it is defined as a column field.
`void`	`addColumnFieldSubtotalMax(java.lang.String fieldName)` Includes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a column field.
`void`	`addColumnFieldSubtotalMean(java.lang.String fieldName)` Includes showing subtotal as the average of all pivot values for the specified field when it is defined as a column field.
`void`	`addColumnFieldSubtotalMin(java.lang.String fieldName)` Includes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a column field.
`void`	`addColumnFieldSubtotalStdDev(java.lang.String fieldName)` Includes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a column field.
`void`	`addColumnFieldSubtotalSum(java.lang.String fieldName)` Includes showing subtotal as the sum of all pivot values for the specified field when it is defined as a column field.
`void`	`addColumnFieldSubtotalVar(java.lang.String fieldName)` Includes showing subtotal as the variance of all pivot values for the specified field when it is defined as a column field.
`void`	`addDataField(java.lang.String fieldName)` Adds a data field to the pivot table.
`void`	`addFieldSubtotalCount(java.lang.String fieldName)` Includes showing subtotal as the number of records stored in the database for the specified field when it is defined as either a row field or a column field.
`void`	`addFieldSubtotalMax(java.lang.String fieldName)` Includes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`addFieldSubtotalMean(java.lang.String fieldName)` Includes showing subtotal as the average of all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`addFieldSubtotalMin(java.lang.String fieldName)` Includes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`addFieldSubtotalStdDev(java.lang.String fieldName)` Includes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`addFieldSubtotalSum(java.lang.String fieldName)` Includes showing subtotal as the sum of all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`addFieldSubtotalVar(java.lang.String fieldName)` Includes showing subtotal as the variance of all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`addRowField(java.lang.String fieldName)` Adds a row field to the pivot table.
`void`	`addRowFieldSubtotalCount(java.lang.String fieldName)` Includes showing subtotal as the number of records stored in the database for the specified field when it is defined as a row field.
`void`	`addRowFieldSubtotalMax(java.lang.String fieldName)` Includes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a row field.
`void`	`addRowFieldSubtotalMean(java.lang.String fieldName)` Includes showing subtotal as the average of all pivot values for the specified field when it is defined as a row field.
`void`	`addRowFieldSubtotalMin(java.lang.String fieldName)` Includes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a row field.
`void`	`addRowFieldSubtotalStdDev(java.lang.String fieldName)` Includes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a row field.
`void`	`addRowFieldSubtotalSum(java.lang.String fieldName)` Includes showing subtotal as the sum of all pivot values for the specified field when it is defined as a row field.
`void`	`addRowFieldSubtotalVar(java.lang.String fieldName)` Includes showing subtotal as the variance of all pivot values for the specified field when it is defined as a row field.
`void`	`calculateGrid()` Calculates the pivot data.
`void`	`clearColumnFields()` Removes all of the column fields from the pivot table.
`void`	`clearColumnFieldSortOrderSettings()` Removes sorting related settings for all of the column fields.
`void`	`clearDataColumnSortSettings()` Removes sorting related settings for all data columns.
`void`	`clearDataFields()` Removes all of the data fields from the pivot table.
`void`	`clearDataFieldSummaryTypeSettings()` Removes summary type related settings for all data fields.
`void`	`clearGrandTotalColumnSortSettings()` Removes all sorting related settings on the grand total column.
`void`	`clearRowFields()` Removes all row fields from the pivot table.
`void`	`clearRowFieldSortOrderSettings()` Removes sorting related settings for all row fields.
`byte[]`	`getAsExcel2003()` Returns the pivot data as a byte array representing an Excel 2003 file.
`byte[]`	`getAsExcel2003(AQDataSetSettings settings, AQChart chart)` Returns the pivot data, with chart enabled, as a byte array representing an Excel 2003 file.
`byte[]`	`getAsExcel2007()` Returns the pivot data as a byte array representing an Excel 2007 file.
`byte[]`	`getAsExcel2007(AQDataSetSettings settings, AQChart chart)` Returns the pivot data, with chart enabled, as a byte array representing an Excel 2007 file.
`java.lang.String[]`	`getColumnFields()` Returns column field names as an array.
`java.lang.String[]`	`getDataFields()` Returns data field names as an array.
`AQDataSet`	`getDataSet()` Returns the application data used to create this pivot table.
`java.lang.String`	`getGrandTotalColumnSortName()` Returns the data field name used to sort the grand total column.
`java.lang.String[]`	`getRowFields()` Returns row field names as an array.
`int`	`getSortDataColumnIndex()` Returns the column index that is used for sorting on data column.
`boolean`	`isCalculated()` Returns true if the pivot data has been successfully calculated.
`boolean`	`isColumnFieldSortAscending(java.lang.String fieldName)` Returns true if the specified column field is sorted in ascending order.
`boolean`	`isColumnFieldSortDescending(java.lang.String fieldName)` Returns true if the specified column field is sorted in descending order.
`boolean`	`isColumnFieldSortNone(java.lang.String fieldName)` Returns true if the values that correspond to the specified column field are present in the order defined in the application data.
`boolean`	`isDataFieldSummaryCount(java.lang.String fieldName)` Returns true if the summary type of the specified data field is count which would show pivot grand total value as the number of records stored in the application data.
`boolean`	`isDataFieldSummaryCountD(java.lang.String fieldName)`
`boolean`	`isDataFieldSummaryMax(java.lang.String fieldName)` Returns true if the summary type of the specified data field is maximum which would show pivot grand total value as the maximum value amongst all pivot values.
`boolean`	`isDataFieldSummaryMean(java.lang.String fieldName)` Returns true if the summary type of the specified data field is mean which would show pivot grand total value as the average of all pivot values.
`boolean`	`isDataFieldSummaryMin(java.lang.String fieldName)` Returns true if the summary type of the specified data field is minimum which would show pivot grand total value as the minimum value amongst all pivot values.
`boolean`	`isDataFieldSummaryStdDev(java.lang.String fieldName)` Returns true if the summary type of the specified data field is standard deviation which would show pivot grand total value as the standard deviation of all pivot values.
`boolean`	`isDataFieldSummarySum(java.lang.String fieldName)` Returns true if the summary type of the specified data field is sum which would show pivot grand total value as the sum of all pivot values.
`boolean`	`isDataFieldSummaryVar(java.lang.String fieldName)` Returns true if the summary type of the specified data field is variance which would show pivot grand total value as the variance of all pivot values.
`boolean`	`isRowFieldSortAscending(java.lang.String fieldName)` Returns true if the specified row field is sorted in ascending order.
`boolean`	`isRowFieldSortDescending(java.lang.String fieldName)` Returns true if the specified row field is sorted in descending order.
`boolean`	`isRowFieldSortNone(java.lang.String fieldName)` Returns true if the values that correspond to the specified row field are present in the order defined in the application data.
`boolean`	`isShowGrandTotalForColumn()` Returns true if grand totals for columns will be displayed upon rendering.
`boolean`	`isShowGrandTotalForRow()` Returns true if grand totals for rows will be displayed upon rendering.
`boolean`	`isShowSubtotalForLastColumn()` Returns true if subtotal for the last column will be shown.
`boolean`	`isShowSubtotalForLastRow()` Returns true if subtotal for the last row will be shown.
`boolean`	`isShowSubtotalUsingSystemDefault()` Returns true if subtotals for rows and columns will be calculated using system default method.
`boolean`	`isSortByDataColumn()` Returns true if sorting on data column is defined.
`boolean`	`isSortByGrandTotalColumn()` Returns true if sorting on the grand total column is defined.
`boolean`	`isSortDataColumnAscending()` Returns true if sorting on data column is defined and is in ascending order.
`boolean`	`isSortDataColumnDescending()` Returns true if sorting on data column is defined and is in descending order.
`boolean`	`isSortGrandTotalColumnAscending()` Returns true if sorting on the grand total column is defined and is in ascending order.
`boolean`	`isSortGrandTotalColumnDescending()` Returns true if sorting on the grand total column is defined and is in descending order.
`void`	`removeColumnField(java.lang.String fieldName)` Removes a column field from the pivot table.
`void`	`removeColumnFieldSubtotalCount(java.lang.String fieldName)` Excludes showing subtotal as the number of records stored in the database for the specified field when it is defined as a column field.
`void`	`removeColumnFieldSubtotalMax(java.lang.String fieldName)` Excludes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a column field.
`void`	`removeColumnFieldSubtotalMean(java.lang.String fieldName)` Excludes showing subtotal as the average of all pivot values for the specified field when it is defined as a column field.
`void`	`removeColumnFieldSubtotalMin(java.lang.String fieldName)` Excludes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a column field.
`void`	`removeColumnFieldSubtotalStdDev(java.lang.String fieldName)` Excludes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a column field.
`void`	`removeColumnFieldSubtotalSum(java.lang.String fieldName)` Excludes showing subtotal as the sum of all pivot values for the specified field when it is defined as a column field.
`void`	`removeColumnFieldSubtotalVar(java.lang.String fieldName)` Excludes showing subtotal as the variance of all pivot values for the specified field when it is defined as a column field.
`void`	`removeDataField(java.lang.String fieldName)` Removes a data field from the pivot table.
`void`	`removeFieldSubtotalCount(java.lang.String fieldName)` Excludes showing subtotal as the number of records stored in the database for the specified field when it is defined as either a row field or a column field.
`void`	`removeFieldSubtotalMax(java.lang.String fieldName)` Excludes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`removeFieldSubtotalMean(java.lang.String fieldName)` Excludes showing subtotal as the average of all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`removeFieldSubtotalMin(java.lang.String fieldName)` Excludes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`removeFieldSubtotalStdDev(java.lang.String fieldName)` Excludes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`removeFieldSubtotalSum(java.lang.String fieldName)` Excludes showing subtotal as the sum of all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`removeFieldSubtotalVar(java.lang.String fieldName)` Excludes showing subtotal as the variance of all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`removeRowField(java.lang.String fieldName)` Removes a row field from the pivot table.
`void`	`removeRowFieldSubtotalCount(java.lang.String fieldName)` Excludes showing subtotal as the number of records stored in the database for the specified field when it is defined as a row field.
`void`	`removeRowFieldSubtotalMax(java.lang.String fieldName)` Excludes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a row field.
`void`	`removeRowFieldSubtotalMean(java.lang.String fieldName)` Excludes showing subtotal as the average of all pivot values for the specified field when it is defined as a row field.
`void`	`removeRowFieldSubtotalMin(java.lang.String fieldName)` Excludes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a row field.
`void`	`removeRowFieldSubtotalStdDev(java.lang.String fieldName)` Excludes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a row field.
`void`	`removeRowFieldSubtotalSum(java.lang.String fieldName)` Excludes showing subtotal as the sum of all pivot values for the specified field when it is defined as a row field.
`void`	`removeRowFieldSubtotalVar(java.lang.String fieldName)` Excludes showing subtotal as the variance of all pivot values for the specified field when it is defined as a row field.
`java.lang.String`	`renderHtml()` Converts the pivot data to a HTML document using the default grid `settings`.
`java.lang.String`	`renderHtml(AQDataSetSettings settings)` Converts the pivot data to a HTML document using the specified grid `settings`.
`java.lang.String`	`renderHtml(AQDataSetSettings settings, AQChart chart)` Converts the pivot data to a HTML document, with chart enabled, using the specified grid `settings`.
`java.lang.String`	`renderText()` Converts the pivot data to a formatted plain text grid using the default `grid settings`.
`java.lang.String`	`renderText(AQDataSetSettings settings)` Converts the pivot data to a formatted plain text grid using the specified grid `settings`.
`java.lang.String`	`renderText(int lineCount)` Converts the pivot data, up to `lineCount` rows, to a formatted plain text grid using the default `grid settings`.
`void`	`saveAsExcel2003(java.lang.String fileName)` Saves the pivot data as an Excel 2003 file.
`void`	`saveAsExcel2003(java.lang.String fileName, AQDataSetSettings settings, AQChart chart)` Saves the pivot data, with chart enabled, as an Excel 2003 file.
`void`	`saveAsExcel2007(java.lang.String fileName)` Saves the pivot data as an Excel 2007 file.
`void`	`saveAsExcel2007(java.lang.String fileName, AQDataSetSettings settings, AQChart chart)` Saves the pivot data, with chart enabled, as an Excel 2007 file.
`void`	`setColumnFieldSortAscending(java.lang.String fieldName)` Sorts a column field in ascending order.
`void`	`setColumnFieldSortDescending(java.lang.String fieldName)` Sorts a column field in descending order.
`void`	`setColumnFieldSortNone(java.lang.String fieldName)` Sorts the values that correspond to a column field in the order defined in the application data.
`void`	`setColumnFieldSubtotalCount(java.lang.String fieldName)` Shows subtotal as the number of records stored in the database for the specified field when it is defined as a column field.
`void`	`setColumnFieldSubtotalDefault(java.lang.String fieldName)` Shows subtotal using system default calculation method for the specified field when it is defined as a column field.
`void`	`setColumnFieldSubtotalMax(java.lang.String fieldName)` Shows subtotal as the maximum value among all pivot values for the specified field when it is defined as a column field.
`void`	`setColumnFieldSubtotalMean(java.lang.String fieldName)` Shows subtotal as the average of all pivot values for the specified field when it is defined as a column field.
`void`	`setColumnFieldSubtotalMin(java.lang.String fieldName)` Shows subtotal as the minimum value among all pivot values for the specified field when it is defined as a column field.
`void`	`setColumnFieldSubtotalNone(java.lang.String fieldName)` Hides subtotal for the specified field when it is defined as a column field.
`void`	`setColumnFieldSubtotalStdDev(java.lang.String fieldName)` Shows subtotal as the standard deviation of all pivot values for the specified field when it is defined as a column field.
`void`	`setColumnFieldSubtotalSum(java.lang.String fieldName)` Shows subtotal as the sum of all pivot values for the specified field when it is defined as a column field.
`void`	`setColumnFieldSubtotalVar(java.lang.String fieldName)` Shows subtotal as the variance of all pivot values for the specified field when it is defined as a column field.
`void`	`setDataFieldSummaryCount(java.lang.String fieldName)` Sets the summary type for a data field to count which would show pivot grand total value as the number of records stored in the application data.
`void`	`setDataFieldSummaryMax(java.lang.String fieldName)` Sets the summary type for a data field to maximum which would show pivot grand total value as the maximum value amongst all pivot values.
`void`	`setDataFieldSummaryMean(java.lang.String fieldName)` Sets the summary type for a data field to mean which would show pivot grand total value as the average of all pivot values.
`void`	`setDataFieldSummaryMedian(java.lang.String fieldName)` Sets the summary type for a data field to median which would show pivot grand total value as the sum of all pivot values.
`void`	`setDataFieldSummaryMin(java.lang.String fieldName)` Sets the summary type for a data field to minimum which would show pivot grand total value as the minimum value amongst all pivot values.
`void`	`setDataFieldSummaryStdDev(java.lang.String fieldName)` Sets the summary type for a data field to standard deviation which would show pivot grand total value as the standard deviation of all pivot values.
`void`	`setDataFieldSummarySum(java.lang.String fieldName)` Sets the summary type for a data field to sum which would show pivot grand total value as the sum of all pivot values.
`void`	`setDataFieldSummaryVar(java.lang.String fieldName)` Sets the summary type for a data field to variance which would show pivot grand total value as the variance of all pivot values.
`void`	`setDataSet(AQDataSet dataSet)` Sets the application data to be presented in the pivot table.
`void`	`setFieldSubtotalCount(java.lang.String fieldName)` Shows subtotal as the number of records stored in the database for the specified field when it is defined as either a row field or a column field.
`void`	`setFieldSubtotalDefault(java.lang.String fieldName)` Shows subtotal using system default calculation method for the specified field when it is defined as either a row field or a column field.
`void`	`setFieldSubtotalMax(java.lang.String fieldName)` Shows subtotal as the maximum value among all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`setFieldSubtotalMean(java.lang.String fieldName)` Shows subtotal as the average of all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`setFieldSubtotalMedian(java.lang.String fieldName)` Shows subtotal as the median value among all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`setFieldSubtotalMin(java.lang.String fieldName)` Shows subtotal as the minimum value among all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`setFieldSubtotalNone(java.lang.String fieldName)` Hides subtotal for the specified field when it is defined as either a row field or a column field.
`void`	`setFieldSubtotalStdDev(java.lang.String fieldName)` Shows subtotal as the standard deviation of all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`setFieldSubtotalSum(java.lang.String fieldName)` Shows subtotal as the sum of all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`setFieldSubtotalVar(java.lang.String fieldName)` Shows subtotal as the variance of all pivot values for the specified field when it is defined as either a row field or a column field.
`void`	`setRowFieldSortAscending(java.lang.String fieldName)` Sorts a row field in ascending order.
`void`	`setRowFieldSortDescending(java.lang.String fieldName)` Sorts a row field in descending order.
`void`	`setRowFieldSortNone(java.lang.String fieldName)` Sorts the values that correspond to a row field in the order defined in the application data.
`void`	`setRowFieldSubtotalCount(java.lang.String fieldName)` Shows subtotal as the number of records stored in the database for the specified field when it is defined as a row field.
`void`	`setRowFieldSubtotalDefault(java.lang.String fieldName)` Shows subtotal using system default calculation method for the specified field when it is defined as a row field.
`void`	`setRowFieldSubtotalMax(java.lang.String fieldName)` Shows subtotal as the maximum value among all pivot values for the specified field when it is defined as a row field.
`void`	`setRowFieldSubtotalMean(java.lang.String fieldName)` Shows subtotal as the average of all pivot values for the specified field when it is defined as a row field.
`void`	`setRowFieldSubtotalMin(java.lang.String fieldName)` Shows subtotal as the minimum value among all pivot values for the specified field when it is defined as a row field.
`void`	`setRowFieldSubtotalNone(java.lang.String fieldName)` Hides subtotal for the specified field when it is defined as a row field.
`void`	`setRowFieldSubtotalStdDev(java.lang.String fieldName)` Shows subtotal as the standard deviation of all pivot values for the specified field when it is defined as a row field.
`void`	`setRowFieldSubtotalSum(java.lang.String fieldName)` Shows subtotal as the sum of all pivot values for the specified field when it is defined as a row field.
`void`	`setRowFieldSubtotalVar(java.lang.String fieldName)` Shows subtotal as the variance of all pivot values for the specified field when it is defined as a row field.
`void`	`setShowSubtotal(boolean flag)` Shows subtotals for rows and columns using system default calculation method, or clears previous subtotal settings for all of rows and columns.
`void`	`setShowSubtotalForLastColumn(boolean flag)` Shows or hides the subtotal for the last column.
`void`	`setShowSubtotalForLastRow(boolean flag)` Shows or hides the subtotal for the last row.
`void`	`setShowSubtotalForLastRowAndColumn(boolean flag)` Shows or hides subtotals for the last row and the last column.
`void`	`sortDataColumnAscending(int columnIndex)` Sorts pivot values belong to the specified column in ascending order.
`void`	`sortDataColumnDescending(int columnIndex)` Sorts pivot values belong to the specified column in descending order.
`void`	`sortGrandTotalColumnAscending(java.lang.String dataFieldName)` Sorts values belong to the grand total column associated with the specified data field in ascending order.
`void`	`sortGrandTotalColumnDescending(java.lang.String dataFieldName)` Sorts values belong to the grand total column associated with the specified data field in descending order.
`void`	`unsetColumnFieldSortOrder(java.lang.String fieldName)` Unsets the sorting order corresponding to the specified column field.
`void`	`unsetDataFieldSummaryType(java.lang.String fieldName)` Unsets the summary type corresponding to the specified data field.
`void`	`unsetRowFieldSortOrder(java.lang.String fieldName)` Unsets the sorting order corresponding to the specified row field.

- Method Detail
  - setDataSet
```
void setDataSet(AQDataSet dataSet)
```
    Sets the application data to be presented in the pivot table.
    
    Parameters:
    
    dataSet - the application data
  - getDataSet
```
AQDataSet getDataSet()
```
    Returns the application data used to create this pivot table.
    
    Returns:
    
    the application data used to create this pivot table
  - isShowGrandTotalForRow
```
boolean isShowGrandTotalForRow()
```
    Returns true if grand totals for rows will be displayed upon rendering.
    
    Returns:
    
    true if to show grand totals for rows.
  - isShowGrandTotalForColumn
```
boolean isShowGrandTotalForColumn()
```
    Returns true if grand totals for columns will be displayed upon rendering.
    
    Returns:
    
    true if to show grand totals for columns.
  - addRowField
```
void addRowField(java.lang.String fieldName)
```
    Adds a row field to the pivot table.
    
    Parameters:
    
    fieldName - the name of the row field to be added
  - removeRowField
```
void removeRowField(java.lang.String fieldName)
```
    Removes a row field from the pivot table.
    
    Parameters:
    
    fieldName - the name of the row field to be removed
  - getRowFields
```
java.lang.String[] getRowFields()
```
    Returns row field names as an array.
    
    Returns:
    
    an array of row field names, or an empty array if no row fields defined.
  - clearRowFields
```
void clearRowFields()
```
    Removes all row fields from the pivot table.
  - addColumnField
```
void addColumnField(java.lang.String fieldName)
```
    Adds a column field to the pivot table.
    
    Parameters:
    
    fieldName - the name of the column field to be added
  - removeColumnField
```
void removeColumnField(java.lang.String fieldName)
```
    Removes a column field from the pivot table.
    
    Parameters:
    
    fieldName - the name of the column field to be removed
  - getColumnFields
```
java.lang.String[] getColumnFields()
```
    Returns column field names as an array.
    
    Returns:
    
    an array of column field names, or an empty array if no column fields defined.
  - clearColumnFields
```
void clearColumnFields()
```
    Removes all of the column fields from the pivot table.
  - addDataField
```
void addDataField(java.lang.String fieldName)
```
    Adds a data field to the pivot table.
    
    Parameters:
    
    fieldName - the name of the data field to be added
  - removeDataField
```
void removeDataField(java.lang.String fieldName)
```
    Removes a data field from the pivot table.
    
    Parameters:
    
    fieldName - the name of the data field to be removed
  - getDataFields
```
java.lang.String[] getDataFields()
```
    Returns data field names as an array.
    
    Returns:
    
    an array of data field names, or an empty array if no data fields defined.
  - clearDataFields
```
void clearDataFields()
```
    Removes all of the data fields from the pivot table.
  - setRowFieldSortAscending
```
void setRowFieldSortAscending(java.lang.String fieldName)
```
    Sorts a row field in ascending order. This method will override the column sorting setting defined by data column and grand total column if the field name specified is the last row field.
    
    Parameters:
    
    fieldName - the name of the row field to which sorting order to be set
  - setRowFieldSortDescending
```
void setRowFieldSortDescending(java.lang.String fieldName)
```
    Sorts a row field in descending order. This method will override the column sorting setting defined by data column and grand total column if the field name specified is the last row field.
    
    Parameters:
    
    fieldName - the name of the row field to which sorting order to be set
  - setRowFieldSortNone
```
void setRowFieldSortNone(java.lang.String fieldName)
```
    Sorts the values that correspond to a row field in the order defined in the application data. This method will override the column sorting setting defined by data column and grand total column if the field name specified is the last row field.
    
    Parameters:
    
    fieldName - the name of the row field to which sorting order to be set
  - isRowFieldSortAscending
```
boolean isRowFieldSortAscending(java.lang.String fieldName)
```
    Returns true if the specified row field is sorted in ascending order.
    
    Parameters:
    
    fieldName - the name of the row field
    
    Returns:
    
    true if sorted in ascending order
  - isRowFieldSortDescending
```
boolean isRowFieldSortDescending(java.lang.String fieldName)
```
    Returns true if the specified row field is sorted in descending order.
    
    Parameters:
    
    fieldName - the name of the row field
    
    Returns:
    
    true if sorted in descending order
  - isRowFieldSortNone
```
boolean isRowFieldSortNone(java.lang.String fieldName)
```
    Returns true if the values that correspond to the specified row field are present in the order defined in the application data.
    
    Parameters:
    
    fieldName - the name of the row field
    
    Returns:
    
    true if corresponding values are present in the order defined in the application data
  - unsetRowFieldSortOrder
```
void unsetRowFieldSortOrder(java.lang.String fieldName)
```
    Unsets the sorting order corresponding to the specified row field. Row fields are sorted in ascending order by default if custom settings are not defined.
    
    Parameters:
    
    fieldName - the name of the row field from which sorting order to be unset
  - clearRowFieldSortOrderSettings
```
void clearRowFieldSortOrderSettings()
```
    Removes sorting related settings for all row fields.
  - setColumnFieldSortAscending
```
void setColumnFieldSortAscending(java.lang.String fieldName)
```
    Sorts a column field in ascending order.
    
    Parameters:
    
    fieldName - the name of the column field to which sorting order to be set
  - setColumnFieldSortDescending
```
void setColumnFieldSortDescending(java.lang.String fieldName)
```
    Sorts a column field in descending order.
    
    Parameters:
    
    fieldName - the name of the column field to which sorting order to be set
  - setColumnFieldSortNone
```
void setColumnFieldSortNone(java.lang.String fieldName)
```
    Sorts the values that correspond to a column field in the order defined in the application data.
    
    Parameters:
    
    fieldName - the name of the column field to which sorting order to be set
  - isColumnFieldSortAscending
```
boolean isColumnFieldSortAscending(java.lang.String fieldName)
```
    Returns true if the specified column field is sorted in ascending order.
    
    Parameters:
    
    fieldName - the name of the column field
    
    Returns:
    
    true if sorted in ascending order
  - isColumnFieldSortDescending
```
boolean isColumnFieldSortDescending(java.lang.String fieldName)
```
    Returns true if the specified column field is sorted in descending order.
    
    Parameters:
    
    fieldName - the name of the column field
    
    Returns:
    
    true if sorted in descending order
  - isColumnFieldSortNone
```
boolean isColumnFieldSortNone(java.lang.String fieldName)
```
    Returns true if the values that correspond to the specified column field are present in the order defined in the application data.
    
    Parameters:
    
    fieldName - the name of the column field
    
    Returns:
    
    true if corresponding values are present in the order defined in the application data
  - unsetColumnFieldSortOrder
```
void unsetColumnFieldSortOrder(java.lang.String fieldName)
```
    Unsets the sorting order corresponding to the specified column field. Column fields are sorted in ascending order by default if custom settings are not defined.
    
    Parameters:
    
    fieldName - the name of the column field from which sorting order to be unset
  - clearColumnFieldSortOrderSettings
```
void clearColumnFieldSortOrderSettings()
```
    Removes sorting related settings for all of the column fields.
  - sortGrandTotalColumnAscending
```
void sortGrandTotalColumnAscending(java.lang.String dataFieldName)
```
    Sorts values belong to the grand total column associated with the specified data field in ascending order. If the specified dataFieldName is an empty string, i.e. a string with length equals zero, then all of values contained in the grand total column will be sorted in ascending order if there are no data fields defined. This method will override the column sorting setting defined by data column and disable the sorting on the last row field.
    
    Parameters:
    
    dataFieldName - the data field name
  - sortGrandTotalColumnDescending
```
void sortGrandTotalColumnDescending(java.lang.String dataFieldName)
```
    Sorts values belong to the grand total column associated with the specified data field in descending order. If the specified dataFieldName is an empty string, i.e. a string with length equals zero, then all of values contained in the grand total column will be sorted in descending order if there are no data fields defined. This method will override the column sorting setting defined by data column and disable the sorting on the last row field.
    
    Parameters:
    
    dataFieldName - the data field name
  - isSortByGrandTotalColumn
```
boolean isSortByGrandTotalColumn()
```
    Returns true if sorting on the grand total column is defined.
    
    Returns:
    
    true if sorting on the grand total column is defined.
  - isSortGrandTotalColumnAscending
```
boolean isSortGrandTotalColumnAscending()
```
    Returns true if sorting on the grand total column is defined and is in ascending order. Note that this method cannot be used alone to determine whether sorting on the grand total column is defined and is in descending order.
    
    Returns:
    
    true if sorting on the grand total column is defined and is in ascending order
  - isSortGrandTotalColumnDescending
```
boolean isSortGrandTotalColumnDescending()
```
    Returns true if sorting on the grand total column is defined and is in descending order. Note that this method cannot be used alone to determine whether sorting on the grand total column is defined and is in ascending order.
    
    Returns:
    
    true if sorting on the grand total column is defined and is in descending order
  - getGrandTotalColumnSortName
```
java.lang.String getGrandTotalColumnSortName()
```
    Returns the data field name used to sort the grand total column.
    
    Returns:
    
    the data field name used to sort the grand total column if sorting on the grand total column is defined; otherwise, null is returned
  - clearGrandTotalColumnSortSettings
```
void clearGrandTotalColumnSortSettings()
```
    Removes all sorting related settings on the grand total column.
  - setShowSubtotal
```
void setShowSubtotal(boolean flag)
```
    Shows subtotals for rows and columns using system default calculation method, or clears previous subtotal settings for all of rows and columns. The default method used to calculate subtotal would calculate the sum of all pivot values. Subtotals are not displayed by default.
    
    Parameters:
    
    flag - the boolean value that determines whether to show or clear subtotals
  - isShowSubtotalUsingSystemDefault
```
boolean isShowSubtotalUsingSystemDefault()
```
    Returns true if subtotals for rows and columns will be calculated using system default method.
    
    Returns:
    
    true if to calculate subtotals for rows and columns using system default method
  - setShowSubtotalForLastRowAndColumn
```
void setShowSubtotalForLastRowAndColumn(boolean flag)
```
    Shows or hides subtotals for the last row and the last column. By default, subtotals for the last row and the last column are not shown.
    
    Parameters:
    
    flag - the boolean value that determines whether to show or hide subtotals for the last row and the last column
  - setShowSubtotalForLastRow
```
void setShowSubtotalForLastRow(boolean flag)
```
    Shows or hides the subtotal for the last row. By default, the subtotal for the last row is not shown.
    
    Parameters:
    
    flag - the boolean value that determines whether to show or hide the subtotal for the last row
  - setShowSubtotalForLastColumn
```
void setShowSubtotalForLastColumn(boolean flag)
```
    Shows or hides the subtotal for the last column. By default, the subtotal for the last column is not shown.
    
    Parameters:
    
    flag - the boolean value that determines whether to show or hide the subtotal for the last column
  - isShowSubtotalForLastRow
```
boolean isShowSubtotalForLastRow()
```
    Returns true if subtotal for the last row will be shown.
    
    Returns:
    
    true if subtotal for the last row will be shown.
  - isShowSubtotalForLastColumn
```
boolean isShowSubtotalForLastColumn()
```
    Returns true if subtotal for the last column will be shown.
    
    Returns:
    
    true if subtotal for the last column will be shown.
  - setFieldSubtotalNone
```
void setFieldSubtotalNone(java.lang.String fieldName)
```
    Hides subtotal for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - setFieldSubtotalDefault
```
void setFieldSubtotalDefault(java.lang.String fieldName)
```
    Shows subtotal using system default calculation method for the specified field when it is defined as either a row field or a column field. The default method used to calculate subtotal would calculate the sum of all pivot values.
    
    Parameters:
    
    fieldName - the field name
  - setFieldSubtotalSum
```
void setFieldSubtotalSum(java.lang.String fieldName)
```
    Shows subtotal as the sum of all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - setFieldSubtotalMedian
```
void setFieldSubtotalMedian(java.lang.String fieldName)
```
    Shows subtotal as the median value among all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - setFieldSubtotalMax
```
void setFieldSubtotalMax(java.lang.String fieldName)
```
    Shows subtotal as the maximum value among all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - setFieldSubtotalMin
```
void setFieldSubtotalMin(java.lang.String fieldName)
```
    Shows subtotal as the minimum value among all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - setFieldSubtotalMean
```
void setFieldSubtotalMean(java.lang.String fieldName)
```
    Shows subtotal as the average of all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - setFieldSubtotalVar
```
void setFieldSubtotalVar(java.lang.String fieldName)
```
    Shows subtotal as the variance of all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - setFieldSubtotalStdDev
```
void setFieldSubtotalStdDev(java.lang.String fieldName)
```
    Shows subtotal as the standard deviation of all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - setFieldSubtotalCount
```
void setFieldSubtotalCount(java.lang.String fieldName)
```
    Shows subtotal as the number of records stored in the database for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - addFieldSubtotalSum
```
void addFieldSubtotalSum(java.lang.String fieldName)
```
    Includes showing subtotal as the sum of all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - addFieldSubtotalMax
```
void addFieldSubtotalMax(java.lang.String fieldName)
```
    Includes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - addFieldSubtotalMin
```
void addFieldSubtotalMin(java.lang.String fieldName)
```
    Includes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - addFieldSubtotalMean
```
void addFieldSubtotalMean(java.lang.String fieldName)
```
    Includes showing subtotal as the average of all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - addFieldSubtotalVar
```
void addFieldSubtotalVar(java.lang.String fieldName)
```
    Includes showing subtotal as the variance of all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - addFieldSubtotalStdDev
```
void addFieldSubtotalStdDev(java.lang.String fieldName)
```
    Includes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - addFieldSubtotalCount
```
void addFieldSubtotalCount(java.lang.String fieldName)
```
    Includes showing subtotal as the number of records stored in the database for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeFieldSubtotalSum
```
void removeFieldSubtotalSum(java.lang.String fieldName)
```
    Excludes showing subtotal as the sum of all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeFieldSubtotalMax
```
void removeFieldSubtotalMax(java.lang.String fieldName)
```
    Excludes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeFieldSubtotalMin
```
void removeFieldSubtotalMin(java.lang.String fieldName)
```
    Excludes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeFieldSubtotalMean
```
void removeFieldSubtotalMean(java.lang.String fieldName)
```
    Excludes showing subtotal as the average of all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeFieldSubtotalVar
```
void removeFieldSubtotalVar(java.lang.String fieldName)
```
    Excludes showing subtotal as the variance of all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeFieldSubtotalStdDev
```
void removeFieldSubtotalStdDev(java.lang.String fieldName)
```
    Excludes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeFieldSubtotalCount
```
void removeFieldSubtotalCount(java.lang.String fieldName)
```
    Excludes showing subtotal as the number of records stored in the database for the specified field when it is defined as either a row field or a column field.
    
    Parameters:
    
    fieldName - the field name
  - setRowFieldSubtotalNone
```
void setRowFieldSubtotalNone(java.lang.String fieldName)
```
    Hides subtotal for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - setRowFieldSubtotalDefault
```
void setRowFieldSubtotalDefault(java.lang.String fieldName)
```
    Shows subtotal using system default calculation method for the specified field when it is defined as a row field. The default method used to calculate subtotal would calculate the sum of all pivot values.
    
    Parameters:
    
    fieldName - the field name
  - setRowFieldSubtotalSum
```
void setRowFieldSubtotalSum(java.lang.String fieldName)
```
    Shows subtotal as the sum of all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - setRowFieldSubtotalMax
```
void setRowFieldSubtotalMax(java.lang.String fieldName)
```
    Shows subtotal as the maximum value among all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - setRowFieldSubtotalMin
```
void setRowFieldSubtotalMin(java.lang.String fieldName)
```
    Shows subtotal as the minimum value among all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - setRowFieldSubtotalMean
```
void setRowFieldSubtotalMean(java.lang.String fieldName)
```
    Shows subtotal as the average of all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - setRowFieldSubtotalVar
```
void setRowFieldSubtotalVar(java.lang.String fieldName)
```
    Shows subtotal as the variance of all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - setRowFieldSubtotalStdDev
```
void setRowFieldSubtotalStdDev(java.lang.String fieldName)
```
    Shows subtotal as the standard deviation of all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - setRowFieldSubtotalCount
```
void setRowFieldSubtotalCount(java.lang.String fieldName)
```
    Shows subtotal as the number of records stored in the database for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - addRowFieldSubtotalSum
```
void addRowFieldSubtotalSum(java.lang.String fieldName)
```
    Includes showing subtotal as the sum of all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - addRowFieldSubtotalMax
```
void addRowFieldSubtotalMax(java.lang.String fieldName)
```
    Includes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - addRowFieldSubtotalMin
```
void addRowFieldSubtotalMin(java.lang.String fieldName)
```
    Includes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - addRowFieldSubtotalMean
```
void addRowFieldSubtotalMean(java.lang.String fieldName)
```
    Includes showing subtotal as the average of all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - addRowFieldSubtotalVar
```
void addRowFieldSubtotalVar(java.lang.String fieldName)
```
    Includes showing subtotal as the variance of all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - addRowFieldSubtotalStdDev
```
void addRowFieldSubtotalStdDev(java.lang.String fieldName)
```
    Includes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - addRowFieldSubtotalCount
```
void addRowFieldSubtotalCount(java.lang.String fieldName)
```
    Includes showing subtotal as the number of records stored in the database for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - removeRowFieldSubtotalSum
```
void removeRowFieldSubtotalSum(java.lang.String fieldName)
```
    Excludes showing subtotal as the sum of all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - removeRowFieldSubtotalMax
```
void removeRowFieldSubtotalMax(java.lang.String fieldName)
```
    Excludes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - removeRowFieldSubtotalMin
```
void removeRowFieldSubtotalMin(java.lang.String fieldName)
```
    Excludes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - removeRowFieldSubtotalMean
```
void removeRowFieldSubtotalMean(java.lang.String fieldName)
```
    Excludes showing subtotal as the average of all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - removeRowFieldSubtotalVar
```
void removeRowFieldSubtotalVar(java.lang.String fieldName)
```
    Excludes showing subtotal as the variance of all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - removeRowFieldSubtotalStdDev
```
void removeRowFieldSubtotalStdDev(java.lang.String fieldName)
```
    Excludes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - removeRowFieldSubtotalCount
```
void removeRowFieldSubtotalCount(java.lang.String fieldName)
```
    Excludes showing subtotal as the number of records stored in the database for the specified field when it is defined as a row field.
    
    Parameters:
    
    fieldName - the field name
  - setColumnFieldSubtotalNone
```
void setColumnFieldSubtotalNone(java.lang.String fieldName)
```
    Hides subtotal for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - setColumnFieldSubtotalDefault
```
void setColumnFieldSubtotalDefault(java.lang.String fieldName)
```
    Shows subtotal using system default calculation method for the specified field when it is defined as a column field. The default method used to calculate subtotal would calculate the sum of all pivot values.
    
    Parameters:
    
    fieldName - the field name
  - setColumnFieldSubtotalSum
```
void setColumnFieldSubtotalSum(java.lang.String fieldName)
```
    Shows subtotal as the sum of all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - setColumnFieldSubtotalMax
```
void setColumnFieldSubtotalMax(java.lang.String fieldName)
```
    Shows subtotal as the maximum value among all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - setColumnFieldSubtotalMin
```
void setColumnFieldSubtotalMin(java.lang.String fieldName)
```
    Shows subtotal as the minimum value among all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - setColumnFieldSubtotalMean
```
void setColumnFieldSubtotalMean(java.lang.String fieldName)
```
    Shows subtotal as the average of all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - setColumnFieldSubtotalVar
```
void setColumnFieldSubtotalVar(java.lang.String fieldName)
```
    Shows subtotal as the variance of all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - setColumnFieldSubtotalStdDev
```
void setColumnFieldSubtotalStdDev(java.lang.String fieldName)
```
    Shows subtotal as the standard deviation of all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - setColumnFieldSubtotalCount
```
void setColumnFieldSubtotalCount(java.lang.String fieldName)
```
    Shows subtotal as the number of records stored in the database for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - addColumnFieldSubtotalSum
```
void addColumnFieldSubtotalSum(java.lang.String fieldName)
```
    Includes showing subtotal as the sum of all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - addColumnFieldSubtotalMax
```
void addColumnFieldSubtotalMax(java.lang.String fieldName)
```
    Includes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - addColumnFieldSubtotalMin
```
void addColumnFieldSubtotalMin(java.lang.String fieldName)
```
    Includes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - addColumnFieldSubtotalMean
```
void addColumnFieldSubtotalMean(java.lang.String fieldName)
```
    Includes showing subtotal as the average of all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - addColumnFieldSubtotalVar
```
void addColumnFieldSubtotalVar(java.lang.String fieldName)
```
    Includes showing subtotal as the variance of all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - addColumnFieldSubtotalStdDev
```
void addColumnFieldSubtotalStdDev(java.lang.String fieldName)
```
    Includes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - addColumnFieldSubtotalCount
```
void addColumnFieldSubtotalCount(java.lang.String fieldName)
```
    Includes showing subtotal as the number of records stored in the database for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeColumnFieldSubtotalSum
```
void removeColumnFieldSubtotalSum(java.lang.String fieldName)
```
    Excludes showing subtotal as the sum of all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeColumnFieldSubtotalMax
```
void removeColumnFieldSubtotalMax(java.lang.String fieldName)
```
    Excludes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeColumnFieldSubtotalMin
```
void removeColumnFieldSubtotalMin(java.lang.String fieldName)
```
    Excludes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeColumnFieldSubtotalMean
```
void removeColumnFieldSubtotalMean(java.lang.String fieldName)
```
    Excludes showing subtotal as the average of all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeColumnFieldSubtotalVar
```
void removeColumnFieldSubtotalVar(java.lang.String fieldName)
```
    Excludes showing subtotal as the variance of all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeColumnFieldSubtotalStdDev
```
void removeColumnFieldSubtotalStdDev(java.lang.String fieldName)
```
    Excludes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - removeColumnFieldSubtotalCount
```
void removeColumnFieldSubtotalCount(java.lang.String fieldName)
```
    Excludes showing subtotal as the number of records stored in the database for the specified field when it is defined as a column field.
    
    Parameters:
    
    fieldName - the field name
  - sortDataColumnAscending
```
void sortDataColumnAscending(int columnIndex)
```
    Sorts pivot values belong to the specified column in ascending order. This method will override the column sorting setting defined by grand total column and disable the sorting on the last row field.
    
    Parameters:
    
    columnIndex - the column index where sorting to be applied; index is zero-based
  - sortDataColumnDescending
```
void sortDataColumnDescending(int columnIndex)
```
    Sorts pivot values belong to the specified column in descending order. This method will override the column sorting setting defined by grand total column and disable the sorting on the last row field.
    
    Parameters:
    
    columnIndex - the column index where sorting to be applied; index is zero-based
  - getSortDataColumnIndex
```
int getSortDataColumnIndex()
```
    Returns the column index that is used for sorting on data column.
    
    Returns:
    
    the column index, or -1 if sorting on data column is not defined
  - isSortByDataColumn
```
boolean isSortByDataColumn()
```
    Returns true if sorting on data column is defined.
    
    Returns:
    
    true if sorting on data column is defined.
  - isSortDataColumnAscending
```
boolean isSortDataColumnAscending()
```
    Returns true if sorting on data column is defined and is in ascending order. Note that this method cannot be used alone to determine whether sorting on data column is defined and is in descending order.
    
    Returns:
    
    true if sorting on data column is defined and is in ascending order
  - isSortDataColumnDescending
```
boolean isSortDataColumnDescending()
```
    Returns true if sorting on data column is defined and is in descending order. Note that this method cannot be used alone to determine whether sorting on data column is defined and is in ascending order.
    
    Returns:
    
    true if sorting on data column is defined and is in descending order
  - clearDataColumnSortSettings
```
void clearDataColumnSortSettings()
```
    Removes sorting related settings for all data columns.
  - setDataFieldSummarySum
```
void setDataFieldSummarySum(java.lang.String fieldName)
```
    Sets the summary type for a data field to sum which would show pivot grand total value as the sum of all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field to which summary type to be set
  - setDataFieldSummaryMedian
```
void setDataFieldSummaryMedian(java.lang.String fieldName)
```
    Sets the summary type for a data field to median which would show pivot grand total value as the sum of all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field to which summary type to be set
  - setDataFieldSummaryMax
```
void setDataFieldSummaryMax(java.lang.String fieldName)
```
    Sets the summary type for a data field to maximum which would show pivot grand total value as the maximum value amongst all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field to which summary type to be set
  - setDataFieldSummaryMin
```
void setDataFieldSummaryMin(java.lang.String fieldName)
```
    Sets the summary type for a data field to minimum which would show pivot grand total value as the minimum value amongst all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field to which summary type to be set
  - setDataFieldSummaryMean
```
void setDataFieldSummaryMean(java.lang.String fieldName)
```
    Sets the summary type for a data field to mean which would show pivot grand total value as the average of all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field to which summary type to be set
  - setDataFieldSummaryVar
```
void setDataFieldSummaryVar(java.lang.String fieldName)
```
    Sets the summary type for a data field to variance which would show pivot grand total value as the variance of all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field to which summary type to be set
  - setDataFieldSummaryStdDev
```
void setDataFieldSummaryStdDev(java.lang.String fieldName)
```
    Sets the summary type for a data field to standard deviation which would show pivot grand total value as the standard deviation of all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field to which summary type to be set
  - setDataFieldSummaryCount
```
void setDataFieldSummaryCount(java.lang.String fieldName)
```
    Sets the summary type for a data field to count which would show pivot grand total value as the number of records stored in the application data.
    
    Parameters:
    
    fieldName - the name of the data field to which summary type to be set
  - isDataFieldSummarySum
```
boolean isDataFieldSummarySum(java.lang.String fieldName)
```
    Returns true if the summary type of the specified data field is sum which would show pivot grand total value as the sum of all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field
    
    Returns:
    
    true if the summary type is sum
  - isDataFieldSummaryMax
```
boolean isDataFieldSummaryMax(java.lang.String fieldName)
```
    Returns true if the summary type of the specified data field is maximum which would show pivot grand total value as the maximum value amongst all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field
    
    Returns:
    
    true if the summary type is maximum
  - isDataFieldSummaryMin
```
boolean isDataFieldSummaryMin(java.lang.String fieldName)
```
    Returns true if the summary type of the specified data field is minimum which would show pivot grand total value as the minimum value amongst all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field
    
    Returns:
    
    true if the summary type is minimum
  - isDataFieldSummaryMean
```
boolean isDataFieldSummaryMean(java.lang.String fieldName)
```
    Returns true if the summary type of the specified data field is mean which would show pivot grand total value as the average of all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field
    
    Returns:
    
    true if the summary type is mean
  - isDataFieldSummaryVar
```
boolean isDataFieldSummaryVar(java.lang.String fieldName)
```
    Returns true if the summary type of the specified data field is variance which would show pivot grand total value as the variance of all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field
    
    Returns:
    
    true if the summary type is variance
  - isDataFieldSummaryStdDev
```
boolean isDataFieldSummaryStdDev(java.lang.String fieldName)
```
    Returns true if the summary type of the specified data field is standard deviation which would show pivot grand total value as the standard deviation of all pivot values.
    
    Parameters:
    
    fieldName - the name of the data field
    
    Returns:
    
    true if the summary type is standard deviation;
  - isDataFieldSummaryCount
```
boolean isDataFieldSummaryCount(java.lang.String fieldName)
```
    Returns true if the summary type of the specified data field is count which would show pivot grand total value as the number of records stored in the application data.
    
    Parameters:
    
    fieldName - the name of the data field
    
    Returns:
    
    true if the summary type is count
  - isDataFieldSummaryCountD
```
boolean isDataFieldSummaryCountD(java.lang.String fieldName)
```
  - unsetDataFieldSummaryType
```
void unsetDataFieldSummaryType(java.lang.String fieldName)
```
    Unsets the summary type corresponding to the specified data field. The summary type of a data field is set to sum by default if custom setting is not defined, please see setDataFieldSummarySum(String fieldName) for more information.
    
    Parameters:
    
    fieldName - the name of the data field from which summary type to be unset
  - clearDataFieldSummaryTypeSettings
```
void clearDataFieldSummaryTypeSettings()
```
    Removes summary type related settings for all data fields.
  - calculateGrid
```
void calculateGrid()
            throws java.lang.Exception
```
    Calculates the pivot data. The previously calculated pivot data will be lost if the calculation failed. Please note that setting changes made after the invocation of this method will not affect the pivot data just being calculated. For new setting changes to take effect, this method needs to be re-invoked.
    
    Throws:
    
    java.lang.Exception - if pivot data cannot be calculated due to incorrect settings
  - isCalculated
```
boolean isCalculated()
```
    Returns true if the pivot data has been successfully calculated.
    
    Returns:
    
    true if the pivot data has been successfully calculated.
  - renderText
```
java.lang.String renderText()
                     throws java.lang.Exception
```
    Converts the pivot data to a formatted plain text grid using the default grid settings.
    
    Returns:
    
    a String containing the formatted grid
    
    Throws:
    
    java.lang.Exception - if the pivot data has not been calculated
  - renderText
```
java.lang.String renderText(int lineCount)
                     throws java.lang.Exception
```
    Converts the pivot data, up to lineCount rows, to a formatted plain text grid using the default grid settings.
    
    Parameters:
    
    lineCount - the maximum number of rows to display
    
    Returns:
    
    a String containing the formatted grid
    
    Throws:
    
    java.lang.Exception - if the pivot data has not been calculated
  - renderText
```
java.lang.String renderText(AQDataSetSettings settings)
                     throws java.lang.Exception
```
    Converts the pivot data to a formatted plain text grid using the specified grid settings.
    
    Parameters:
    
    settings - a grid settings
    
    Returns:
    
    a String containing the formatted grid
    
    Throws:
    
    java.lang.Exception - if the pivot data has not been calculated
  - renderHtml
```
java.lang.String renderHtml(AQDataSetSettings settings)
                     throws java.lang.Exception
```
    Converts the pivot data to a HTML document using the specified grid settings.
    
    Parameters:
    
    settings - a grid settings
    
    Returns:
    
    a String containing the generated HTML document
    
    Throws:
    
    java.lang.Exception - if the pivot data has not been calculated
  - renderHtml
```
java.lang.String renderHtml(AQDataSetSettings settings,
                            AQChart chart)
                     throws java.lang.Exception
```
    Converts the pivot data to a HTML document, with chart enabled, using the specified grid settings.
    
    Parameters:
    
    settings - a grid settings
    
    chart - an object that describes how chart to be presented; ignored if null
    
    Returns:
    
    a String containing the generated HTML document
    
    Throws:
    
    java.lang.Exception - if the pivot data has not been calculated
  - renderHtml
```
java.lang.String renderHtml()
                     throws java.lang.Exception
```
    Converts the pivot data to a HTML document using the default grid settings.
    
    Returns:
    
    a String containing the generated HTML document
    
    Throws:
    
    java.lang.Exception - if the pivot data has not been calculated
  - saveAsExcel2003
```
void saveAsExcel2003(java.lang.String fileName)
              throws java.lang.Exception
```
    Saves the pivot data as an Excel 2003 file. If the specified file already exists, it will be overridden.
    
    Parameters:
    
    fileName - the name of the file where the pivot data to be saved
    
    Throws:
    
    java.lang.Exception - On error
  - saveAsExcel2003
```
void saveAsExcel2003(java.lang.String fileName,
                     AQDataSetSettings settings,
                     AQChart chart)
              throws java.lang.Exception
```
    Saves the pivot data, with chart enabled, as an Excel 2003 file. If the specified file already exists, it will be overridden.
    
    Parameters:
    
    fileName - the name of the file where the pivot data to be saved
    
    settings - a data set settings, default settings are used if null
    
    chart - an object that describes how chart to be presented; ignored if null
    
    Throws:
    
    java.lang.Exception - On error
  - getAsExcel2003
```
byte[] getAsExcel2003()
               throws java.lang.Exception
```
    Returns the pivot data as a byte array representing an Excel 2003 file.
    
    Returns:
    
    the Excel content
    
    Throws:
    
    java.lang.Exception - On error
  - getAsExcel2003
```
byte[] getAsExcel2003(AQDataSetSettings settings,
                      AQChart chart)
               throws java.lang.Exception
```
    Returns the pivot data, with chart enabled, as a byte array representing an Excel 2003 file.
    
    Parameters:
    
    settings - a data set settings, default settings are used if null
    
    chart - an object that describes how chart to be presented; ignored if null
    
    Returns:
    
    the Excel content
    
    Throws:
    
    java.lang.Exception - On error
  - saveAsExcel2007
```
void saveAsExcel2007(java.lang.String fileName)
              throws java.lang.Exception
```
    Saves the pivot data as an Excel 2007 file. If the specified file already exists, it will be overridden.
    
    Parameters:
    
    fileName - the name of the file where the pivot data to be saved
    
    Throws:
    
    java.lang.Exception - On error
  - saveAsExcel2007
```
void saveAsExcel2007(java.lang.String fileName,
                     AQDataSetSettings settings,
                     AQChart chart)
              throws java.lang.Exception
```
    Saves the pivot data, with chart enabled, as an Excel 2007 file. If the specified file already exists, it will be overridden.
    
    Parameters:
    
    fileName - the name of the file where the pivot data to be saved
    
    settings - a data set settings, default settings are used if null
    
    chart - an object that describes how chart to be presented; ignored if null
    
    Throws:
    
    java.lang.Exception - On error
  - getAsExcel2007
```
byte[] getAsExcel2007()
               throws java.lang.Exception
```
    Returns the pivot data as a byte array representing an Excel 2007 file.
    
    Returns:
    
    the Excel content
    
    Throws:
    
    java.lang.Exception - On error
  - getAsExcel2007
```
byte[] getAsExcel2007(AQDataSetSettings settings,
                      AQChart chart)
               throws java.lang.Exception
```
    Returns the pivot data, with chart enabled, as a byte array representing an Excel 2007 file.
    
    Parameters:
    
    settings - a data set settings, default settings are used if null
    
    chart - an object that describes how chart to be presented; ignored if null
    
    Returns:
    
    the Excel content
    
    Throws:
    
    java.lang.Exception - On error

Interface AQPivotDataSet

Method Summary

Method Detail

setDataSet

getDataSet

isShowGrandTotalForRow

isShowGrandTotalForColumn

addRowField

removeRowField

getRowFields

clearRowFields

addColumnField

removeColumnField

getColumnFields

clearColumnFields

addDataField

removeDataField

getDataFields

clearDataFields

setRowFieldSortAscending

setRowFieldSortDescending

setRowFieldSortNone

isRowFieldSortAscending

isRowFieldSortDescending

isRowFieldSortNone

unsetRowFieldSortOrder

clearRowFieldSortOrderSettings

setColumnFieldSortAscending

setColumnFieldSortDescending

setColumnFieldSortNone

isColumnFieldSortAscending

isColumnFieldSortDescending

isColumnFieldSortNone

unsetColumnFieldSortOrder

clearColumnFieldSortOrderSettings

sortGrandTotalColumnAscending

sortGrandTotalColumnDescending

isSortByGrandTotalColumn

isSortGrandTotalColumnAscending

isSortGrandTotalColumnDescending

getGrandTotalColumnSortName

clearGrandTotalColumnSortSettings

setShowSubtotal

isShowSubtotalUsingSystemDefault

setShowSubtotalForLastRowAndColumn

setShowSubtotalForLastRow

setShowSubtotalForLastColumn

isShowSubtotalForLastRow

isShowSubtotalForLastColumn

setFieldSubtotalNone

setFieldSubtotalDefault

setFieldSubtotalSum

setFieldSubtotalMedian

setFieldSubtotalMax

setFieldSubtotalMin

setFieldSubtotalMean

setFieldSubtotalVar

setFieldSubtotalStdDev

setFieldSubtotalCount

addFieldSubtotalSum

addFieldSubtotalMax

addFieldSubtotalMin

addFieldSubtotalMean

addFieldSubtotalVar

addFieldSubtotalStdDev

addFieldSubtotalCount

removeFieldSubtotalSum

removeFieldSubtotalMax

removeFieldSubtotalMin

removeFieldSubtotalMean

removeFieldSubtotalVar

removeFieldSubtotalStdDev

removeFieldSubtotalCount

setRowFieldSubtotalNone

setRowFieldSubtotalDefault

setRowFieldSubtotalSum

setRowFieldSubtotalMax

setRowFieldSubtotalMin

setRowFieldSubtotalMean

setRowFieldSubtotalVar