[excel] (Table, Application) Adding samples to high view pages (#316)

* Adding samples to high view pages

* Typo fix

Author: AlexJerabek

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

@@ -85,7 +85,23 @@ methods:
       content: 'getLongDatePattern(): string;'
       return:
         type: string
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script returns the system's long date pattern. 
+           * This could be used in a Power Automate flow to keep date formatting consistent.
+           */
+          function main(workbook: ExcelScript.Workbook) : string {
+              const cultureInfo = workbook.getApplication().getCultureInfo();
+              const dateTimeInfo =  cultureInfo.getDatetimeFormat();
+              
+              return dateTimeInfo.getLongDatePattern();
+          }
+          ```
   - name: getLongTimePattern()
     uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo#getLongTimePattern:member(1)'
     package: ExcelScript!

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

@@ -4,7 +4,27 @@ uid: 'ExcelScript!ExcelScript.Filter:interface'
 package: ExcelScript!
 fullName: ExcelScript.Filter
 summary: Manages the filtering of a table's column.
-remarks: ''
+remarks: |-
+
+
+  #### Examples
+
+  ```TypeScript
+  /**
+   * This script adds a table filter to only show the top 10% of values 
+   * belonging to a particular column.
+   */
+  function main(workbook: ExcelScript.Workbook) {
+      // Get the first table on the current worksheet.
+      const table = workbook.getActiveWorksheet().getTables()[0];
+
+      // 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.
+      pageViewFilter.applyTopPercentFilter(10);
+  }
+  ```
 isPreview: false
 isDeprecated: false
 type: interface

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

@@ -892,7 +892,23 @@ methods:
           type: boolean
       return:
         type: void
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script makes a table's headers not visible in the grid.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+              // Get the table named "CoverageTable".
+              const coverageTable = workbook.getTable("CoverageTable");
+
+              // Make the header row not visible.
+              coverageTable.setShowHeaders(false);
+          }
+          ```
   - name: setShowTotals(showTotals)
     uid: 'ExcelScript!ExcelScript.Table#setShowTotals:member(1)'
     package: ExcelScript!

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

@@ -53,7 +53,27 @@ methods:
       content: 'getFilter(): Filter;'
       return:
         type: '<xref uid="ExcelScript!ExcelScript.Filter:interface" />'
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script adds a table filter to only show the top 10% of values 
+           * belonging to a particular column.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+              // Get the first table on the current worksheet.
+              const table = workbook.getActiveWorksheet().getTables()[0];
+
+              // 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.
+              pageViewFilter.applyTopPercentFilter(10);
+          }
+          ```
   - name: getHeaderRowRange()
     uid: 'ExcelScript!ExcelScript.TableColumn#getHeaderRowRange:member(1)'
     package: ExcelScript!

docs/sample-scripts/excel-scripts.yaml

@@ -1978,6 +1978,18 @@
       // Write the date using the system's separator character.
       cell.setValue(`${currentDate.getMonth()}${separator}${currentDate.getDate()}${separator}${currentDate.getFullYear()}`);
     }
+'ExcelScript.DatetimeFormatInfo#getLongDatePattern:member(1)':
+  - |-
+    /**
+     * This script returns the system's long date pattern. 
+     * This could be used in a Power Automate flow to keep date formatting consistent.
+     */
+    function main(workbook: ExcelScript.Workbook) : string {
+        const cultureInfo = workbook.getApplication().getCultureInfo();
+        const dateTimeInfo =  cultureInfo.getDatetimeFormat();
+        
+        return dateTimeInfo.getLongDatePattern();
+    }
 'ExcelScript.DatetimeFormatInfo#getTimeSeparator:member(1)':
   - |-
     /**
@@ -2130,6 +2142,22 @@
       selected.getFormat().getFill().setPattern(ExcelScript.FillPattern.checker);
       selected.getFormat().getFill().setPatternColor("black");
     }
+'ExcelScript.Filter:interface':
+  - |- 
+    /**
+     * This script adds a table filter to only show the top 10% of values 
+     * belonging to a particular column.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+        // Get the first table on the current worksheet.
+        const table = workbook.getActiveWorksheet().getTables()[0];
+
+        // Get the filter for the "PageViews" table column.
+        const pageViewFilter : ExcelScript.Filter = table.getColumnByName("PageViews").getFilter();
+
+        // Apply a filter to only show the rows with the top 10% of values in this column.
+        pageViewFilter.applyTopPercentFilter(10);
+    }
 'ExcelScript.Filter#applyCustomFilter:member(1)':
   - |-
     /**
@@ -5433,6 +5461,18 @@
         table.reapplyFilters();
       });
     }
+'ExcelScript.Table#setShowHeaders:member(1)':
+  - |-
+    /**
+     * This script makes a table's headers not visible in the grid.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+        // Get the table named "CoverageTable".
+        const coverageTable = workbook.getTable("CoverageTable");
+
+        // Make the header row not visible.
+        coverageTable.setShowHeaders(false);
+    }
 'ExcelScript.Table#setShowTotals:member(1)':
   - |-
     /**
@@ -5461,6 +5501,22 @@
             categoryColumn.delete();
         }
     }
+'ExcelScript.TableColumn#getFilter:member(1)':
+  - |- 
+    /**
+     * This script adds a table filter to only show the top 10% of values 
+     * belonging to a particular column.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+        // Get the first table on the current worksheet.
+        const table = workbook.getActiveWorksheet().getTables()[0];
+
+        // Get the filter for the "PageViews" table column.
+        const pageViewFilter = table.getColumnByName("PageViews").getFilter();
+
+        // Apply a filter to only show the rows with the top 10% of values in this column.
+        pageViewFilter.applyTopPercentFilter(10);
+    }
 'ExcelScript.TableColumn#getRangeBetweenHeaderAndTotal:member(1)':
   - |-
     /**

generate-docs/API Coverage Report.csv

@@ -1471,7 +1471,7 @@ ExcelScript.DateTimeDataValidation,"formula2",Property,Good,false
 ExcelScript.DateTimeDataValidation,"operator",Property,Fine,false
 ExcelScript.DatetimeFormatInfo,N/A,Class,Good,true
 ExcelScript.DatetimeFormatInfo,"getDateSeparator()",Method,Fine,true
-ExcelScript.DatetimeFormatInfo,"getLongDatePattern()",Method,Poor,false
+ExcelScript.DatetimeFormatInfo,"getLongDatePattern()",Method,Good,true
 ExcelScript.DatetimeFormatInfo,"getLongTimePattern()",Method,Poor,false
 ExcelScript.DatetimeFormatInfo,"getShortDatePattern()",Method,Poor,false
 ExcelScript.DatetimeFormatInfo,"getTimeSeparator()",Method,Fine,true
@@ -1567,7 +1567,7 @@ ExcelScript.FillPattern,"semiGray75",EnumField,Missing,false
 ExcelScript.FillPattern,"solid",EnumField,Missing,false
 ExcelScript.FillPattern,"up",EnumField,Missing,false
 ExcelScript.FillPattern,"vertical",EnumField,Missing,false
-ExcelScript.Filter,N/A,Class,Fine,false
+ExcelScript.Filter,N/A,Class,Fine,true
 ExcelScript.Filter,"apply(criteria)",Method,Poor,false
 ExcelScript.Filter,"applyBottomItemsFilter(count)",Method,Poor,false
 ExcelScript.Filter,"applyBottomPercentFilter(percent)",Method,Poor,false
@@ -3018,11 +3018,11 @@ ExcelScript.Table,"setPredefinedTableStyle(predefinedTableStyle)",Method,Poor,fa
 ExcelScript.Table,"setShowBandedColumns(showBandedColumns)",Method,Poor,false
 ExcelScript.Table,"setShowBandedRows(showBandedRows)",Method,Poor,false
 ExcelScript.Table,"setShowFilterButton(showFilterButton)",Method,Poor,false
-ExcelScript.Table,"setShowHeaders(showHeaders)",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,"delete()",Method,Poor,true
-ExcelScript.TableColumn,"getFilter()",Method,Poor,false
+ExcelScript.TableColumn,"getFilter()",Method,Poor,true
 ExcelScript.TableColumn,"getHeaderRowRange()",Method,Poor,false
 ExcelScript.TableColumn,"getId()",Method,Poor,false
 ExcelScript.TableColumn,"getIndex()",Method,Poor,false