aspose.cells

Class PivotTable

Summary description for PivotTable.

Property Getters/Setters Summary
functiongetAltTextDescription()
function
           Gets the description of the alt text
functiongetAltTextTitle()
function
           Gets the title of the alttext
functiongetAutoFormatType()
function
           Gets the PivotTable auto format type. The value of the property is PivotTableAutoFormatType integer constant.
functiongetBaseFields()
Returns a PivotFields object that includes all fields in the PivotTable report
functiongetColumnFields()
Returns a PivotFields object that are currently shown as column fields.
functiongetColumnGrand()
function
           Indicates whether the PivotTable report shows grand totals for columns.
functiongetColumnHeaderCaption()
function
           Gets the Column Header Caption of the PivotTable.
functiongetColumnRange()
Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.
functiongetCustomListSort()
function
           Indicates whether consider built-in custom list when sort data
functiongetDataBodyRange()
Returns a CellArea object that represents the range that contains the data area in the list between the header row and the insert row. Read-only.
functiongetDataField()
Gets a PivotField object that represents all the data fields in a PivotTable. Read-only.It would be init only when there are two or more data fields in the DataPiovtFiels. It only use to add DataPivotField to the PivotTable row/column area . Default is in row area.
functiongetDataFields()
Gets a PivotField object that represents all the data fields in a PivotTable. Read-only.It would be init only when there are two or more data fields in the DataPiovtFiels. It only use to add DataPivotField to the PivotTable row/column area . Default is in row area.
functiongetDataSource()
function
           Gets and sets the data source of the pivot table.
functiongetDisplayErrorString()
function
           Indicates whether the PivotTable report displays a custom string in cells that contain errors.
functiongetDisplayImmediateItems()
function
           Indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty. The default value is true.
functiongetDisplayNullString()
function
           Indicates whether the PivotTable report displays a custom string in cells that contain null values.
functiongetEnableDataValueEditing()
function
           Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable. Enable cell editing in the values area
functiongetEnableDrilldown()
function
           Gets whether drilldown is enabled.
functiongetEnableFieldDialog()
function
           Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
functiongetEnableFieldList()
function
           Gets whether enable the field list for the PivotTable.
functiongetEnableWizard()
function
           Indicates whether the PivotTable Wizard is available.
functiongetErrorString()
function
           Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
functiongetFieldListSortAscending()
function
           Specifies a boolean value that indicates whether fields in the PivotTable are sorted in non-default order in the field list.
functiongetGrandTotalName()
function
           Returns the text string label that is displayed in the grand total column or row heading. The default value is the string "Grand Total".
functionhasBlankRows()
function
           Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
functiongetIndent()
function
setIndent(value)
           Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
functionisAutoFormat()
function
           Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table "which in pivottable option for Excel 2003 Checkbox "autofit column width on update"which in pivot table Options :Layout Format for Excel 2007
functionisExcel2003Compatible()
function
           Specifies whether the PivotTable is compatible for Excel2003 when refreshing PivotTable, if true, a string must be less than or equal to 255 characters, so if the string is greater than 255 characters, it will be truncated. if false, a string will not have the aforementioned restriction. The default value is true.
functionisGridDropZones()
function
           Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
functionisMultipleFieldFilters()
function
           Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
functionisSelected()
function
           Indicates whether the PivotTable is selected.
functiongetItemPrintTitles()
function
           A bit that specifies whether pivot item captions on the row axis are repeated on each printed page for pivot fields in tabular form.
functiongetManualUpdate()
function
           Indicates whether the PivotTable report is recalculated only at the user's request.
functiongetMergeLabels()
function
           Indicates whether the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.
functiongetMissingItemsLimit()
function
           Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. The value of the property is PivotMissingItemLimitType integer constant.
functiongetName()
function
setName(value)
           Gets the name of the PivotTable
functiongetNullString()
function
           Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
functiongetPageFieldOrder()
function
           Gets the order in which page fields are added to the PivotTable report's layout. The value of the property is PrintOrderType integer constant.
functiongetPageFields()
Returns a PivotFields object that are currently shown as page fields.
functiongetPageFieldWrapCount()
function
           Gets the number of page fields in each column or row in the PivotTable report.
functiongetPivotFilters()
Returns a PivotFilterCollection object.
functiongetPivotFormatConditions()
Gets the Format Conditions of the pivot table.
functiongetPivotTableStyleName()
function
           Gets and sets the pivottable style name.
functiongetPivotTableStyleType()
function
           Gets and sets the built-in pivot table style. The value of the property is PivotTableStyleType integer constant.
functiongetPreserveFormatting()
function
           Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
functiongetPrintDrill()
function
           Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.
functiongetPrintTitles()
function
           Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
functiongetRefreshDataFlag()
function
           Indicates whether Refresh Data or not.
functiongetRefreshDataOnOpeningFile()
function
           Indicates whether Refresh Data when Opening File.
functiongetRefreshDate()
Gets the date when the PivotTable was last refreshed.
functiongetRefreshedByWho()
Gets the name of the user who last refreshed the PivotTable
functiongetRowFields()
Returns a PivotFields object that are currently shown as row fields.
functiongetRowGrand()
function
           Indicates whether the PivotTable report shows grand totals for rows.
functiongetRowHeaderCaption()
function
           Gets the Row Header Caption of the PivotTable.
functiongetRowRange()
Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.
functiongetSaveData()
function
           Indicates whether data for the PivotTable report is saved with the workbook.
functiongetShowDataTips()
function
           Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
functiongetShowDrill()
function
           Gets whether expand/collapse buttons is shown.
functiongetShowEmptyCol()
function
           Specifies a boolean value that indicates whether to include empty columns in the table
functiongetShowEmptyRow()
function
           Specifies a boolean value that indicates whether to include empty rows in the table.
functiongetShowMemberPropertyTips()
function
           Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
functiongetShowPivotStyleColumnHeader()
function
           Indicates whether the column header in the pivot table should have the style applied.
functiongetShowPivotStyleColumnStripes()
function
           Indicates whether column stripe formatting is applied.
functiongetShowPivotStyleLastColumn()
function
           Indicates whether column stripe formatting is applied.
functiongetShowPivotStyleRowHeader()
function
           Indicates whether the row header in the pivot table should have the style applied.
functiongetShowPivotStyleRowStripes()
function
           Indicates whether row stripe formatting is applied.
functiongetShowRowHeaderCaption()
function
           Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
functiongetShowValuesRow()
function
           Specifies a boolean value that indicates whether show values row. show the values row
functiongetSubtotalHiddenPageItems()
function
           Indicates whether hidden page field items in the PivotTable report are included in row and column subtotals, block totals, and grand totals. The default value is False.
functiongetTableRange1()
Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields. Read-only.
functiongetTableRange2()
Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.
functiongetTag()
function
setTag(value)
           Gets a string saved with the PivotTable report.
 
Method Summary
functionaddCalculatedField(name, formula)
Adds a calclulated field to pivot field and drag it to data area.
functionaddCalculatedField(name, formula, dragToDataArea)
Adds a calclulated field to pivot field.
functionaddFieldToArea(fieldType, pivotField)
Adds the field to the specific area.
functionaddFieldToArea(fieldType, baseFieldIndex)
Adds the field to the specific area.
functionaddFieldToArea(fieldType, fieldName)
Adds the field to the specific area.
functioncalculateData()
Calculates pivottable's data to cells.
functioncalculateRange()
Calculates pivottable's range.
functionchangeDataSource(source)
Set pivottable's source data. Sheet1!$A$1:$C$3
functionclearData()
Clear PivotTable's data and formatting
functioncopyStyle(pivotTable)
Copies named style from another pivot table.
functionfields(fieldType)
Gets the specific fields by the field type.
functionformat(row, column, style)
Format the cell in the pivottable area
functionformatAll(style)
Format all the cell in the pivottable area
functiongetCellByDisplayName(displayName)
Gets the Cell object by the DisplayName of PivotField
functiongetChildren()
Gets the the Children Pivot Tables which use this PivotTable data as data source.
functiongetHorizontalBreaks()
get pivot table row index list of horizontal pagebreaks
functiongetSource()
Get pivottable's source data.
functionmove(row, column)
Moves the PivotTable to a different location in the worksheet.
functionmove(destCellName)
Moves the PivotTable to a different location in the worksheet.
functionrefreshData()
Refreshes pivottable's data and setting from it's data source.
functionremoveField(fieldType, pivotField)
Remove field from specific field area
functionremoveField(fieldType, baseFieldIndex)
Removes a field from specific field area
functionremoveField(fieldType, fieldName)
Removes a field from specific field area
functionsetAutoGroupField(pivotField)
Sets auto field group by the PivotTable.
functionsetAutoGroupField(baseFieldIndex)
Sets auto field group by the PivotTable.
functionsetManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)
Sets manual field group by the PivotTable.
functionsetManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)
Sets manual field group by the PivotTable.
functionsetManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)
Sets manual field group by the PivotTable.
functionsetManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)
Sets manual field group by the PivotTable.
functionsetUngroup(pivotField)
Sets ungroup by the PivotTable
functionsetUngroup(baseFieldIndex)
Sets ungroup by the PivotTable
functionshowInCompactForm()
Layouts the PivotTable in compact form.
functionshowInOutlineForm()
Layouts the PivotTable in outline form.
functionshowInTabularForm()
Layouts the PivotTable in tabular form.
functionshowReportFilterPage(pageField)
Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
functionshowReportFilterPageByIndex(posIndex)
Show all the report filter pages according to the position index in the PageFields
functionshowReportFilterPageByName(fieldName)
Show all the report filter pages according to PivotField's name, the PivotField must be located in the PageFields.
 

    • Property Getters/Setters Detail

      • isExcel2003Compatible/setExcel2003Compatible : boolean 

        function isExcel2003Compatible() / function setExcel2003Compatible(value)
        
        Specifies whether the PivotTable is compatible for Excel2003 when refreshing PivotTable, if true, a string must be less than or equal to 255 characters, so if the string is greater than 255 characters, it will be truncated. if false, a string will not have the aforementioned restriction. The default value is true.
      • getRefreshedByWho : String 

        function getRefreshedByWho()
        
        Gets the name of the user who last refreshed the PivotTable
      • getRefreshDate : DateTime 

        function getRefreshDate()
        
        Gets the date when the PivotTable was last refreshed.
      • getPivotTableStyleName/setPivotTableStyleName : String 

        function getPivotTableStyleName() / function setPivotTableStyleName(value)
        
        Gets and sets the pivottable style name.
      • getPivotTableStyleType/setPivotTableStyleType : Number 

        function getPivotTableStyleType() / function setPivotTableStyleType(value)
        
        Gets and sets the built-in pivot table style. The value of the property is PivotTableStyleType integer constant.
      • getColumnFields : PivotFieldCollection 

        function getColumnFields()
        
        Returns a PivotFields object that are currently shown as column fields.
      • getRowFields : PivotFieldCollection 

        function getRowFields()
        
        Returns a PivotFields object that are currently shown as row fields.
      • getPageFields : PivotFieldCollection 

        function getPageFields()
        
        Returns a PivotFields object that are currently shown as page fields.
      • getDataFields : PivotFieldCollection 

        function getDataFields()
        
        Gets a PivotField object that represents all the data fields in a PivotTable. Read-only.It would be init only when there are two or more data fields in the DataPiovtFiels. It only use to add DataPivotField to the PivotTable row/column area . Default is in row area.
      • getDataField : PivotField 

        function getDataField()
        
        Gets a PivotField object that represents all the data fields in a PivotTable. Read-only.It would be init only when there are two or more data fields in the DataPiovtFiels. It only use to add DataPivotField to the PivotTable row/column area . Default is in row area.
      • getBaseFields : PivotFieldCollection 

        function getBaseFields()
        
        Returns a PivotFields object that includes all fields in the PivotTable report
      • getPivotFilters : PivotFilterCollection 

        function getPivotFilters()
        
        Returns a PivotFilterCollection object.
      • getColumnRange : CellArea 

        function getColumnRange()
        
        Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.
      • getRowRange : CellArea 

        function getRowRange()
        
        Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.
      • getDataBodyRange : CellArea 

        function getDataBodyRange()
        
        Returns a CellArea object that represents the range that contains the data area in the list between the header row and the insert row. Read-only.
      • getTableRange1 : CellArea 

        function getTableRange1()
        
        Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn't include page fields. Read-only.
      • getTableRange2 : CellArea 

        function getTableRange2()
        
        Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.
      • getColumnGrand/setColumnGrand : boolean 

        function getColumnGrand() / function setColumnGrand(value)
        
        Indicates whether the PivotTable report shows grand totals for columns.
      • isGridDropZones/setGridDropZones : boolean 

        function isGridDropZones() / function setGridDropZones(value)
        
        Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
      • getRowGrand/setRowGrand : boolean 

        function getRowGrand() / function setRowGrand(value)
        
        Indicates whether the PivotTable report shows grand totals for rows.
      • getDisplayNullString/setDisplayNullString : boolean 

        function getDisplayNullString() / function setDisplayNullString(value)
        
        Indicates whether the PivotTable report displays a custom string in cells that contain null values.
      • getNullString/setNullString : String 

        function getNullString() / function setNullString(value)
        
        Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
      • getDisplayErrorString/setDisplayErrorString : boolean 

        function getDisplayErrorString() / function setDisplayErrorString(value)
        
        Indicates whether the PivotTable report displays a custom string in cells that contain errors.
      • getErrorString/setErrorString : String 

        function getErrorString() / function setErrorString(value)
        
        Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
      • isAutoFormat/setAutoFormat : boolean 

        function isAutoFormat() / function setAutoFormat(value)
        
        Indicates whether the PivotTable report is automatically formatted. Checkbox "autoformat table "which in pivottable option for Excel 2003 Checkbox "autofit column width on update"which in pivot table Options :Layout Format for Excel 2007
      • getAutoFormatType/setAutoFormatType : Number 

        function getAutoFormatType() / function setAutoFormatType(value)
        
        Gets the PivotTable auto format type. The value of the property is PivotTableAutoFormatType integer constant.PivotTableAutoFormatType
      • hasBlankRows/setHasBlankRows : boolean 

        function hasBlankRows() / function setHasBlankRows(value)
        
        Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
      • getMergeLabels/setMergeLabels : boolean 

        function getMergeLabels() / function setMergeLabels(value)
        
        Indicates whether the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.
      • getPreserveFormatting/setPreserveFormatting : boolean 

        function getPreserveFormatting() / function setPreserveFormatting(value)
        
        Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
      • getShowDrill/setShowDrill : boolean 

        function getShowDrill() / function setShowDrill(value)
        
        Gets whether expand/collapse buttons is shown.
      • getEnableDrilldown/setEnableDrilldown : boolean 

        function getEnableDrilldown() / function setEnableDrilldown(value)
        
        Gets whether drilldown is enabled.
      • getEnableFieldDialog/setEnableFieldDialog : boolean 

        function getEnableFieldDialog() / function setEnableFieldDialog(value)
        
        Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
      • getEnableFieldList/setEnableFieldList : boolean 

        function getEnableFieldList() / function setEnableFieldList(value)
        
        Gets whether enable the field list for the PivotTable.
      • getEnableWizard/setEnableWizard : boolean 

        function getEnableWizard() / function setEnableWizard(value)
        
        Indicates whether the PivotTable Wizard is available.
      • getSubtotalHiddenPageItems/setSubtotalHiddenPageItems : boolean 

        function getSubtotalHiddenPageItems() / function setSubtotalHiddenPageItems(value)
        
        Indicates whether hidden page field items in the PivotTable report are included in row and column subtotals, block totals, and grand totals. The default value is False.
      • getGrandTotalName/setGrandTotalName : String 

        function getGrandTotalName() / function setGrandTotalName(value)
        
        Returns the text string label that is displayed in the grand total column or row heading. The default value is the string "Grand Total".
      • getManualUpdate/setManualUpdate : boolean 

        function getManualUpdate() / function setManualUpdate(value)
        
        Indicates whether the PivotTable report is recalculated only at the user's request.
      • isMultipleFieldFilters/setMultipleFieldFilters : boolean 

        function isMultipleFieldFilters() / function setMultipleFieldFilters(value)
        
        Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
      • getMissingItemsLimit/setMissingItemsLimit : Number 

        function getMissingItemsLimit() / function setMissingItemsLimit(value)
        
        Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. The value of the property is PivotMissingItemLimitType integer constant.
      • getEnableDataValueEditing/setEnableDataValueEditing : boolean 

        function getEnableDataValueEditing() / function setEnableDataValueEditing(value)
        
        Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable. Enable cell editing in the values area
      • getShowDataTips/setShowDataTips : boolean 

        function getShowDataTips() / function setShowDataTips(value)
        
        Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
      • getShowMemberPropertyTips/setShowMemberPropertyTips : boolean 

        function getShowMemberPropertyTips() / function setShowMemberPropertyTips(value)
        
        Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
      • getShowValuesRow/setShowValuesRow : boolean 

        function getShowValuesRow() / function setShowValuesRow(value)
        
        Specifies a boolean value that indicates whether show values row. show the values row
      • getShowEmptyCol/setShowEmptyCol : boolean 

        function getShowEmptyCol() / function setShowEmptyCol(value)
        
        Specifies a boolean value that indicates whether to include empty columns in the table
      • getShowEmptyRow/setShowEmptyRow : boolean 

        function getShowEmptyRow() / function setShowEmptyRow(value)
        
        Specifies a boolean value that indicates whether to include empty rows in the table.
      • getFieldListSortAscending/setFieldListSortAscending : boolean 

        function getFieldListSortAscending() / function setFieldListSortAscending(value)
        
        Specifies a boolean value that indicates whether fields in the PivotTable are sorted in non-default order in the field list.
      • getPrintDrill/setPrintDrill : boolean 

        function getPrintDrill() / function setPrintDrill(value)
        
        Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.
      • getAltTextTitle/setAltTextTitle : String 

        function getAltTextTitle() / function setAltTextTitle(value)
        
        Gets the title of the alttext
      • getAltTextDescription/setAltTextDescription : String 

        function getAltTextDescription() / function setAltTextDescription(value)
        
        Gets the description of the alt text
      • getName/setName : String 

        function getName() / function setName(value)
        
        Gets the name of the PivotTable
      • getColumnHeaderCaption/setColumnHeaderCaption : String 

        function getColumnHeaderCaption() / function setColumnHeaderCaption(value)
        
        Gets the Column Header Caption of the PivotTable.
      • getIndent/setIndent : Number 

        function getIndent() / function setIndent(value)
        
        Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
      • getRowHeaderCaption/setRowHeaderCaption : String 

        function getRowHeaderCaption() / function setRowHeaderCaption(value)
        
        Gets the Row Header Caption of the PivotTable.
      • getShowRowHeaderCaption/setShowRowHeaderCaption : boolean 

        function getShowRowHeaderCaption() / function setShowRowHeaderCaption(value)
        
        Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
      • getCustomListSort/setCustomListSort : boolean 

        function getCustomListSort() / function setCustomListSort(value)
        
        Indicates whether consider built-in custom list when sort data
      • getPageFieldOrder/setPageFieldOrder : Number 

        function getPageFieldOrder() / function setPageFieldOrder(value)
        
        Gets the order in which page fields are added to the PivotTable report's layout. The value of the property is PrintOrderType integer constant.
      • getPageFieldWrapCount/setPageFieldWrapCount : Number 

        function getPageFieldWrapCount() / function setPageFieldWrapCount(value)
        
        Gets the number of page fields in each column or row in the PivotTable report.
      • getTag/setTag : String 

        function getTag() / function setTag(value)
        
        Gets a string saved with the PivotTable report.
      • getSaveData/setSaveData : boolean 

        function getSaveData() / function setSaveData(value)
        
        Indicates whether data for the PivotTable report is saved with the workbook.
      • getRefreshDataOnOpeningFile/setRefreshDataOnOpeningFile : boolean 

        function getRefreshDataOnOpeningFile() / function setRefreshDataOnOpeningFile(value)
        
        Indicates whether Refresh Data when Opening File.
      • getRefreshDataFlag/setRefreshDataFlag : boolean 

        function getRefreshDataFlag() / function setRefreshDataFlag(value)
        
        Indicates whether Refresh Data or not.
      • getDataSource/setDataSource : String[] 

        function getDataSource() / function setDataSource(value)
        
        Gets and sets the data source of the pivot table.
      • getItemPrintTitles/setItemPrintTitles : boolean 

        function getItemPrintTitles() / function setItemPrintTitles(value)
        
        A bit that specifies whether pivot item captions on the row axis are repeated on each printed page for pivot fields in tabular form.
      • getPrintTitles/setPrintTitles : boolean 

        function getPrintTitles() / function setPrintTitles(value)
        
        Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
      • getDisplayImmediateItems/setDisplayImmediateItems : boolean 

        function getDisplayImmediateItems() / function setDisplayImmediateItems(value)
        
        Indicates whether items in the row and column areas are visible when the data area of the PivotTable is empty. The default value is true.
      • isSelected/setSelected : boolean 

        function isSelected() / function setSelected(value)
        
        Indicates whether the PivotTable is selected.
      • getShowPivotStyleRowHeader/setShowPivotStyleRowHeader : boolean 

        function getShowPivotStyleRowHeader() / function setShowPivotStyleRowHeader(value)
        
        Indicates whether the row header in the pivot table should have the style applied.
      • getShowPivotStyleColumnHeader/setShowPivotStyleColumnHeader : boolean 

        function getShowPivotStyleColumnHeader() / function setShowPivotStyleColumnHeader(value)
        
        Indicates whether the column header in the pivot table should have the style applied.
      • getShowPivotStyleRowStripes/setShowPivotStyleRowStripes : boolean 

        function getShowPivotStyleRowStripes() / function setShowPivotStyleRowStripes(value)
        
        Indicates whether row stripe formatting is applied.
      • getShowPivotStyleColumnStripes/setShowPivotStyleColumnStripes : boolean 

        function getShowPivotStyleColumnStripes() / function setShowPivotStyleColumnStripes(value)
        
        Indicates whether column stripe formatting is applied.
      • getShowPivotStyleLastColumn/setShowPivotStyleLastColumn : boolean 

        function getShowPivotStyleLastColumn() / function setShowPivotStyleLastColumn(value)
        
        Indicates whether column stripe formatting is applied.
    • Method Detail

      • changeDataSource

        function changeDataSource(source)
        Set pivottable's source data. Sheet1!$A$1:$C$3
      • getSource

        function getSource()
        Get pivottable's source data.
      • refreshData

        function refreshData()
        Refreshes pivottable's data and setting from it's data source. 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

        function calculateData()
        Calculates pivottable's data to cells. 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.
      • clearData

        function clearData()
        Clear PivotTable's data and formatting If this method is not callled before you add or delete PivotField, Maybe the PivotTable data is not corrected
      • calculateRange

        function calculateRange()
        Calculates pivottable's range. If this method is not been called,maybe the pivottable range is not corrected.
      • formatAll

        function formatAll(style)
        Format all the cell in the pivottable area
        Parameters:
        style: Style - Style which is to format
      • format

        function format(row, column, style)
        Format the cell in the pivottable area
        Parameters:
        row: Number - RowIndex of the cell
        column: Number - Column index of the cell
        style: Style - Style which is to format the cell
      • setAutoGroupField

        function setAutoGroupField(baseFieldIndex)
        Sets auto field group by the PivotTable.
        Parameters:
        baseFieldIndex: Number - The row or column field index in the base fields
      • setAutoGroupField

        function setAutoGroupField(pivotField)
        Sets auto field group by the PivotTable.
        Parameters:
        pivotField: PivotField - The row or column field in the specific fields
      • setManualGroupField

        function setManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)
        Sets manual field group by the PivotTable.
        Parameters:
        baseFieldIndex: Number - The row or column field index in the base fields
        startVal: Number - Specifies the starting value for numeric grouping.
        endVal: Number - Specifies the ending value for numeric grouping.
        groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType
        intervalNum: Number - Specifies the interval number group by numeric grouping.
      • setManualGroupField

        function setManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)
        Sets manual field group by the PivotTable.
        Parameters:
        pivotField: PivotField - The row or column field in the base fields
        startVal: Number - Specifies the starting value for numeric grouping.
        endVal: Number - Specifies the ending value for numeric grouping.
        groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType
        intervalNum: Number - Specifies the interval number group by numeric grouping.
      • setManualGroupField

        function setManualGroupField(baseFieldIndex, startVal, endVal, groupByList, intervalNum)
        Sets manual field group by the PivotTable.
        Parameters:
        baseFieldIndex: Number - The row or column field index in the base fields
        startVal: DateTime - Specifies the starting value for date grouping.
        endVal: DateTime - Specifies the ending value for date grouping.
        groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType
        intervalNum: Number - Specifies the interval number group by in days grouping.The number of days must be positive integer of nonzero
      • setManualGroupField

        function setManualGroupField(pivotField, startVal, endVal, groupByList, intervalNum)
        Sets manual field group by the PivotTable.
        Parameters:
        pivotField: PivotField - The row or column field in the base fields
        startVal: DateTime - Specifies the starting value for date grouping.
        endVal: DateTime - Specifies the ending value for date grouping.
        groupByList: ArrayList - Specifies the grouping type list. Specified by PivotTableGroupType
        intervalNum: Number - Specifies the interval number group by in days grouping.The number of days must be positive integer of nonzero
      • setUngroup

        function setUngroup(baseFieldIndex)
        Sets ungroup by the PivotTable
        Parameters:
        baseFieldIndex: Number - The row or column field index in the base fields
      • setUngroup

        function setUngroup(pivotField)
        Sets ungroup by the PivotTable
        Parameters:
        pivotField: PivotField - The row or column field in the base fields
      • getHorizontalBreaks

        function getHorizontalBreaks()
        get pivot table row index list of horizontal pagebreaks
        Returns:
      • showInCompactForm

        function showInCompactForm()
        Layouts the PivotTable in compact form.
      • showInOutlineForm

        function showInOutlineForm()
        Layouts the PivotTable in outline form.
      • showInTabularForm

        function showInTabularForm()
        Layouts the PivotTable in tabular form.
      • getCellByDisplayName

        function getCellByDisplayName(displayName)
        Gets the Cell object by the DisplayName of PivotField
        Parameters:
        displayName: String - the DisplayName of PivotField
        Returns:
        the Cell object
      • getChildren

        function getChildren()
        Gets the the Children Pivot Tables which use this PivotTable data as data source.
        Returns:
        the PivotTable array object
      • copyStyle

        function copyStyle(pivotTable)
        Copies named style from another pivot table.
        Parameters:
        pivotTable: PivotTable - Source pivot table.
      • showReportFilterPage

        function showReportFilterPage(pageField)
        Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
        Parameters:
        pageField: PivotField - The PivotField object
      • showReportFilterPageByName

        function showReportFilterPageByName(fieldName)
        Show all the report filter pages according to PivotField's name, the PivotField must be located in the PageFields.
        Parameters:
        fieldName: String - The name of PivotField
      • showReportFilterPageByIndex

        function showReportFilterPageByIndex(posIndex)
        Show all the report filter pages according to the position index in the PageFields
        Parameters:
        posIndex: Number - The position index in the PageFields
      • removeField

        function removeField(fieldType, pivotField)
        Remove field from specific field area
        Parameters:
        fieldType: Number - A PivotFieldType value. the fields area type.It could be one of the following values:
        PivotFieldType.Row
        PivotFieldType.Column
        PivotFieldType.Data
        PivotFieldType.Page
        pivotField: PivotField - the field in the base fields.
      • addFieldToArea

        function addFieldToArea(fieldType, fieldName)
        Adds the field to the specific area. addFieldToArea(int, com.aspose.cells.PivotField)
        Parameters:
        fieldType: Number - A PivotFieldType value. The fields area type.
        fieldName: String - The name in the base fields.
        Returns:
        The field position in the specific fields.If there is no field named as it, return -1.
      • addFieldToArea

        function addFieldToArea(fieldType, baseFieldIndex)
        Adds the field to the specific area. addFieldToArea(int, com.aspose.cells.PivotField)
        Parameters:
        fieldType: Number - A PivotFieldType value. The fields area type.
        baseFieldIndex: Number - The field index in the base fields.
        Returns:
        The field position in the specific fields.
      • addFieldToArea

        function addFieldToArea(fieldType, pivotField)
        Adds the field to the specific area.
        Parameters:
        fieldType: Number - A PivotFieldType value. the fields area type.It could be one of the following values:
        PivotFieldType.Row
        PivotFieldType.Column
        PivotFieldType.Data
        PivotFieldType.Page
        pivotField: PivotField - the field in the base fields.
        Returns:
        the field position in the specific fields.
      • addCalculatedField

        function addCalculatedField(name, formula, dragToDataArea)
        Adds a calclulated field to pivot field.
        Parameters:
        name: String - The name of the calculated field
        formula: String - The formula of the calculated field.
        dragToDataArea: boolean - True,drag this field to data area immediately
      • addCalculatedField

        function addCalculatedField(name, formula)
        Adds a calclulated field to pivot field and drag it to data area.
        Parameters:
        name: String - The name of the calculated field
        formula: String - The formula of the calculated field.
      • fields

        function fields(fieldType)
        Gets the specific fields by the field type.
        Parameters:
        fieldType: Number - A PivotFieldType value. the field type.
        Returns:
        the specific fields
      • move

        function move(row, column)
        Moves the PivotTable to a different location in the worksheet.
        Parameters:
        row: Number - row index.
        column: Number - column index.
      • move

        function move(destCellName)
        Moves the PivotTable to a different location in the worksheet.
        Parameters:
        destCellName: String - the dest cell name.