Merge pull request #363 from OfficeDev/autogen-docs

[excel] Pulling latest changes from CDN

Author: alison-mk

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

@@ -33,15 +33,15 @@ fields:
   - name: all
     uid: 'ExcelScript!ExcelScript.ClearApplyTo.all:member'
     package: ExcelScript!
-    summary: ''
+    summary: Clears everything in the range.
   - name: contents
     uid: 'ExcelScript!ExcelScript.ClearApplyTo.contents:member'
     package: ExcelScript!
-    summary: Clears the contents of the range.
+    summary: 'Clears the contents of the range, leaving formatting intact.'
   - name: formats
     uid: 'ExcelScript!ExcelScript.ClearApplyTo.formats:member'
     package: ExcelScript!
-    summary: Clears all formatting for the range.
+    summary: 'Clears all formatting for the range, leaving values intact.'
   - name: hyperlinks
     uid: 'ExcelScript!ExcelScript.ClearApplyTo.hyperlinks:member'
     package: ExcelScript!

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

@@ -117,7 +117,9 @@ methods:
     uid: 'ExcelScript!ExcelScript.DocumentProperties#getComments:member(1)'
     package: ExcelScript!
     fullName: getComments()
-    summary: The comments of the workbook.
+    summary: >-
+      The comment field in the metadata of the workbook. These have no connection to comments by users made in the
+      workbook.
     remarks: ''
     isPreview: false
     isDeprecated: false
@@ -319,7 +321,9 @@ methods:
     uid: 'ExcelScript!ExcelScript.DocumentProperties#setComments:member(1)'
     package: ExcelScript!
     fullName: setComments(comments)
-    summary: The comments of the workbook.
+    summary: >-
+      The comment field in the metadata of the workbook. These have no connection to comments by users made in the
+      workbook.
     remarks: ''
     isPreview: false
     isDeprecated: false

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

@@ -38,6 +38,20 @@ isPreview: false
 isDeprecated: false
 type: interface
 properties:
+  - name: comparator
+    uid: 'ExcelScript!ExcelScript.PivotLabelFilter#comparator:member'
+    package: ExcelScript!
+    fullName: comparator
+    summary: >-
+      The comparator is the static value to which other values are compared. The type of comparison is defined by the
+      condition. Note: A numeric string is treated as a number when being compared against other numeric strings.
+    remarks: ''
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'comparator?: string;'
+      return:
+        type: string
   - name: condition
     uid: 'ExcelScript!ExcelScript.PivotLabelFilter#condition:member'
     package: ExcelScript!

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

@@ -161,7 +161,7 @@ methods:
     uid: 'ExcelScript!ExcelScript.Range#clear:member(1)'
     package: ExcelScript!
     fullName: clear(applyTo)
-    summary: 'Clear range values, format, fill, border, etc.'
+    summary: 'Clear range values and formatting, such as fill and border.'
     remarks: ''
     isPreview: false
     isDeprecated: false
@@ -785,6 +785,36 @@ methods:
               });
           }
           ```
+  - name: getDependents()
+    uid: 'ExcelScript!ExcelScript.Range#getDependents:member(1)'
+    package: ExcelScript!
+    fullName: getDependents()
+    summary: >-
+      Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified
+      range in the same worksheet or across multiple worksheets.
+    remarks: ''
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'getDependents(): WorkbookRangeAreas;'
+      return:
+        type: '<xref uid="ExcelScript!ExcelScript.WorkbookRangeAreas:interface" />'
+        description: ''
+  - name: getDirectDependents()
+    uid: 'ExcelScript!ExcelScript.Range#getDirectDependents:member(1)'
+    package: ExcelScript!
+    fullName: getDirectDependents()
+    summary: >-
+      Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a
+      specified range in the same worksheet or across multiple worksheets.
+    remarks: ''
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'getDirectDependents(): WorkbookRangeAreas;'
+      return:
+        type: '<xref uid="ExcelScript!ExcelScript.WorkbookRangeAreas:interface" />'
+        description: ''
   - name: getDirectPrecedents()
     uid: 'ExcelScript!ExcelScript.Range#getDirectPrecedents:member(1)'
     package: ExcelScript!
@@ -1492,6 +1522,21 @@ methods:
       return:
         type: '<xref uid="ExcelScript!ExcelScript.PivotTable:interface" />[]'
         description: ''
+  - name: getPrecedents()
+    uid: 'ExcelScript!ExcelScript.Range#getPrecedents:member(1)'
+    package: ExcelScript!
+    fullName: getPrecedents()
+    summary: >-
+      Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified
+      range in the same worksheet or across multiple worksheets.
+    remarks: ''
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'getPrecedents(): WorkbookRangeAreas;'
+      return:
+        type: '<xref uid="ExcelScript!ExcelScript.WorkbookRangeAreas:interface" />'
+        description: ''
   - name: getPredefinedCellStyle()
     uid: 'ExcelScript!ExcelScript.Range#getPredefinedCellStyle:member(1)'
     package: ExcelScript!

generate-docs/API Coverage Report.csv

@@ -1052,7 +1052,7 @@ ExcelScript.ChartUnderlineStyle,N/A,Enum,Missing,false
 ExcelScript.ChartUnderlineStyle,"none",EnumField,Missing,false
 ExcelScript.ChartUnderlineStyle,"single",EnumField,Missing,false
 ExcelScript.ClearApplyTo,N/A,Enum,Missing,true
-ExcelScript.ClearApplyTo,"all",EnumField,Missing,false
+ExcelScript.ClearApplyTo,"all",EnumField,Poor,false
 ExcelScript.ClearApplyTo,"contents",EnumField,Fine,false
 ExcelScript.ClearApplyTo,"formats",EnumField,Fine,false
 ExcelScript.ClearApplyTo,"hyperlinks",EnumField,Fine,false
@@ -2193,6 +2193,7 @@ ExcelScript.PivotItem,"setIsExpanded(isExpanded)",Method,Poor,false
 ExcelScript.PivotItem,"setName(name)",Method,Poor,false
 ExcelScript.PivotItem,"setVisible(visible)",Method,Poor,false
 ExcelScript.PivotLabelFilter,N/A,Class,Good,true
+ExcelScript.PivotLabelFilter,"comparator",Property,Good,false
 ExcelScript.PivotLabelFilter,"condition",Property,Fine,false
 ExcelScript.PivotLabelFilter,"exclusive",Property,Good,false
 ExcelScript.PivotLabelFilter,"lowerBound",Property,Good,false
@@ -2387,6 +2388,8 @@ ExcelScript.Range,"getColumnsBefore(count)",Method,Poor,false
 ExcelScript.Range,"getConditionalFormat(id)",Method,Poor,false
 ExcelScript.Range,"getConditionalFormats()",Method,Poor,false
 ExcelScript.Range,"getDataValidation()",Method,Poor,true
+ExcelScript.Range,"getDependents()",Method,Poor,false
+ExcelScript.Range,"getDirectDependents()",Method,Poor,false
 ExcelScript.Range,"getDirectPrecedents()",Method,Fine,true
 ExcelScript.Range,"getEntireColumn()",Method,Poor,false
 ExcelScript.Range,"getEntireRow()",Method,Poor,false
@@ -2421,6 +2424,7 @@ ExcelScript.Range,"getNumberFormats()",Method,Poor,false
 ExcelScript.Range,"getNumberFormatsLocal()",Method,Poor,false
 ExcelScript.Range,"getOffsetRange(rowOffset, columnOffset)",Method,Fine,true
 ExcelScript.Range,"getPivotTables(fullyContained)",Method,Poor,false
+ExcelScript.Range,"getPrecedents()",Method,Poor,false
 ExcelScript.Range,"getPredefinedCellStyle()",Method,Poor,false
 ExcelScript.Range,"getRangeEdge(direction, activeCell)",Method,Fine,true
 ExcelScript.Range,"getResizedRange(deltaRows, deltaColumns)",Method,Fine,true

generate-docs/api-extractor-inputs-excel/excel.d.ts

@@ -1734,7 +1734,7 @@ export declare namespace ExcelScript {
         calculate(): void;
 
         /**
-         * Clear range values, format, fill, border, etc.
+         * Clear range values and formatting, such as fill and border.
          * @param applyTo - Optional. Determines the type of clear action. See `ExcelScript.ClearApplyTo` for details.
          */
         clear(applyTo?: ClearApplyTo): void;
@@ -1817,6 +1817,16 @@ export declare namespace ExcelScript {
          */
         getColumnsBefore(count?: number): Range;
 
+        /**
+         * Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified range in the same worksheet or across multiple worksheets.
+         */
+        getDependents(): WorkbookRangeAreas;
+
+        /**
+         * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a specified range in the same worksheet or across multiple worksheets.
+         */
+        getDirectDependents(): WorkbookRangeAreas;
+
         /**
          * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a specified range in the same worksheet or across multiple worksheets.
          */
@@ -1886,6 +1896,11 @@ export declare namespace ExcelScript {
          */
         getPivotTables(fullyContained?: boolean): PivotTable[];
 
+        /**
+         * Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified range in the same worksheet or across multiple worksheets.
+         */
+        getPrecedents(): WorkbookRangeAreas;
+
         /**
          * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
          * @param direction - The direction from the active cell.
@@ -7406,12 +7421,12 @@ export declare namespace ExcelScript {
         setCategory(category: string): void;
 
         /**
-         * The comments of the workbook.
+         * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
          */
         getComments(): string;
 
         /**
-         * The comments of the workbook.
+         * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
          */
         setComments(comments: string): void;
 
@@ -10172,6 +10187,12 @@ export declare namespace ExcelScript {
      * The `condition` defines what criteria need to be set in order for the filter to operate.
      */
     export interface PivotLabelFilter {
+        /**
+         * The comparator is the static value to which other values are compared. The type of comparison is defined by the condition.
+         * Note: A numeric string is treated as a number when being compared against other numeric strings.
+         */
+        comparator?: string;
+
         /**
          * Specifies the condition for the filter, which defines the necessary filtering criteria.
          */
@@ -12798,15 +12819,18 @@ export declare namespace ExcelScript {
     }
 
     enum ClearApplyTo {
+        /**
+         * Clears everything in the range.
+         */
         all,
 
         /**
-         * Clears all formatting for the range.
+         * Clears all formatting for the range, leaving values intact.
          */
         formats,
 
         /**
-         * Clears the contents of the range.
+         * Clears the contents of the range, leaving formatting intact.
          */
         contents,