PivotTable
PivotTable class
Summary description for PivotTable.
class PivotTable;
Methods
| Method | Description |
|---|---|
| isExcel2003Compatible() | 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. |
| setIsExcel2003Compatible(boolean) | 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() | Gets the name of the last user who refreshed this PivotTable |
| getRefreshDate() | Gets the last date time when the PivotTable was refreshed. |
| getPivotTableStyleName() | Gets and sets the pivottable style name. |
| setPivotTableStyleName(string) | Gets and sets the pivottable style name. |
| getPivotTableStyleType() | Gets and sets the built-in pivot table style. |
| setPivotTableStyleType(PivotTableStyleType) | Gets and sets the built-in pivot table style. |
| getColumnFields() | Returns a PivotFields object that are currently shown as column fields. |
| getRowFields() | Returns a PivotFields object that are currently shown as row fields. |
| getPageFields() | Returns a PivotFields object that are currently shown as page fields. |
| 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() | Gets a PivotField object that represents all the data fields in a PivotTable. Read-only. It would only be created when there are two or more data fields in the Data region. Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method . |
| getBaseFields() | Returns all base pivot fields in the PivotTable. |
| getPivotFilters() | Returns a list of pivot filters. |
| getColumnRange() | Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only. |
| getRowRange() | Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only. |
| 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() | Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn’t include page fields. Read-only. |
| getTableRange2() | Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only. |
| getColumnGrand() | Indicates whether the PivotTable report shows grand totals for columns. |
| setColumnGrand(boolean) | Indicates whether the PivotTable report shows grand totals for columns. |
| isGridDropZones() | Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid) |
| setIsGridDropZones(boolean) | Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid) |
| getRowGrand() | Indicates whether the PivotTable report shows grand totals for rows. |
| setRowGrand(boolean) | Indicates whether the PivotTable report shows grand totals for rows. |
| getDisplayNullString() | Indicates whether the PivotTable report displays a custom string if the value is null. |
| setDisplayNullString(boolean) | Indicates whether the PivotTable report displays a custom string if the value is null. |
| getNullString() | Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string. |
| setNullString(string) | Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string. |
| getDisplayErrorString() | Indicates whether the PivotTable report displays a custom string in cells that contain errors. |
| setDisplayErrorString(boolean) | Indicates whether the PivotTable report displays a custom string in cells that contain errors. |
| getDataFieldHeaderName() | Gets and sets the name of the value area field header in the PivotTable. |
| setDataFieldHeaderName(string) | Gets and sets the name of the value area field header in the PivotTable. |
| getErrorString() | Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string. |
| setErrorString(string) | Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string. |
| isAutoFormat() | Indicates whether the PivotTable report is automatically formatted. Checkbox “autoformat table " which is in pivottable option for Excel 2003 |
| setIsAutoFormat(boolean) | Indicates whether the PivotTable report is automatically formatted. Checkbox “autoformat table " which is in pivottable option for Excel 2003 |
| getAutofitColumnWidthOnUpdate() | Indicates whether autofitting column width on update |
| setAutofitColumnWidthOnUpdate(boolean) | Indicates whether autofitting column width on update |
| getAutoFormatType() | Gets and sets the auto format type of PivotTable. |
| setAutoFormatType(PivotTableAutoFormatType) | Gets and sets the auto format type of PivotTable. |
| getHasBlankRows() | Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows. |
| setHasBlankRows(boolean) | Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows. |
| getMergeLabels() | True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells. |
| setMergeLabels(boolean) | True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells. |
| getPreserveFormatting() | Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated. |
| setPreserveFormatting(boolean) | Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated. |
| getShowDrill() | Gets and sets whether showing expand/collapse buttons. |
| setShowDrill(boolean) | Gets and sets whether showing expand/collapse buttons. |
| getEnableDrilldown() | Gets whether drilldown is enabled. |
| setEnableDrilldown(boolean) | Gets whether drilldown is enabled. |
| getEnableFieldDialog() | Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field. |
| setEnableFieldDialog(boolean) | Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field. |
| getEnableFieldList() | Gets whether enable the field list for the PivotTable. |
| setEnableFieldList(boolean) | Gets whether enable the field list for the PivotTable. |
| getEnableWizard() | Indicates whether the PivotTable Wizard is available. |
| setEnableWizard(boolean) | Indicates whether the PivotTable Wizard is available. |
| getSubtotalHiddenPageItems() | 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. |
| setSubtotalHiddenPageItems(boolean) | 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() | Returns the text string label that is displayed in the grand total column or row heading. The default value is the string “Grand Total”. |
| setGrandTotalName(string) | 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() | Indicates whether the PivotTable report is recalculated only at the user’s request. |
| setManualUpdate(boolean) | Indicates whether the PivotTable report is recalculated only at the user’s request. |
| isMultipleFieldFilters() | Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| setIsMultipleFieldFilters(boolean) | Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| getMissingItemsLimit() | Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| setMissingItemsLimit(PivotMissingItemLimitType) | Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. |
| getEnableDataValueEditing() | 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 |
| setEnableDataValueEditing(boolean) | 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() | Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells. |
| setShowDataTips(boolean) | Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells. |
| getShowMemberPropertyTips() | Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips. |
| setShowMemberPropertyTips(boolean) | Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips. |
| getShowValuesRow() | Indicates whether showing values row. |
| setShowValuesRow(boolean) | Indicates whether showing values row. |
| getShowEmptyCol() | Specifies a boolean value that indicates whether to include empty columns in the table |
| setShowEmptyCol(boolean) | Specifies a boolean value that indicates whether to include empty columns in the table |
| getShowEmptyRow() | Specifies a boolean value that indicates whether to include empty rows in the table. |
| setShowEmptyRow(boolean) | Specifies a boolean value that indicates whether to include empty rows in the table. |
| getFieldListSortAscending() | Indicates whether fields in the PivotTable are sorted in non-default order in the field list. |
| setFieldListSortAscending(boolean) | Indicates whether fields in the PivotTable are sorted in non-default order in the field list. |
| getPrintDrill() | Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable. |
| setPrintDrill(boolean) | Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable. |
| getAltTextTitle() | Gets and sets the title of the alter text. |
| setAltTextTitle(string) | Gets and sets the title of the alter text. |
| getAltTextDescription() | Gets the description of the alt text. |
| setAltTextDescription(string) | Gets the description of the alt text. |
| getName() | Gets the name of the PivotTable |
| setName(string) | Gets the name of the PivotTable |
| getColumnHeaderCaption() | Gets the Column Header Caption of the PivotTable. |
| setColumnHeaderCaption(string) | Gets the Column Header Caption of the PivotTable. |
| getIndent() | Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form. |
| setIndent(number) | Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form. |
| getRowHeaderCaption() | Gets the Row Header Caption of the PivotTable. |
| setRowHeaderCaption(string) | Gets the Row Header Caption of the PivotTable. |
| getShowRowHeaderCaption() | Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs |
| setShowRowHeaderCaption(boolean) | Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs |
| getCustomListSort() | Indicates whether consider built-in custom list when sort data |
| setCustomListSort(boolean) | Indicates whether consider built-in custom list when sort data |
| getPivotFormatConditions() | Gets the Format Conditions of the pivot table. |
| getPageFieldOrder() | Gets and sets the order in which page fields are added to the PivotTable report’s layout. |
| setPageFieldOrder(PrintOrderType) | Gets and sets the order in which page fields are added to the PivotTable report’s layout. |
| getPageFieldWrapCount() | Gets the number of page fields in each column or row in the PivotTable report. |
| setPageFieldWrapCount(number) | Gets the number of page fields in each column or row in the PivotTable report. |
| getTag() | Gets a string saved with the PivotTable report. |
| setTag(string) | Gets a string saved with the PivotTable report. |
| getSaveData() | Indicates whether data for the PivotTable report is saved with the workbook. |
| setSaveData(boolean) | Indicates whether data for the PivotTable report is saved with the workbook. |
| getRefreshDataOnOpeningFile() | Indicates whether Refresh Data when Opening File. |
| setRefreshDataOnOpeningFile(boolean) | Indicates whether Refresh Data when Opening File. |
| getRefreshDataFlag() | Indicates whether Refreshing Data or not. |
| setRefreshDataFlag(boolean) | Indicates whether Refreshing Data or not. |
| getSourceType() | Gets the data source type of the pivot table. |
| getExternalConnectionDataSource() | Gets the external connection data source. |
| getDataSource() | Gets and sets the data source of the pivot table. |
| setDataSource(string[]) | Gets and sets the data source of the pivot table. |
| getPivotFormats() | Gets the collection of formats applied to PivotTable. |
| getItemPrintTitles() | Indicates whether PivotItem names should be repeated at the top of each printed page. |
| setItemPrintTitles(boolean) | Indicates whether PivotItem names should be repeated at the top of each printed page. |
| getRepeatItemsOnEachPrintedPage() | Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form. |
| setRepeatItemsOnEachPrintedPage(boolean) | Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form. |
| getPrintTitles() | Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false. |
| setPrintTitles(boolean) | Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false. |
| getDisplayImmediateItems() | 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. |
| setDisplayImmediateItems(boolean) | 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() | Indicates whether this PivotTable is selected. |
| setIsSelected(boolean) | Indicates whether this PivotTable is selected. |
| getShowPivotStyleRowHeader() | Indicates whether the row header in the pivot table should have the style applied. |
| setShowPivotStyleRowHeader(boolean) | Indicates whether the row header in the pivot table should have the style applied. |
| getShowPivotStyleColumnHeader() | Indicates whether the column header in the pivot table should have the style applied. |
| setShowPivotStyleColumnHeader(boolean) | Indicates whether the column header in the pivot table should have the style applied. |
| getShowPivotStyleRowStripes() | Indicates whether row stripe formatting is applied. |
| setShowPivotStyleRowStripes(boolean) | Indicates whether row stripe formatting is applied. |
| getShowPivotStyleColumnStripes() | Indicates whether stripe formatting is applied for column. |
| setShowPivotStyleColumnStripes(boolean) | Indicates whether stripe formatting is applied for column. |
| getShowPivotStyleLastColumn() | Indicates whether the column formatting is applied. |
| setShowPivotStyleLastColumn(boolean) | Indicates whether the column formatting is applied. |
| dispose() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| copyStyle(PivotTable) | Copies named style from another pivot table. |
| showReportFilterPage(PivotField) | Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields. |
| showReportFilterPageByName(string) | Show all the report filter pages according to PivotField’s name, the PivotField must be located in the PageFields. |
| showReportFilterPageByIndex(number) | Show all the report filter pages according to the position index in the PageFields |
| removeField(PivotFieldType, string) | Removes a field from specific field area |
| removeField(PivotFieldType, number) | Removes a field from specific field area |
| removeField(PivotFieldType, PivotField) | Remove field from specific field area |
| addFieldToArea(PivotFieldType, string) | Adds the field to the specific area. |
| addFieldToArea(PivotFieldType, number) | Adds the field to the specific area. |
| addFieldToArea(PivotFieldType, PivotField) | Adds the field to the specific area. |
| addCalculatedField(string, string, boolean) | Adds a calculated field to pivot field. |
| addCalculatedField(string, string) | Adds a calculated field to pivot field and drag it to data area. |
| getFields(PivotFieldType) | Gets the specific pivot field list by the region. |
| move(number, number) | Moves the PivotTable to a different location in the worksheet. |
| move(string) | Moves the PivotTable to a different location in the worksheet. |
| getSourceDataConnections() | Gets the external connection data sources. |
| getNamesOfSourceDataConnections() | Gets the name of external source data connections. |
| changeDataSource(string[]) | Set pivottable’s source data. Sheet1!$A$1:$C$3 |
| getSource() | Get pivottable’s source data. |
| refreshData() | Refreshes pivottable’s data and setting from it’s data source. |
| refreshData(PivotTableRefreshOption) | Refreshes pivottable’s data and setting from it’s data source with options. |
| calculateData() | Calculates pivottable’s data to cells. |
| calculateData(PivotTableCalculateOption) | Calculating pivot tables with options |
| clearData() | Clear PivotTable’s data and formatting |
| calculateRange() | Calculates pivottable’s range. |
| formatAll(Style) | Format all the cell in the pivottable area |
| formatRow(number, Style) | Format the row data in the pivottable area |
| format(PivotArea, Style) | Formats selected area of the PivotTable. |
| format(number, number, Style) | Format the cell in the pivottable area |
| showDetail(number, number, boolean, number, number) | Show the detail of one item in the data region to a new Table. |
| showInCompactForm() | Layouts the PivotTable in compact form. |
| showInOutlineForm() | Layouts the PivotTable in outline form. |
| showInTabularForm() | Layouts the PivotTable in tabular form. |
| getCellByDisplayName(string) | Gets the Cell object by the display name of PivotField. |
| getChildren() | Gets the Children Pivot Tables which use this PivotTable data as data source. |
| isNull() | Checks whether the implementation object is null. |
isExcel2003Compatible()
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.
isExcel2003Compatible() : boolean;
setIsExcel2003Compatible(boolean)
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.
setIsExcel2003Compatible(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getRefreshedByWho()
Gets the name of the last user who refreshed this PivotTable
getRefreshedByWho() : string;
getRefreshDate()
Gets the last date time when the PivotTable was refreshed.
getRefreshDate() : Date;
getPivotTableStyleName()
Gets and sets the pivottable style name.
getPivotTableStyleName() : string;
setPivotTableStyleName(string)
Gets and sets the pivottable style name.
setPivotTableStyleName(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getPivotTableStyleType()
Gets and sets the built-in pivot table style.
getPivotTableStyleType() : PivotTableStyleType;
Returns
setPivotTableStyleType(PivotTableStyleType)
Gets and sets the built-in pivot table style.
setPivotTableStyleType(value: PivotTableStyleType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PivotTableStyleType | The value to set. |
getColumnFields()
Returns a PivotFields object that are currently shown as column fields.
getColumnFields() : PivotFieldCollection;
Returns
getRowFields()
Returns a PivotFields object that are currently shown as row fields.
getRowFields() : PivotFieldCollection;
Returns
getPageFields()
Returns a PivotFields object that are currently shown as page fields.
getPageFields() : PivotFieldCollection;
Returns
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.
getDataFields() : PivotFieldCollection;
Returns
getDataField()
Gets a PivotField object that represents all the data fields in a PivotTable. Read-only. It would only be created when there are two or more data fields in the Data region. Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method .
getDataField() : PivotField;
Returns
getBaseFields()
Returns all base pivot fields in the PivotTable.
getBaseFields() : PivotFieldCollection;
Returns
getPivotFilters()
Returns a list of pivot filters.
getPivotFilters() : PivotFilterCollection;
Returns
getColumnRange()
Returns a CellArea object that represents the range that contains the column area in the PivotTable report. Read-only.
getColumnRange() : CellArea;
Returns
getRowRange()
Returns a CellArea object that represents the range that contains the row area in the PivotTable report. Read-only.
getRowRange() : CellArea;
Returns
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.
getDataBodyRange() : CellArea;
Returns
getTableRange1()
Returns a CellArea object that represents the range containing the entire PivotTable report, but doesn’t include page fields. Read-only.
getTableRange1() : CellArea;
Returns
getTableRange2()
Returns a CellArea object that represents the range containing the entire PivotTable report, includes page fields. Read-only.
getTableRange2() : CellArea;
Returns
getColumnGrand()
Indicates whether the PivotTable report shows grand totals for columns.
getColumnGrand() : boolean;
setColumnGrand(boolean)
Indicates whether the PivotTable report shows grand totals for columns.
setColumnGrand(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
isGridDropZones()
Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
isGridDropZones() : boolean;
setIsGridDropZones(boolean)
Indicates whether the PivotTable report displays classic pivottable layout. (enables dragging fields in the grid)
setIsGridDropZones(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getRowGrand()
Indicates whether the PivotTable report shows grand totals for rows.
getRowGrand() : boolean;
setRowGrand(boolean)
Indicates whether the PivotTable report shows grand totals for rows.
setRowGrand(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getDisplayNullString()
Indicates whether the PivotTable report displays a custom string if the value is null.
getDisplayNullString() : boolean;
setDisplayNullString(boolean)
Indicates whether the PivotTable report displays a custom string if the value is null.
setDisplayNullString(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getNullString()
Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
getNullString() : string;
setNullString(string)
Gets the string displayed in cells that contain null values when the DisplayNullString property is true.The default value is an empty string.
setNullString(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getDisplayErrorString()
Indicates whether the PivotTable report displays a custom string in cells that contain errors.
getDisplayErrorString() : boolean;
setDisplayErrorString(boolean)
Indicates whether the PivotTable report displays a custom string in cells that contain errors.
setDisplayErrorString(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getDataFieldHeaderName()
Gets and sets the name of the value area field header in the PivotTable.
getDataFieldHeaderName() : string;
setDataFieldHeaderName(string)
Gets and sets the name of the value area field header in the PivotTable.
setDataFieldHeaderName(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getErrorString()
Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
getErrorString() : string;
setErrorString(string)
Gets the string displayed in cells that contain errors when the DisplayErrorString property is true.The default value is an empty string.
setErrorString(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
isAutoFormat()
Indicates whether the PivotTable report is automatically formatted. Checkbox “autoformat table " which is in pivottable option for Excel 2003
isAutoFormat() : boolean;
setIsAutoFormat(boolean)
Indicates whether the PivotTable report is automatically formatted. Checkbox “autoformat table " which is in pivottable option for Excel 2003
setIsAutoFormat(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getAutofitColumnWidthOnUpdate()
Indicates whether autofitting column width on update
getAutofitColumnWidthOnUpdate() : boolean;
setAutofitColumnWidthOnUpdate(boolean)
Indicates whether autofitting column width on update
setAutofitColumnWidthOnUpdate(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getAutoFormatType()
Gets and sets the auto format type of PivotTable.
getAutoFormatType() : PivotTableAutoFormatType;
Returns
setAutoFormatType(PivotTableAutoFormatType)
Gets and sets the auto format type of PivotTable.
setAutoFormatType(value: PivotTableAutoFormatType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PivotTableAutoFormatType | The value to set. |
getHasBlankRows()
Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
getHasBlankRows() : boolean;
setHasBlankRows(boolean)
Indicates whether to add blank rows. This property only applies for the PivotTable auto format types which needs to add blank rows.
setHasBlankRows(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getMergeLabels()
True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells.
getMergeLabels() : boolean;
setMergeLabels(boolean)
True if the specified PivotTable report’s outer-row item, column item, subtotal, and grand total labels use merged cells.
setMergeLabels(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getPreserveFormatting()
Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
getPreserveFormatting() : boolean;
setPreserveFormatting(boolean)
Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated.
setPreserveFormatting(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowDrill()
Gets and sets whether showing expand/collapse buttons.
getShowDrill() : boolean;
setShowDrill(boolean)
Gets and sets whether showing expand/collapse buttons.
setShowDrill(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getEnableDrilldown()
Gets whether drilldown is enabled.
getEnableDrilldown() : boolean;
setEnableDrilldown(boolean)
Gets whether drilldown is enabled.
setEnableDrilldown(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getEnableFieldDialog()
Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
getEnableFieldDialog() : boolean;
setEnableFieldDialog(boolean)
Indicates whether the PivotTable Field dialog box is available when the user double-clicks the PivotTable field.
setEnableFieldDialog(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getEnableFieldList()
Gets whether enable the field list for the PivotTable.
getEnableFieldList() : boolean;
setEnableFieldList(boolean)
Gets whether enable the field list for the PivotTable.
setEnableFieldList(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getEnableWizard()
Indicates whether the PivotTable Wizard is available.
getEnableWizard() : boolean;
setEnableWizard(boolean)
Indicates whether the PivotTable Wizard is available.
setEnableWizard(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getSubtotalHiddenPageItems()
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.
getSubtotalHiddenPageItems() : boolean;
setSubtotalHiddenPageItems(boolean)
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.
setSubtotalHiddenPageItems(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getGrandTotalName()
Returns the text string label that is displayed in the grand total column or row heading. The default value is the string “Grand Total”.
getGrandTotalName() : string;
setGrandTotalName(string)
Returns the text string label that is displayed in the grand total column or row heading. The default value is the string “Grand Total”.
setGrandTotalName(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getManualUpdate()
Indicates whether the PivotTable report is recalculated only at the user’s request.
getManualUpdate() : boolean;
setManualUpdate(boolean)
Indicates whether the PivotTable report is recalculated only at the user’s request.
setManualUpdate(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
isMultipleFieldFilters()
Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
isMultipleFieldFilters() : boolean;
setIsMultipleFieldFilters(boolean)
Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
setIsMultipleFieldFilters(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getMissingItemsLimit()
Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
getMissingItemsLimit() : PivotMissingItemLimitType;
Returns
setMissingItemsLimit(PivotMissingItemLimitType)
Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them.
setMissingItemsLimit(value: PivotMissingItemLimitType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PivotMissingItemLimitType | The value to set. |
getEnableDataValueEditing()
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
getEnableDataValueEditing() : boolean;
setEnableDataValueEditing(boolean)
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
setEnableDataValueEditing(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowDataTips()
Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
getShowDataTips() : boolean;
setShowDataTips(boolean)
Specifies a boolean value that indicates whether tooltips should be displayed for PivotTable data cells.
setShowDataTips(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowMemberPropertyTips()
Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
getShowMemberPropertyTips() : boolean;
setShowMemberPropertyTips(boolean)
Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips.
setShowMemberPropertyTips(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowValuesRow()
Indicates whether showing values row.
getShowValuesRow() : boolean;
setShowValuesRow(boolean)
Indicates whether showing values row.
setShowValuesRow(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowEmptyCol()
Specifies a boolean value that indicates whether to include empty columns in the table
getShowEmptyCol() : boolean;
setShowEmptyCol(boolean)
Specifies a boolean value that indicates whether to include empty columns in the table
setShowEmptyCol(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowEmptyRow()
Specifies a boolean value that indicates whether to include empty rows in the table.
getShowEmptyRow() : boolean;
setShowEmptyRow(boolean)
Specifies a boolean value that indicates whether to include empty rows in the table.
setShowEmptyRow(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getFieldListSortAscending()
Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
getFieldListSortAscending() : boolean;
setFieldListSortAscending(boolean)
Indicates whether fields in the PivotTable are sorted in non-default order in the field list.
setFieldListSortAscending(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getPrintDrill()
Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.
getPrintDrill() : boolean;
setPrintDrill(boolean)
Specifies a boolean value that indicates whether drill indicators should be printed. print expand/collapse buttons when displayed on pivottable.
setPrintDrill(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getAltTextTitle()
Gets and sets the title of the alter text.
getAltTextTitle() : string;
setAltTextTitle(string)
Gets and sets the title of the alter text.
setAltTextTitle(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getAltTextDescription()
Gets the description of the alt text.
getAltTextDescription() : string;
setAltTextDescription(string)
Gets the description of the alt text.
setAltTextDescription(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getName()
Gets the name of the PivotTable
getName() : string;
setName(string)
Gets the name of the PivotTable
setName(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getColumnHeaderCaption()
Gets the Column Header Caption of the PivotTable.
getColumnHeaderCaption() : string;
setColumnHeaderCaption(string)
Gets the Column Header Caption of the PivotTable.
setColumnHeaderCaption(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getIndent()
Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
getIndent() : number;
setIndent(number)
Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
setIndent(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getRowHeaderCaption()
Gets the Row Header Caption of the PivotTable.
getRowHeaderCaption() : string;
setRowHeaderCaption(string)
Gets the Row Header Caption of the PivotTable.
setRowHeaderCaption(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getShowRowHeaderCaption()
Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
getShowRowHeaderCaption() : boolean;
setShowRowHeaderCaption(boolean)
Indicates whether row header caption is shown in the PivotTable report Indicates whether Display field captions and filter drop downs
setShowRowHeaderCaption(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getCustomListSort()
Indicates whether consider built-in custom list when sort data
getCustomListSort() : boolean;
setCustomListSort(boolean)
Indicates whether consider built-in custom list when sort data
setCustomListSort(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getPivotFormatConditions()
Gets the Format Conditions of the pivot table.
getPivotFormatConditions() : PivotFormatConditionCollection;
Returns
PivotFormatConditionCollection
getPageFieldOrder()
Gets and sets the order in which page fields are added to the PivotTable report’s layout.
getPageFieldOrder() : PrintOrderType;
Returns
setPageFieldOrder(PrintOrderType)
Gets and sets the order in which page fields are added to the PivotTable report’s layout.
setPageFieldOrder(value: PrintOrderType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PrintOrderType | The value to set. |
getPageFieldWrapCount()
Gets the number of page fields in each column or row in the PivotTable report.
getPageFieldWrapCount() : number;
setPageFieldWrapCount(number)
Gets the number of page fields in each column or row in the PivotTable report.
setPageFieldWrapCount(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getTag()
Gets a string saved with the PivotTable report.
getTag() : string;
setTag(string)
Gets a string saved with the PivotTable report.
setTag(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getSaveData()
Indicates whether data for the PivotTable report is saved with the workbook.
getSaveData() : boolean;
setSaveData(boolean)
Indicates whether data for the PivotTable report is saved with the workbook.
setSaveData(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getRefreshDataOnOpeningFile()
Indicates whether Refresh Data when Opening File.
getRefreshDataOnOpeningFile() : boolean;
setRefreshDataOnOpeningFile(boolean)
Indicates whether Refresh Data when Opening File.
setRefreshDataOnOpeningFile(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getRefreshDataFlag()
Indicates whether Refreshing Data or not.
getRefreshDataFlag() : boolean;
setRefreshDataFlag(boolean)
Indicates whether Refreshing Data or not.
setRefreshDataFlag(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getSourceType()
Gets the data source type of the pivot table.
getSourceType() : PivotTableSourceType;
Returns
getExternalConnectionDataSource()
Gets the external connection data source.
getExternalConnectionDataSource() : ExternalConnection;
Returns
Remarks
NOTE: This property is now obsolete. Instead, please use pivotTable.GetSourceDataConnections() method. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
getDataSource()
Gets and sets the data source of the pivot table.
getDataSource() : string[];
Returns
string[]
setDataSource(string[])
Gets and sets the data source of the pivot table.
setDataSource(value: string[]) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string[] | The value to set. |
getPivotFormats()
Gets the collection of formats applied to PivotTable.
getPivotFormats() : PivotTableFormatCollection;
Returns
getItemPrintTitles()
Indicates whether PivotItem names should be repeated at the top of each printed page.
getItemPrintTitles() : boolean;
Remarks
NOTE: This property is now obsolete. Instead, please use PivotTable.RepeatItemsOnEachPrintedPage property. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
setItemPrintTitles(boolean)
Indicates whether PivotItem names should be repeated at the top of each printed page.
setItemPrintTitles(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
NOTE: This property is now obsolete. Instead, please use PivotTable.RepeatItemsOnEachPrintedPage property. This method will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
getRepeatItemsOnEachPrintedPage()
Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.
getRepeatItemsOnEachPrintedPage() : boolean;
setRepeatItemsOnEachPrintedPage(boolean)
Indicates whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.
setRepeatItemsOnEachPrintedPage(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getPrintTitles()
Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
getPrintTitles() : boolean;
setPrintTitles(boolean)
Indicates whether the print titles for the worksheet are set based on the PivotTable report. The default value is false.
setPrintTitles(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getDisplayImmediateItems()
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.
getDisplayImmediateItems() : boolean;
setDisplayImmediateItems(boolean)
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.
setDisplayImmediateItems(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
isSelected()
Indicates whether this PivotTable is selected.
isSelected() : boolean;
setIsSelected(boolean)
Indicates whether this PivotTable is selected.
setIsSelected(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowPivotStyleRowHeader()
Indicates whether the row header in the pivot table should have the style applied.
getShowPivotStyleRowHeader() : boolean;
setShowPivotStyleRowHeader(boolean)
Indicates whether the row header in the pivot table should have the style applied.
setShowPivotStyleRowHeader(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowPivotStyleColumnHeader()
Indicates whether the column header in the pivot table should have the style applied.
getShowPivotStyleColumnHeader() : boolean;
setShowPivotStyleColumnHeader(boolean)
Indicates whether the column header in the pivot table should have the style applied.
setShowPivotStyleColumnHeader(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowPivotStyleRowStripes()
Indicates whether row stripe formatting is applied.
getShowPivotStyleRowStripes() : boolean;
setShowPivotStyleRowStripes(boolean)
Indicates whether row stripe formatting is applied.
setShowPivotStyleRowStripes(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowPivotStyleColumnStripes()
Indicates whether stripe formatting is applied for column.
getShowPivotStyleColumnStripes() : boolean;
setShowPivotStyleColumnStripes(boolean)
Indicates whether stripe formatting is applied for column.
setShowPivotStyleColumnStripes(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowPivotStyleLastColumn()
Indicates whether the column formatting is applied.
getShowPivotStyleLastColumn() : boolean;
setShowPivotStyleLastColumn(boolean)
Indicates whether the column formatting is applied.
setShowPivotStyleLastColumn(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
dispose() : void;
copyStyle(PivotTable)
Copies named style from another pivot table.
copyStyle(pivotTable: PivotTable) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pivotTable | PivotTable | Source pivot table. |
showReportFilterPage(PivotField)
Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields.
showReportFilterPage(pageField: PivotField) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pageField | PivotField | The PivotField object |
showReportFilterPageByName(string)
Show all the report filter pages according to PivotField’s name, the PivotField must be located in the PageFields.
showReportFilterPageByName(fieldName: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fieldName | string | The name of PivotField |
showReportFilterPageByIndex(number)
Show all the report filter pages according to the position index in the PageFields
showReportFilterPageByIndex(posIndex: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| posIndex | number | The position index in the PageFields |
removeField(PivotFieldType, string)
Removes a field from specific field area
removeField(fieldType: PivotFieldType, fieldName: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fieldType | PivotFieldType | The fields area type. |
| fieldName | string | The name in the base fields. |
removeField(PivotFieldType, number)
Removes a field from specific field area
removeField(fieldType: PivotFieldType, baseFieldIndex: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fieldType | PivotFieldType | The fields area type. |
| baseFieldIndex | number | The field index in the base fields. |
removeField(PivotFieldType, PivotField)
Remove field from specific field area
removeField(fieldType: PivotFieldType, pivotField: PivotField) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fieldType | PivotFieldType | the fields area type. |
| pivotField | PivotField | the field in the base fields. |
addFieldToArea(PivotFieldType, string)
Adds the field to the specific area.
addFieldToArea(fieldType: PivotFieldType, fieldName: string) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fieldType | PivotFieldType | 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(PivotFieldType, number)
Adds the field to the specific area.
addFieldToArea(fieldType: PivotFieldType, baseFieldIndex: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fieldType | PivotFieldType | The fields area type. |
| baseFieldIndex | number | The field index in the base fields. |
Returns
The field position in the specific fields.
addFieldToArea(PivotFieldType, PivotField)
Adds the field to the specific area.
addFieldToArea(fieldType: PivotFieldType, pivotField: PivotField) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fieldType | PivotFieldType | the fields area type. |
| pivotField | PivotField | the field in the base fields. |
Returns
the field position in the specific fields.
addCalculatedField(string, string, boolean)
Adds a calculated field to pivot field.
addCalculatedField(name: string, formula: string, dragToDataArea: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| 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(string, string)
Adds a calculated field to pivot field and drag it to data area.
addCalculatedField(name: string, formula: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | string | The name of the calculated field |
| formula | string | The formula of the calculated field. |
getFields(PivotFieldType)
Gets the specific pivot field list by the region.
getFields(fieldType: PivotFieldType) : PivotFieldCollection;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fieldType | PivotFieldType | the region type. |
Returns
the specific pivot field collection
move(number, number)
Moves the PivotTable to a different location in the worksheet.
move(row: number, column: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| row | number | row index. |
| column | number | column index. |
move(string)
Moves the PivotTable to a different location in the worksheet.
move(destCellName: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| destCellName | string | the dest cell name. |
getSourceDataConnections()
Gets the external connection data sources.
getSourceDataConnections() : ExternalConnection[];
Returns
getNamesOfSourceDataConnections()
Gets the name of external source data connections.
getNamesOfSourceDataConnections() : string[];
Returns
string[]
changeDataSource(string[])
Set pivottable’s source data. Sheet1!$A$1:$C$3
changeDataSource(source: string[]) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| source | string[] |
getSource()
Get pivottable’s source data.
getSource() : string[];
Returns
string[]
refreshData()
Refreshes pivottable’s data and setting from it’s data source.
refreshData() : PivotRefreshState;
Returns
Remarks
We will gather data from data source to a pivot cache ,then calculate the data in the cache to the cells. This method is only used to gather all data to a pivot cache.
refreshData(PivotTableRefreshOption)
Refreshes pivottable’s data and setting from it’s data source with options.
refreshData(option: PivotTableRefreshOption) : PivotRefreshState;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| option | PivotTableRefreshOption | The options for refreshing data source of pivot table. |
Returns
calculateData()
Calculates pivottable’s data to cells.
calculateData() : void;
Remarks
Cell.Value in the pivot range could not return the correct result if the method is not been called. This method calculates data with an inner pivot cache,not original data source. So if the data source is changed, please call RefreshData() method first.
calculateData(PivotTableCalculateOption)
Calculating pivot tables with options
calculateData(option: PivotTableCalculateOption) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| option | PivotTableCalculateOption |
clearData()
Clear PivotTable’s data and formatting
clearData() : void;
Remarks
If this method is not called before you add or delete PivotField, Maybe the PivotTable data is not corrected
calculateRange()
Calculates pivottable’s range.
calculateRange() : void;
Remarks
If this method is not been called,maybe the pivottable range is not corrected.
formatAll(Style)
Format all the cell in the pivottable area
formatAll(style: Style) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| style | Style | Style which is to format |
formatRow(number, Style)
Format the row data in the pivottable area
formatRow(row: number, style: Style) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| row | number | Row Index of the Row object |
| style | Style | Style which is to format |
format(PivotArea, Style)
Formats selected area of the PivotTable.
format(pivotArea: PivotArea, style: Style) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pivotArea | PivotArea | |
| style | Style |
format(number, number, Style)
Format the cell in the pivottable area
format(row: number, column: number, style: Style) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| row | number | Row Index of the cell |
| column | number | Column index of the cell |
| style | Style | Style which is to format the cell |
showDetail(number, number, boolean, number, number)
Show the detail of one item in the data region to a new Table.
showDetail(rowOffset: number, columnOffset: number, newSheet: boolean, destRow: number, destColumn: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rowOffset | number | Offset to the first data row in the data region. |
| columnOffset | number | Offset to the first data column in the data region. |
| newSheet | boolean | Show the detail to a new worksheet. |
| destRow | number | The target row. |
| destColumn | number | The target column. |
showInCompactForm()
Layouts the PivotTable in compact form.
showInCompactForm() : void;
showInOutlineForm()
Layouts the PivotTable in outline form.
showInOutlineForm() : void;
showInTabularForm()
Layouts the PivotTable in tabular form.
showInTabularForm() : void;
getCellByDisplayName(string)
Gets the Cell object by the display name of PivotField.
getCellByDisplayName(displayName: string) : Cell;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| displayName | string | the DisplayName of PivotField |
Returns
the Cell object
getChildren()
Gets the Children Pivot Tables which use this PivotTable data as data source.
getChildren() : PivotTable[];
Returns
the PivotTable array object
isNull()
Checks whether the implementation object is null.
isNull() : boolean;