Add SortBy sample for autosort in PivotTable (#429)

Author: AlexJerabek

docs/docs-ref-autogen/excelscript/excelscript.pivotlayout.yml

@@ -484,7 +484,29 @@ methods:
           type: <xref uid="ExcelScript!ExcelScript.SortBy:enum" />
       return:
         type: void
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+          * This script shows how to use setAutoSortOnCell to automatically sort
+          * a PivotTable's row labels based on values in a specific data column.
+          */
+          function main(workbook: ExcelScript.Workbook) {
+            // Get the "Farm Pivot" PivotTable.
+            const pivotTable = workbook.getPivotTable("Farm Pivot");
+            const sheet = pivotTable.getWorksheet();
+
+            // Get the PivotTable's layout object.
+            const layout = pivotTable.getLayout();
+
+            // Pick a cell in the PivotTable's data area to sort by.
+            const sortCell1 = sheet.getRange("N6");
+            layout.setAutoSortOnCell(sortCell1, ExcelScript.SortBy.descending);
+          }
+          ```
   - name: setEmptyCellText(emptyCellText)
     uid: ExcelScript!ExcelScript.PivotLayout#setEmptyCellText:member(1)
     package: ExcelScript!

docs/docs-ref-autogen/excelscript/excelscript.sortby.yml

@@ -5,6 +5,10 @@ package: ExcelScript!
 fullName: ExcelScript.SortBy
 summary: Represents the sort direction.
 remarks: >-
+
+
+
+
   #### Used by
 
 
@@ -17,6 +21,34 @@ remarks: >-
   [ExcelScript.PivotLayout](/javascript/api/office-scripts/excelscript/excelscript.pivotlayout):
   [setAutoSortOnCell](/javascript/api/office-scripts/excelscript/excelscript.pivotlayout#excelscript-excelscript-pivotlayout-setautosortoncell-member(1))
 
+  #### Examples
+
+
+  ```TypeScript
+
+  /**
+
+  * This script shows how to use setAutoSortOnCell to automatically sort
+
+  * a PivotTable's row labels based on values in a specific data column.
+
+  */
+
+  function main(workbook: ExcelScript.Workbook) {
+    // Get the "Farm Pivot" PivotTable.
+    const pivotTable = workbook.getPivotTable("Farm Pivot");
+    const sheet = pivotTable.getWorksheet();
+
+    // Get the PivotTable's layout object.
+    const layout = pivotTable.getLayout();
+
+    // Pick a cell in the PivotTable's data area to sort by.
+    const sortCell1 = sheet.getRange("N6");
+    layout.setAutoSortOnCell(sortCell1, ExcelScript.SortBy.descending);
+  }
+
+  ```
+
 isPreview: false
 isDeprecated: false
 fields:

docs/sample-scripts/samples.yaml

@@ -4043,6 +4043,24 @@
         // Example log: "Grand total of Sum of Crates Sold Wholesale: 11000"
       });
     }
+'ExcelScript.PivotLayout#setAutoSortOnCell:member(1)':
+  - |-
+    /**
+    * This script shows how to use setAutoSortOnCell to automatically sort
+    * a PivotTable's row labels based on values in a specific data column.
+    */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get the "Farm Pivot" PivotTable.
+      const pivotTable = workbook.getPivotTable("Farm Pivot");
+      const sheet = pivotTable.getWorksheet();
+
+      // Get the PivotTable's layout object.
+      const layout = pivotTable.getLayout();
+
+      // Pick a cell in the PivotTable's data area to sort by.
+      const sortCell1 = sheet.getRange("N6");
+      layout.setAutoSortOnCell(sortCell1, ExcelScript.SortBy.descending);
+    }
 'ExcelScript.PivotLayout#setLayoutType:member(1)':
   - |-
     /**
@@ -6199,6 +6217,24 @@
       // Set the left margin of the slicer.
       fruitSlicer.setLeft(400);
     }
+'ExcelScript.SortBy:enum':
+  - |-
+    /**
+    * This script shows how to use setAutoSortOnCell to automatically sort
+    * a PivotTable's row labels based on values in a specific data column.
+    */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get the "Farm Pivot" PivotTable.
+      const pivotTable = workbook.getPivotTable("Farm Pivot");
+      const sheet = pivotTable.getWorksheet();
+
+      // Get the PivotTable's layout object.
+      const layout = pivotTable.getLayout();
+
+      // Pick a cell in the PivotTable's data area to sort by.
+      const sortCell1 = sheet.getRange("N6");
+      layout.setAutoSortOnCell(sortCell1, ExcelScript.SortBy.descending);
+    }
 'ExcelScript.SortDataOption:enum':
   - |-
     /**

generate-docs/API Coverage Report.csv

@@ -2275,7 +2275,7 @@ ExcelScript,ExcelScript.PivotLayout,"repeatAllItemLabels(repeatLabels)",Method,F
 ExcelScript,ExcelScript.PivotLayout,"setAltTextDescription(altTextDescription)",Method,Great,false
 ExcelScript,ExcelScript.PivotLayout,"setAltTextTitle(altTextTitle)",Method,Great,false
 ExcelScript,ExcelScript.PivotLayout,"setAutoFormat(autoFormat)",Method,Great,false
-ExcelScript,ExcelScript.PivotLayout,"setAutoSortOnCell(cell, sortBy)",Method,Good,false
+ExcelScript,ExcelScript.PivotLayout,"setAutoSortOnCell(cell, sortBy)",Method,Good,true
 ExcelScript,ExcelScript.PivotLayout,"setEmptyCellText(emptyCellText)",Method,Excellent,false
 ExcelScript,ExcelScript.PivotLayout,"setEnableFieldList(enableFieldList)",Method,Good,false
 ExcelScript,ExcelScript.PivotLayout,"setFillEmptyCells(fillEmptyCells)",Method,Excellent,false
@@ -2986,7 +2986,7 @@ ExcelScript,ExcelScript.SlicerStyle,"duplicate()",Method,Fine,false
 ExcelScript,ExcelScript.SlicerStyle,"getName()",Method,Fine,false
 ExcelScript,ExcelScript.SlicerStyle,"getReadOnly()",Method,Good,false
 ExcelScript,ExcelScript.SlicerStyle,"setName(name)",Method,Fine,false
-ExcelScript,ExcelScript.SortBy,N/A,Enum,Good,false
+ExcelScript,ExcelScript.SortBy,N/A,Enum,Good,true
 ExcelScript,ExcelScript.SortBy,"ascending",EnumField,Great,false
 ExcelScript,ExcelScript.SortBy,"descending",EnumField,Great,false
 ExcelScript,ExcelScript.SortDataOption,N/A,Enum,Missing,true