Specifying the Absolute Position of the Pivot Item

Sometimes, user needs to specify the absolute position of the pivot items, Aspose.Cells for Node.js via C++ API has exposed few new properties and a method to achieve user requirement.

• Added PivotItem.setPosition property that can be used to specify the position index in all the PivotItems regardless of the parent node. Added PivotItem.setPositionInSameParentNode property that can be used to specify the position index in the PivotItems under the same parent node.
• Added PivotItem.move method in order to move the item up or down based on the count value, where count is the number of position to move the PivotItem up or down. If the count value is less than zero, the item will be moved up where as if the count value is larger than zero, the PivotItem will move down, Boolean type isSameParent parameter specify whether the moving operation has to be performed in the same parent node or not.
• Obsoleted the PivotItem.move(int count) method therefore it is suggested to use the newly added method PivotItem.move(number, boolean) instead.

The following sample code creates a Pivot Table and then it specifies the Pivot Items positions in the same parent node. You can download the source Excel and output Excel files for your reference. If you open the output Excel file, you will see the Pivot Item “4H12” is at 0th position in parent “K11” and “DIF400” is at 3rd position. Similarly, CA32 is at position 1 and AAA3 is at position 2

//For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET
const AsposeCells = require("aspose.cells.node");

var wb = new AsposeCells.Workbook("source.xlsx");
var wsPivot = wb.getWorksheets().add("pvtNew Hardware");
var wsData = wb.getWorksheets().get("New Hardware - Yearly");

// Get the pivottables collection for the pivot sheet
var pivotTables = wsPivot.getPivotTables();

// Add PivotTable to the worksheet
var index = pivotTables.add("='New Hardware - Yearly'!A1:D621", "A3", "HWCounts_PivotTable");

// Get the PivotTable object
var pvtTable = pivotTables.get(index);

// Add vendor row field
pvtTable.addFieldToArea(AsposeCells.PivotFieldType.Row, "Vendor");

// Add item row field
pvtTable.addFieldToArea(AsposeCells.PivotFieldType.Row, "Item");

// Add data field
pvtTable.addFieldToArea(AsposeCells.PivotFieldType.Data, "2014");

// Turn off the subtotals for the vendor row field
var pivotField = pvtTable.getRowFields().get("Vendor");
pivotField.setSubtotals(AsposeCells.PivotFieldSubtotalType.None, true);

// Turn off grand total
pvtTable.setColumnGrand(false);

/*
 * Please call the PivotTable.refreshData() and PivotTable.calculateData()
 * before using PivotItem.setPosition,
 * PivotItem.setPositionInSameParentNode and PivotItem.move methods.
*/
pvtTable.refreshData();
pvtTable.calculateData();

pvtTable.getRowFields().get("Item").getPivotItems().get("4H12").setPositionInSameParentNode(0);
pvtTable.getRowFields().get("Item").getPivotItems().get("DIF400").setPositionInSameParentNode(3);

/* 
 * As a result of using PivotItem.setPositionInSameParentNode,
 * it will change the original sort sequence.
 * So when you use PivotItem.setPositionInSameParentNode in another parent node.
 * You need call the method named "calculateData" again. 
*/
pvtTable.calculateData();

pvtTable.getRowFields().get("Item").getPivotItems().get("CA32").setPositionInSameParentNode(1);
pvtTable.getRowFields().get("Item").getPivotItems().get("AAA3").setPositionInSameParentNode(2);

// Save file
wb.save("output_out.xlsx");

Please note, it is necessary to call the PivotTable.RefreshData and PivotTable.CalculateData methods before using PivotItem.setPosition, PivotItem.setPositionInSameParentNode properties and PivotItem.move method.