Additional samples for high-traffic pages (#321)

Author: AlexJerabek

docs/docs-ref-autogen/excel/excelscript/excelscript.filter.yml

@@ -21,7 +21,7 @@ remarks: |-
       // Get the filter for the "PageViews" table column.
       const pageViewFilter : ExcelScript.Filter = table.getColumnByName("PageViews").getFilter();
 
-      // Apply a filter to only show the rows in the top 10% of values in this column.
+      // Apply a filter to only show the rows with the top 10% of values in this column.
       pageViewFilter.applyTopPercentFilter(10);
   }
   ```
@@ -297,7 +297,24 @@ methods:
       content: 'clear(): void;'
       return:
         type: void
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script shows how to clear a filter from a table column.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+            // Get the first table in the workbook.
+            const table = workbook.getTables()[0];
+
+            // Clear the filter for the table column named "Status".
+            const statusColumnFilter = table.getColumn("Status").getFilter();
+            statusColumnFilter.clear();
+          }
+          ```
   - name: getCriteria()
     uid: 'ExcelScript!ExcelScript.Filter#getCriteria:member(1)'
     package: ExcelScript!

docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml

@@ -2218,7 +2218,24 @@ methods:
           type: boolean
       return:
         type: void
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script merges a group of cells into a single region.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+            // Get the active worksheet.
+            const selectedSheet = workbook.getActiveWorksheet();
+
+            // Merge cells A1 through A4.
+            const range = selectedSheet.getRange("A1:A4");
+            range.merge();
+          }
+          ```
   - name: moveTo(destinationRange)
     uid: 'ExcelScript!ExcelScript.Range#moveTo:member(1)'
     package: ExcelScript!
@@ -2850,4 +2867,21 @@ methods:
       content: 'unmerge(): void;'
       return:
         type: void
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script unmerges every used cell in the current worksheet.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+            // Get the active worksheet.
+            const selectedSheet = workbook.getActiveWorksheet();
+
+            // Separate all regions into single cells in the currently used range.
+            const range = selectedSheet.getUsedRange();
+            range.unmerge();
+          }
+          ```

docs/docs-ref-autogen/excel/excelscript/excelscript.tablecolumn.yml

@@ -4,7 +4,26 @@ uid: 'ExcelScript!ExcelScript.TableColumn:interface'
 package: ExcelScript!
 fullName: ExcelScript.TableColumn
 summary: Represents a column in a table.
-remarks: ''
+remarks: |-
+
+
+  #### Examples
+
+  ```TypeScript
+  /**
+   * This script shows how to get the range of a table column.
+   */
+  function main(workbook: ExcelScript.Workbook) {
+    // Get the first table in the workbook.
+    const table = workbook.getTables()[0];
+
+    // Get the range of the table column named "Type".
+    const typeColumn : ExcelScript.TableColumn = table.getColumn("Type");
+    const range = typeColumn.getRange();
+
+    // Do something with the range...
+  }
+  ```
 isPreview: false
 isDeprecated: false
 type: interface
@@ -70,7 +89,7 @@ methods:
               // Get the filter for the "PageViews" table column.
               const pageViewFilter = table.getColumnByName("PageViews").getFilter();
 
-              // Apply a filter to only show the rows in the top 10% of values in this column.
+              // Apply a filter to only show the rows with the top 10% of values in this column.
               pageViewFilter.applyTopPercentFilter(10);
           }
           ```

docs/sample-scripts/excel-scripts.yaml

@@ -2202,6 +2202,19 @@
       const typeColumn = table.getColumnByName("Type");
       typeColumn.getFilter().applyValuesFilter(["Needs Review"]);
     }
+'ExcelScript.Filter#clear:member(1)':
+  - |-
+    /**
+     * This script shows how to clear a filter from a table column.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get the first table in the workbook.
+      const table = workbook.getTables()[0];
+
+      // Clear the filter for the table column named "Status".
+      const statusColumnFilter = table.getColumn("Status").getFilter();
+      statusColumnFilter.clear();
+    }
 'ExcelScript.FilterCriteria#criterion1:member':
   - |-
     /**
@@ -4043,6 +4056,19 @@
       // Add the headers.
       currentSheet.getRange("A1:C1").setValues(myHeaders);
     }
+'ExcelScript.Range#merge:member(1)':
+  - |-
+    /**
+     * This script merges a group of cells into a single region.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get the active worksheet.
+      const selectedSheet = workbook.getActiveWorksheet();
+
+      // Merge cells A1 through A4.
+      const range = selectedSheet.getRange("A1:A4");
+      range.merge();
+    }
 'ExcelScript.Range#replaceAll:member(1)':
   - |-
     /**
@@ -4184,6 +4210,19 @@
       , ['4/17/2020', 'Mariya', 'Salads', '$1600']
       , ['4/28/2020', 'Laura', 'Sandwiches', '$680']
     ];
+'ExcelScript.Range#unmerge:member(1)':
+  - |-
+    /**
+     * This script unmerges every used cell in the current worksheet.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get the active worksheet.
+      const selectedSheet = workbook.getActiveWorksheet();
+
+      // Separate all regions into single cells in the currently used range.
+      const range = selectedSheet.getUsedRange();
+      range.unmerge();
+    }
 'ExcelScript.RangeAreas:interface':
   - |- 
     /**
@@ -5486,6 +5525,21 @@
         // Set the Total Row to show.
         table.setShowTotals(true);
     }
+'ExcelScript.TableColumn:interface':
+  - |-
+    /**
+     * This script shows how to get the range of a table column.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get the first table in the workbook.
+      const table = workbook.getTables()[0];
+
+      // Get the range of the table column named "Type".
+      const typeColumn : ExcelScript.TableColumn = table.getColumn("Type");
+      const range = typeColumn.getRange();
+
+      // Do something with the range...
+    }
 'ExcelScript.TableColumn#delete:member(1)':
   - |-
     /**

generate-docs/API Coverage Report.csv

@@ -1579,7 +1579,7 @@ ExcelScript.Filter,"applyIconFilter(icon)",Method,Poor,false
 ExcelScript.Filter,"applyTopItemsFilter(count)",Method,Poor,false
 ExcelScript.Filter,"applyTopPercentFilter(percent)",Method,Poor,false
 ExcelScript.Filter,"applyValuesFilter(values)",Method,Fine,true
-ExcelScript.Filter,"clear()",Method,Poor,false
+ExcelScript.Filter,"clear()",Method,Poor,true
 ExcelScript.Filter,"getCriteria()",Method,Poor,false
 ExcelScript.FilterCriteria,N/A,Class,Fine,false
 ExcelScript.FilterCriteria,"color",Property,Good,false
@@ -2451,7 +2451,7 @@ ExcelScript.Range,"getWorksheet()",Method,Poor,false
 ExcelScript.Range,"group(groupOption)",Method,Fine,true
 ExcelScript.Range,"hideGroupDetails(groupOption)",Method,Poor,false
 ExcelScript.Range,"insert(shift)",Method,Fine,true
-ExcelScript.Range,"merge(across)",Method,Poor,false
+ExcelScript.Range,"merge(across)",Method,Fine,true
 ExcelScript.Range,"moveTo(destinationRange)",Method,Poor,false
 ExcelScript.Range,"removeDuplicates(columns, includesHeader)",Method,Poor,false
 ExcelScript.Range,"replaceAll(text, replacement, criteria)",Method,Poor,true
@@ -2476,7 +2476,7 @@ ExcelScript.Range,"setValues(values)",Method,Poor,true
 ExcelScript.Range,"showCard()",Method,Poor,false
 ExcelScript.Range,"showGroupDetails(groupOption)",Method,Poor,false
 ExcelScript.Range,"ungroup(groupOption)",Method,Poor,false
-ExcelScript.Range,"unmerge()",Method,Poor,false
+ExcelScript.Range,"unmerge()",Method,Poor,true
 ExcelScript.RangeAreas,N/A,Class,Fine,true
 ExcelScript.RangeAreas,"addConditionalFormat(type)",Method,Poor,false
 ExcelScript.RangeAreas,"calculate()",Method,Poor,false
@@ -3020,7 +3020,7 @@ ExcelScript.Table,"setShowBandedRows(showBandedRows)",Method,Poor,false
 ExcelScript.Table,"setShowFilterButton(showFilterButton)",Method,Poor,false
 ExcelScript.Table,"setShowHeaders(showHeaders)",Method,Poor,true
 ExcelScript.Table,"setShowTotals(showTotals)",Method,Poor,true
-ExcelScript.TableColumn,N/A,Class,Fine,false
+ExcelScript.TableColumn,N/A,Class,Fine,true
 ExcelScript.TableColumn,"delete()",Method,Poor,true
 ExcelScript.TableColumn,"getFilter()",Method,Poor,true
 ExcelScript.TableColumn,"getHeaderRowRange()",Method,Poor,false