Generate and Edit Pivot Table
| API | Description | Example |
|---|---|---|
| Workbook.PivotCaches | Function that returns an object for managing all pivot table caches in the workbook | let workbook = instance.Application.ActiveWorkbook; let pivotCaches = workbook.PivotCaches(); |
| PivotCaches.Count | Property that returns the number of all pivot table caches in the workbook | let workbook = instance.Application.ActiveWorkbook; let pivotCaches = workbook.PivotCaches(); console.log(pivotCaches.Count); |
| PivotCaches.Create | Function that creates a new pivot table cache | let workbook = instance.Application.ActiveWorkbook; let pivotCaches = workbook.PivotCaches(); pivotCaches.Create({ SourceType: instance.Enums.XlPivotTableSourceType.xlDatabase, SourceData: worksheet.Name + "!A1:P701", Version: 8 }); |
| PivotCaches.Item | Function that returns a pivot table cache object at a specific index | let workbook = instance.Application.ActiveWorkbook; let pivotCaches = workbook.PivotCaches(); let pivotCache = pivotCaches.Item(1); |
| PivotCache.CreatePivotTable | Function that creates a pivot table based on a pivot table cache | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotCaches = workbook.PivotCaches(); let pivotCache = pivotCaches.Create({ SourceType: instance.Enums.XlPivotTableSourceType.xlDatabase, SourceData: worksheet.Name + "!A1:P701", Version: 8 }); let pivotSheet = workbook.Worksheets.Add(); let pivotTable = pivotCache.CreatePivotTable({ TableDestination: pivotSheet.Name + "!A3", TableName: "PivotTable 1", DefaultVersion: 8 }); |
| PivotCache.Refresh | Function that refreshes the pivot table cache | let workbook = instance.Application.ActiveWorkbook; let pivotCaches = workbook.PivotCaches(); let pivotCache = pivotCaches.Item(1); pivotCache.Refresh(); |
| Worksheet.PivotTables | Function that returns the object managing pivot tables within the sheet Note: When an index is passed as a parameter, returns the pivot table object for that index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); // Returns object managing pivot tables within the sheet let pivotTable = worksheet.PivotTables(1); // Returns pivot table object for specific index within the sheet |
| PivotTables.Count | Property that returns the number of pivot tables | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); console.log(pivotTables.Count); |
| PivotTables.Add | Function that adds a pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotCaches = workbook.PivotCaches(); let pivotCache = pivotCaches.Create({ SourceType: instance.Enums.XlPivotTableSourceType.xlDatabase, SourceData: worksheet.Name + "!A1:P701", Version: 8 }); let pivotSheet = workbook.Worksheets.Add(); let pivotTables = pivotSheet.PivotTables(); let pivotTable = pivotTables.Add({ PivotCache: pivotCache, TableDestination: pivotSheet.Name + "!A3", TableName: "PivotTable 1", DefaultVersion: 8 }); |
| PivotTables.Item | Function that returns a pivot table object at a specific index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); |
| PivotTable.ColumnGrand | Property that returns or changes whether to display the column grand totals | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); console.log(pivotTable.ColumnGrand); pivotTable.ColumnGrand = true; |
| PivotTable.ColumnRange | Property that returns a range object that includes the column area of the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let range = pivotTable.ColumnRange; |
| PivotTable.DataBodyRange | Property that returns the range object corresponding to the values area of the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let range = pivotTable.DataBodyRange; |
| PivotTable.DataLabelRange | Property that returns a range object that includes the labels of the data fields in the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let range = pivotTable.DataLabelRange; |
| PivotTable.DataPivotField | Property that returns the pivot field object that manages all data fields of the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotField = pivotTable.DataPivotField; |
| PivotTable.EnableDataValueEditing | Property that returns or changes whether to allow direct editing of the pivot table's data area | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); console.log(pivotTable.EnableDataValueEditing); pivotTable.EnableDataValueEditing = false; |
| PivotTable.GrandTotalName | Property that returns or changes the label of the grand total column or row of the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); console.log(pivotTable.GrandTotalName); pivotTable.GrandTotalName = "Regional Total"; |
| PivotTable.Name | Property that returns or changes the name of the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); console.log(pivotTable.Name); pivotTable.Name = "PivotTable 1"; |
| PivotTable.PageRange | Property that returns a range object that includes the page area of the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let range = pivotTable.PageRange; |
| PivotTable.RowGrand | Property that returns or changes whether to display the row grand totals | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); console.log(pivotTable.RowGrand); pivotTable.RowGrand = true; |
| PivotTable.RowRange | Property that returns a range object that includes the row area of the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let range = pivotTable.RowRange; |
| PivotTable.TableRange1 | Property that returns a range object that includes the entire pivot table excluding the page fields | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let range = pivotTable.TableRange1; |
| PivotTable.TableRange2 | Property that returns a range object that includes the entire pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let range = pivotTable.TableRange2; |
| PivotTable.TableStyle2 | Property that returns or changes the style of the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); console.log(pivotTable.TableStyle2); pivotTable.TableStyle2 = "PivotStyleLight1"; |
| PivotTable.ColumnFields | Function that returns the pivot field manager object that manages the column fields within the pivot table Note: When an index is passed as a parameter, returns the pivot field object that manages the column field of that index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); // Returns the Pivot Field Management Object. let pivotField = pivotTable.ColumnFields(1); // Returns the Pivot Field Object at the specified index. |
| PivotFields.Count | Property that returns the number of pivot fields | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); console.log(pivotFields.Count); |
| PivotFields.Item | Function that returns a pivot field object at a specific index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); |
| PivotField.AutoSortField | Property that returns the auto-sort mode of the pivot field as a string | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.AutoSortField); |
| PivotField.AutoSortOrder | Property that returns the auto-sort mode of the pivot field as an enum value | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.AutoSortOrder); |
| PivotField.BaseField | Property that returns or changes the base field to which the pivot field calculation method is applied Note: Works properly only when it is a data field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.DataFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.BaseField); pivotField.BaseField = "ORDER_DATE"; |
| PivotField.BaseItem | Property that returns or changes the base pivot item of the base field to which the pivot field calculation method is applied Note: Works properly only when it is a data field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.DataFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.BaseItem); pivotField.BaseItem = "5/16/89"; |
| PivotField.Calculation | Property that returns or changes the calculation method of the pivot field Note: Works properly only when it is a data field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.DataFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.Calculation); pivotField.Calculation = instance.Enums.XlPivotFieldCalculation.xlDifferenceFrom; |
| PivotField.Caption | Property that returns or changes the label of the pivot field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.Caption); pivotField.Caption = "Sum : Sale Price"; |
| PivotField.ChildField | Property that returns the child pivot field object of the pivot field Note: Works properly when grouped and a child pivot field is specified | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let childField = pivotField.ChildField; |
| PivotField.DataRange | Property that returns the range object containing the pivot field's data | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let range = pivotField.DataRange; |
| PivotField.DragToColumn | Property that returns or changes whether the pivot field can be dragged to the column position | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.DragToColumn); pivotField.DragToColumn = true; |
| PivotField.DragToData | Property that returns or changes whether the pivot field can be dragged to the data position | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.DragToData); pivotField.DragToData = true; |
| PivotField.DragToHide | Property that returns or changes whether the pivot field can be hidden by dragging | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.DragToHide); pivotField.DragToHide = true; |
| PivotField.DragToPage | Property that returns or changes whether the pivot field can be dragged to the page position | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.DragToPage); pivotField.DragToPage = true; |
| PivotField.DragToRow | Property that returns or changes whether the pivot field can be dragged to the row position | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.DragToRow); pivotField.DragToRow = true; |
| PivotField.Function | Property that returns or changes the type of function used to summarize the pivot field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.Function); pivotField.Function = instance.Enums.XlConsolidationFunction.xlSum; |
| PivotField.GroupLevel | Property that returns the position of a specific pivot field in the pivot field group | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.GroupLevel); |
| PivotField.LabelRange | Property that returns the range object containing the pivot field labels | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let range = pivotField.LabelRange; |
| PivotField.Name | Property that returns or changes the name of the pivot field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.Name); pivotField.Name = "Sum : Sale Price"; |
| PivotField.NumberFormat | Property that returns or changes the display format of the pivot field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.NumberFormat); pivotField.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \"-\"??_);_(@_)"; |
| PivotField.Orientation | Property that returns or changes the orientation of the pivot field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); console.log(pivotTable.PivotFields.Item(1).Orientation); pivotTable.PivotFields(1).Orientation = instance.Enums.XlPivotFieldOrientation.xlRowField; pivotTable.PivotFields(3).Orientation = instance.Enums.XlPivotFieldOrientation.xlColumnField; pivotTable.PivotFields(7).Orientation = instance.Enums.XlPivotFieldOrientation.xlDataField; |
| PivotField.ParentField | Property that returns the parent pivot field object of the pivot field Note: Works correctly when grouped and a parent pivot field is assigned | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let parentField = pivotField.ParentField; |
| PivotField.Position | Property that returns or changes the position of the pivot field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.Position); pivotField.Position = 1; |
| PivotField.SourceName | Property that returns the name of the source data of the pivot field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.SourceName); |
| PivotField.SubtotalName | Property that returns the name of the pivot field's subtotal | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.SubtotalName); |
| PivotField.Value | Property that returns or changes the name of the pivot field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); console.log(pivotField.Value); pivotField.Value = "Sum : Sale Price"; |
| PivotField.ChildItems | Function that returns the object that manages the child pivot items of the pivot field Note: When an index is passed as a parameter, returns the pivot item object for that index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.ChildItems(); // Returns pivot item management object let pivotItem = pivotField.ChildItems(1); // Returns the pivot item object for a specific index |
| PivotItems.Count | Property that returns the number of pivot items | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.ChildItems(); console.log(pivotItems.Count); |
| PivotItems.Add | Function that adds a pivot item | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.ChildItems(); pivotItems.Add("1998"); |
| PivotItems.Item | Function that returns the pivot item object for a specific index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.ChildItems(); let pivotItem = pivotItems.Item(1); |
| PivotItem.Caption | Property that returns or changes the label of the pivot item | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.ChildItems(); let pivotItem = pivotItems.Item(1); console.log(pivotItem.Caption); pivotItem.Caption = "Amarilla"; |
| PivotItem.Name | Property that returns or changes the name of the pivot item | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.ChildItems(); let pivotItem = pivotItems.Item(1); console.log(pivotItem.Name); pivotItem.Name = "Amarilla"; |
| PivotItem.Position | Property that returns or changes the position of the pivot item within the pivot field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.ChildItems(); let pivotItem = pivotItems.Item(1); console.log(pivotItem.Position); pivotItem.Position = 1; |
| PivotItem.SourceName | Property that returns the name of the source data of the pivot item | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.ChildItems(); let pivotItem = pivotItems.Item(1); console.log(pivotItem.SourceName); pivotItem.SourceName = "Amarilla"; |
| PivotItem.Value | Property that returns or changes the name of the pivot item | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.ChildItems(); let pivotItem = pivotItems.Item(1); console.log(pivotItem.Value); pivotItem.Value = "Amarilla"; |
| PivotItem.Visible | Property that returns or changes the visibility state of the pivot item | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.ChildItems(); let pivotItem = pivotItems.Item(1); console.log(pivotItem.Visible); pivotItem.Visible = false; |
| PivotItem.ChildItems | Function that returns the object that manages the child pivot items of the pivot item Note: When an index is passed as a parameter, returns the pivot item object for that index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.ChildItems(); let pivotItem = pivotItems.Item(1); let childItems = pivotItem.ChildItems(); // Returns pivot item management object let childItem = pivotItem.ChildItems(1); // Returns the pivot item object for a specific index |
| PivotItem.Delete | Function that removes a pivot item | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.ChildItems(); let pivotItem = pivotItems.Item(1); pivotItem.Delete(); |
| PivotField.HiddenItems | Function that returns the object that manages hidden pivot items of the pivot field Note: When an index is passed as a parameter, returns the pivot item object for that index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.HiddenItems(); // Returns pivot item management object let pivotItem = pivotField.HiddenItems(1); // Returns the pivot item object for a specific index |
| PivotField.Subtotals | Function that returns whether the pivot field's subtotals are displayed Note 1) The display status is determined as true/false for the following 12 items Index items 1 Automatic 2 Sum 3 Count 4 Average 5 Max 6 Min 7 Product 8 Count Nums 9 StdDev 10 StdDevp 11 Var 12 Varp Note 2) If 'Automatic' corresponding to index 1 is true, all other values are false Note 3) When an index is passed as a parameter, the display status of the corresponding index's subtotal is returned, and it works correctly only when it is not a data field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let subtotalList = pivotField.Subtotals(); // Returns the Subtotal Display Status Array. let subtotalAutomatic = pivotField.Subtotals(1); // Returns the subtotal display status at the specified index. |
| PivotField.SetSubtotals | Function that changes whether the pivot field's subtotals are displayed Note 1) The display status is determined as true/false for the following 12 items Index items 1 Automatic 2 Sum 3 Count 4 Average 5 Max 6 Min 7 Product 8 Count Nums 9 StdDev 10 StdDevp 11 Var 12 Varp cf 2) If Automatic (index 1) is true, all other values are false cf 3) When the index is passed as a parameter, whether the subtotal is displayed at that index is changed; operates normally only when it is not a data field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); const subtotals = [ false, true, true, true, false, false, false, false, false, false, false, false ]; pivotField.SetSubtotals(null, subtotals); // Change display for all subtotals using array form pivotField.SetSubtotals(1, true); // Change whether subtotal is displayed at a specific index |
| PivotField.VisibleItems | Function that returns an object that manages the visible pivot items of the pivot field cf) When an index is passed as a parameter, returns the pivot item object at that index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.VisibleItems(); // Returns pivot item manager object let pivotItem = pivotField.VisibleItems(1); // Returns pivot item object at specific index |
| PivotField.AutoSort | Function that sets the auto-sort conditions of the pivot field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); pivotField.AutoSort({ Order: instance.Enums.XlSortOrder.xlDescending, Field: "Sum of Sales" }); |
| PivotField.ClearAllFilters | Function that removes all filters of the pivot field | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); pivotField.ClearAllFilters(); |
| PivotField.PivotItems | Function that returns an object that manages all pivot items of the pivot field cf) When an index is passed as a parameter, returns the pivot item object at that index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.ColumnFields(); let pivotField = pivotFields.Item(1); let pivotItems = pivotField.PivotItems(); // Returns pivot item manager object let pivotItem = pivotField.PivotItems(1); // Returns pivot item object at specific index |
| PivotTable.DataFields | Function that returns a pivot field manager object that manages data fields within the pivot table cf) When an index is passed as a parameter, returns the pivot field object that manages the data field at that index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.DataFields(); // Returns pivot field manager object let pivotField = pivotTable.DataFields(1); // Returns pivot field object at specific index |
| PivotTable.PageFields | Function that returns a pivot field manager object that manages page fields within the pivot table cf) When an index is passed as a parameter, returns the pivot field object that manages the page field at that index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.PageFields(); // Returns the Pivot Field Management Object. let pivotField = pivotTable.PageFields(1); // Returns the Pivot Field Object at the specified index. |
| PivotTable.RowFields | Function that returns a pivot field manager object that manages row fields within the pivot table cf) When an index is passed as a parameter, returns the pivot field object that manages the row field at that index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.RowFields(); // Return pivot field manager object let pivotField = pivotTable.RowFields(1); // Return pivot field object of specific index |
| PivotTable.AddDataField | Function that adds a data field to the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotField = pivotTable.AddDataField({ Field: pivotTable.PivotFields("Score"), Caption: "Total Score" }); |
| PivotTable.AddFields | Function that adds row, column, and page fields to the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); pivotTable.AddFields({ ColumnFields: [ "Status", "Closed_By" ] }); |
| PivotTable.ClearAllFilters | Function that removes all filters of the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); pivotTable.ClearAllFilters(); |
| PivotTable.ClearTable | Function that removes all fields, filters, and sort information of the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); pivotTable.ClearTable(); |
| PivotTable.GetPivotData | Function that returns a range object matching specific conditions of the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let range = pivotTable.GetPivotData({ DataField: "Quantity", Field1: "Warehouse", Item1: "Charis" }); |
| PivotTable.PivotCache | Function that returns the pivot table cache object that composes the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotCache = pivotTable.PivotCache(); |
| PivotTable.PivotFields | Function that returns a pivot field manager object that manages all fields within the pivot table cf) When an index is passed as a parameter, returns the pivot field object that manages all fields at that index | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); let pivotFields = pivotTable.PivotFields(); // Returns pivot field manager object let pivotField = pivotTable.PivotFields(1); // Returns pivot field object at specific index |
| PivotTable.RefreshTable | Function that refreshes the pivot table from its source data | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); pivotTable.RefreshTable(); |
| PivotTable.RowAxisLayout | Function that changes the layout settings for all pivot fields in the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); pivotTable.RowAxisLayout(instance.Enums.XlLayoutRowType.xlCompactRow); |
| PivotTable.SubtotalLocation | Function that changes the subtotal location for all pivot fields in the pivot table | let workbook = instance.Application.ActiveWorkbook; let worksheet = workbook.ActiveSheet; let pivotTables = worksheet.PivotTables(); let pivotTable = pivotTables.Item(1); pivotTable.SubtotalLocation(instance.Enums.XlSubtototalLocationType.xlAtTop); |
Related Features
Data Processing , Built-in Function Libraries , Autocomplete , Data Validation , Filter and Sort , Find and Replace