Add Table and LinekdWorkbook samples (#346)

Author: AlexJerabek

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

@@ -26,7 +26,27 @@ methods:
       content: 'breakLinks(): void;'
       return:
         type: void
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script removes all links to other workbooks.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+              // Get all the linked workbook references.
+              const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
+              console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);
+
+              // Remove all the links to those workbooks.
+              // This changes the value of cells with workbook links to "#CONNECT!".
+              externalWorkbooks.forEach((workbookLink) => {
+                  workbookLink.breakLinks();
+              });
+          }
+          ```
   - name: refreshLinks()
     uid: 'ExcelScript!ExcelScript.LinkedWorkbook#refreshLinks:member(1)'
     package: ExcelScript!

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

@@ -178,7 +178,25 @@ methods:
       content: 'clearFilters(): void;'
       return:
         type: void
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script clears the filters from all tables in the workbook.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+              // Get all the tables in the workbook.
+              const tables = workbook.getTables();
+
+              // Remove any active filters from each table.
+              tables.forEach((table) => {
+                table.clearFilters();
+              });
+          }
+          ```
   - name: convertToRange()
     uid: 'ExcelScript!ExcelScript.Table#convertToRange:member(1)'
     package: ExcelScript!

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

@@ -210,7 +210,27 @@ methods:
       content: 'getTotalRowRange(): Range;'
       return:
         type: '<xref uid="ExcelScript!ExcelScript.Range:interface" />'
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script logs the value in the total row of a table column.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+              // Get the table named "Cities".
+              const table = workbook.getTable("Cities");
+
+              // Get the total row from the "Population" column.
+              const column = table.getColumn("Population");
+              const totalRange = column.getTotalRowRange();
+
+              // Log the total value.
+              console.log(totalRange.getValue());
+          }
+          ```
   - name: setName(name)
     uid: 'ExcelScript!ExcelScript.TableColumn#setName:member(1)'
     package: ExcelScript!

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

@@ -1024,7 +1024,6 @@ methods:
               // Trigger a refresh of linked workbook content.
               workbook.refreshAllLinksToLinkedWorkbooks();
             }
-          }
           ```
   - name: getLinkedWorkbooks()
     uid: 'ExcelScript!ExcelScript.Workbook#getLinkedWorkbooks:member(1)'
@@ -1040,7 +1039,27 @@ methods:
       content: 'getLinkedWorkbooks(): LinkedWorkbook[];'
       return:
         type: '<xref uid="ExcelScript!ExcelScript.LinkedWorkbook:interface" />[]'
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script removes all links to other workbooks.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+              // Get all the linked workbook references.
+              const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
+              console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);
+
+              // Remove all the links to those workbooks.
+              // This changes the value of cells with workbook links to "#CONNECT!".
+              externalWorkbooks.forEach((workbookLink) => {
+                  workbookLink.breakLinks();
+              });
+          }
+          ```
   - name: getName()
     uid: 'ExcelScript!ExcelScript.Workbook#getName:member(1)'
     package: ExcelScript!

docs/sample-scripts/excel-scripts.yaml

@@ -2740,6 +2740,22 @@
       // Apply the label filter to the field.
       field.applyFilter({ labelFilter: filter });
     }
+'ExcelScript.LinkedWorkbook#breakLinks:member(1)':
+  - |-
+    /**
+     * This script removes all links to other workbooks.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+        // Get all the linked workbook references.
+        const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
+        console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);
+
+        // Remove all the links to those workbooks.
+        // This changes the value of cells with workbook links to "#CONNECT!".
+        externalWorkbooks.forEach((workbookLink) => {
+            workbookLink.breakLinks();
+        });
+    }
 'ExcelScript.ListDataValidation:interface':
   - |-
     /**
@@ -5711,6 +5727,20 @@
         // Add the rows to the end of the table.
         table.addRows(-1, rowData);
     }
+'ExcelScript.Table#clearFilters:member(1)':
+  - |-
+    /**
+     * This script clears the filters from all tables in the workbook.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+        // Get all the tables in the workbook.
+        const tables = workbook.getTables();
+
+        // Remove any active filters from each table.
+        tables.forEach((table) => {
+          table.clearFilters();
+        });
+    }
 'ExcelScript.Table#convertToRange:member(1)':
   - |-
     /**
@@ -5952,6 +5982,22 @@
         `=[@[${productColumnName1}]]*[@[${productColumnName2}]]`
       );
     }
+'ExcelScript.TableColumn#getTotalRowRange:member(1)':
+  - |-
+    /**
+     * This script logs the value in the total row of a table column.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+        // Get the table named "Cities".
+        const table = workbook.getTable("Cities");
+
+        // Get the total row from the "Population" column.
+        const column = table.getColumn("Population");
+        const totalRange = column.getTotalRowRange();
+
+        // Log the total value.
+        console.log(totalRange.getValue());
+    }
 'ExcelScript.TableColumn#setName:member(1)':
   - |-
     /**
@@ -6288,6 +6334,21 @@
         // Trigger a refresh of linked workbook content.
         workbook.refreshAllLinksToLinkedWorkbooks();
       }
+'ExcelScript.Workbook#getLinkedWorkbooks:member(1)':
+  - |-
+    /**
+     * This script removes all links to other workbooks.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+        // Get all the linked workbook references.
+        const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
+        console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);
+
+        // Remove all the links to those workbooks.
+        // This changes the value of cells with workbook links to "#CONNECT!".
+        externalWorkbooks.forEach((workbookLink) => {
+            workbookLink.breakLinks();
+        });
     }
 'ExcelScript.Workbook#getName:member(1)':
   - |-

generate-docs/API Coverage Report.csv

@@ -1954,7 +1954,7 @@ ExcelScript.LinkedDataTypeState,"fetchingData",EnumField,Missing,false
 ExcelScript.LinkedDataTypeState,"none",EnumField,Missing,false
 ExcelScript.LinkedDataTypeState,"validLinkedData",EnumField,Missing,false
 ExcelScript.LinkedWorkbook,N/A,Class,Good,false
-ExcelScript.LinkedWorkbook,"breakLinks()",Method,Poor,false
+ExcelScript.LinkedWorkbook,"breakLinks()",Method,Fine,true
 ExcelScript.LinkedWorkbook,"refreshLinks()",Method,Poor,false
 ExcelScript.ListDataValidation,N/A,Class,Fine,true
 ExcelScript.ListDataValidation,"inCellDropDown",Property,Good,false
@@ -2982,7 +2982,7 @@ ExcelScript.Table,N/A,Class,Poor,true
 ExcelScript.Table,"addColumn(index, values, name)",Method,Fine,true
 ExcelScript.Table,"addRow(index, values)",Method,Fine,true
 ExcelScript.Table,"addRows(index, values)",Method,Fine,true
-ExcelScript.Table,"clearFilters()",Method,Poor,false
+ExcelScript.Table,"clearFilters()",Method,Poor,true
 ExcelScript.Table,"convertToRange()",Method,Fine,true
 ExcelScript.Table,"delete()",Method,Poor,true
 ExcelScript.Table,"deleteRowsAt(index, count)",Method,Poor,false
@@ -3029,7 +3029,7 @@ ExcelScript.TableColumn,"getIndex()",Method,Poor,false
 ExcelScript.TableColumn,"getName()",Method,Poor,false
 ExcelScript.TableColumn,"getRange()",Method,Poor,false
 ExcelScript.TableColumn,"getRangeBetweenHeaderAndTotal()",Method,Fine,true
-ExcelScript.TableColumn,"getTotalRowRange()",Method,Poor,false
+ExcelScript.TableColumn,"getTotalRowRange()",Method,Poor,true
 ExcelScript.TableColumn,"setName(name)",Method,Poor,true
 ExcelScript.TableSort,N/A,Class,Fine,false
 ExcelScript.TableSort,"apply(fields, matchCase, method)",Method,Fine,true
@@ -3154,7 +3154,7 @@ ExcelScript.Workbook,"getIsDirty()",Method,Poor,false
 ExcelScript.Workbook,"getLastWorksheet(visibleOnly)",Method,Poor,false
 ExcelScript.Workbook,"getLinkedWorkbookByUrl(key)",Method,Poor,false
 ExcelScript.Workbook,"getLinkedWorkbookRefreshMode()",Method,Fine,true
-ExcelScript.Workbook,"getLinkedWorkbooks()",Method,Poor,false
+ExcelScript.Workbook,"getLinkedWorkbooks()",Method,Fine,true
 ExcelScript.Workbook,"getName()",Method,Poor,true
 ExcelScript.Workbook,"getNamedItem(name)",Method,Poor,false
 ExcelScript.Workbook,"getNames()",Method,Poor,true