Module - Pivot Table
Set of activities related to MS Excel pivot table. Use the activities to refresh or get names of the existing pivot tables.
Activities
Refresh a specified pivot table.
| Technical Name |
Type |
Minimal Agent Version |
| refresh |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| pivotTableName |
string |
mandatory
|
|
Name of the pivot table to refresh. |
| worksheetName |
string |
optional
|
|
Name of the worksheet containing the pivot table. Default is the active worksheet. |
Sample Code:
//Refresh the pivot table named myPivotTable in the active worksheet. irpa_excel.pivotTable.refresh('myPivotTable');
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
Have you forgotten to open a workbook or activate a worksheet? |
| InvalidArgument |
irpa_core |
Please check the name of the pivot table. |
| EditModeError |
irpa_excel |
Excel is in edit mode and cannot be automated. Please leave the edit mode manually. |
Refresh all pivot tables in the active workbook.
| Technical Name |
Type |
Minimal Agent Version |
| refreshAll |
synchronous
|
WIN-2.0.0
|
Sample Code:
//Refresh all the pivot tables of the active workbook. irpa_excel.pivotTable.refreshAll();
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
Have you forgotten to open a workbook or activate a worksheet? |
| EditModeError |
irpa_excel |
Excel is in edit mode and cannot be automated. Please leave the edit mode manually. |
Retrieve all pivot tables in the specified worksheet or the active worksheet.
| Technical Name |
Type |
Minimal Agent Version |
| getPivotTableNames |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| worksheetName |
string |
optional
|
|
Name of the worksheet containing the pivot tables. Default is the active worksheet. |
Output Parameters:
| Name |
Type |
Description |
| pivotTableNames |
Array. |
List of the pivot table names in the worksheet. |
Sample Code:
//Return list of names of the pivot tables in the active worksheet. const pivotTableNames = irpa_excel.pivotTable.getPivotTableNames();
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
Have you forgotten to open a workbook or activate a worksheet? |
| EditModeError |
irpa_excel |
Excel is in edit mode and cannot be automated. Please leave the edit mode manually. |
