Merge branch 'main' into live

Author: github-actions

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

@@ -332,7 +332,8 @@ functions:
     summary: >-
       Return the text encoding of the document as a PDF. If the document is
       empty, then the following error is shown: "We didn't find anything to
-      print".
+      print". Some actions made prior to using this API may not be captured in
+      the PDF in Excel on the web.
     remarks: ''
 
     isPreview: true
@@ -342,7 +343,11 @@ functions:
       return:
         type: string
         description: The content of the workbook as a string, in PDF format.
-  - name: "Global.OfficeScript.downloadFile({\r\n            name,\r\n            content,\r\n        })"
+  - name: |-
+      Global.OfficeScript.downloadFile({
+                  name,
+                  content,
+              })
     uid: ExcelScript!Global.OfficeScript.downloadFile:function(1)
     package: ExcelScript!
     summary: >-
@@ -362,7 +367,11 @@ functions:
                     content: string;
                 }): void;
       parameters:
-        - id: "{\r\n            name,\r\n            content,\r\n        }"
+        - id: |-
+            {
+                        name,
+                        content,
+                    }
           description: ''
           type: |-
             {
@@ -385,6 +394,31 @@ functions:
       return:
         type: string
         description: ''
+  - name: Global.OfficeScript.saveCopyAs(filename)
+    uid: ExcelScript!Global.OfficeScript.saveCopyAs:function(1)
+    package: ExcelScript!
+    summary: >-
+      Saves a copy of the current workbook in OneDrive, in the same directory as
+      the original file, with the specified file name. The API has a timeout
+      limit of 30 seconds. This limit is rarely exceeded. Note: Timeout doesn't
+      necessarily indicate that the API failed. The workbook copy may still be
+      created, but after the timeout limit this API does not return a success or
+      failure message.
+    remarks: ''
+
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'export function saveCopyAs(filename: string): void;'
+      parameters:
+        - id: filename
+          description: >-
+            The file name of the copied and saved file. The file name must end
+            with ".xlsx".
+          type: string
+      return:
+        type: void
+        description: ''
   - name: Global.OfficeScript.sendMail(mailProperties)
     uid: ExcelScript!Global.OfficeScript.sendMail:function(1)
     package: ExcelScript!

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

@@ -4,7 +4,16 @@ uid: ExcelScript!ExcelScript.CellControl:type
 package: ExcelScript!
 fullName: ExcelScript.CellControl
 summary: Represents an interactable control inside of a cell.
-remarks: "\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[ExcelScript.UnknownCellControl](/javascript/api/office-scripts/excelscript/excelscript.unknowncellcontrol), [ExcelScript.EmptyCellControl](/javascript/api/office-scripts/excelscript/excelscript.emptycellcontrol), [ExcelScript.MixedCellControl](/javascript/api/office-scripts/excelscript/excelscript.mixedcellcontrol), [ExcelScript.CheckboxCellControl](/javascript/api/office-scripts/excelscript/excelscript.checkboxcellcontrol)"
+remarks: >-
+
+
+  Learn more about the types in this type alias through the following links. 
+
+
+  [ExcelScript.UnknownCellControl](/javascript/api/office-scripts/excelscript/excelscript.unknowncellcontrol),
+  [ExcelScript.EmptyCellControl](/javascript/api/office-scripts/excelscript/excelscript.emptycellcontrol),
+  [ExcelScript.MixedCellControl](/javascript/api/office-scripts/excelscript/excelscript.mixedcellcontrol),
+  [ExcelScript.CheckboxCellControl](/javascript/api/office-scripts/excelscript/excelscript.checkboxcellcontrol)
 
 isPreview: false
 isDeprecated: false

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

@@ -13,18 +13,22 @@ fields:
     uid: ExcelScript!ExcelScript.CellControlType.checkbox:member
     package: ExcelScript!
     summary: Type representing a checkbox control.
+    value: '"Checkbox"'
   - name: empty
     uid: ExcelScript!ExcelScript.CellControlType.empty:member
     package: ExcelScript!
     summary: Type representing an empty control.
+    value: '"Empty"'
   - name: mixed
     uid: ExcelScript!ExcelScript.CellControlType.mixed:member
     package: ExcelScript!
     summary: Type representing a query that results in a mix of control results.
+    value: '"Mixed"'
   - name: unknown
     uid: ExcelScript!ExcelScript.CellControlType.unknown:member
     package: ExcelScript!
     summary: >-
       Type representing an unknown control. This represents a control that was
       added in a future version of Excel, and the current version of Excel
       doesn't know how to display this control.
+    value: '"Unknown"'

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

@@ -145,7 +145,7 @@ methods:
     uid: ExcelScript!ExcelScript.ChartDataLabel#getNumberFormat:member(1)
     package: ExcelScript!
     fullName: getNumberFormat()
-    summary: String value that represents the format code for data label.
+    summary: Specifies the format code for data label.
     remarks: ''
 
     isPreview: false
@@ -190,12 +190,11 @@ methods:
     package: ExcelScript!
     fullName: getShowAsStickyCallout()
     summary: >-
-      Gets a value that indicates whether the data labels are shown as a callout
-      with the tail anchor attached to the data point. If `true`<!-- -->, the
-      callout is one of the following values: "AccentCallout1",
-      "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout",
-      "WedgeRRectCallout" or "WedgeEllipseCallout". See Excel.GeometricShapeType
-      for more details.
+      Specifies if the data label is shown as a callout with the tail anchor
+      attached to the data point. If `true`<!-- -->, the callout is one of the
+      following values: "AccentCallout1", "AccentCallout2", "BorderCallout1",
+      "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or
+      "WedgeEllipseCallout".
     remarks: ''
 
     isPreview: false
@@ -564,7 +563,7 @@ methods:
     uid: ExcelScript!ExcelScript.ChartDataLabel#setNumberFormat:member(1)
     package: ExcelScript!
     fullName: setNumberFormat(numberFormat)
-    summary: String value that represents the format code for data label.
+    summary: Specifies the format code for data label.
     remarks: ''
 
     isPreview: false

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

@@ -15,9 +15,9 @@ methods:
     package: ExcelScript!
     fullName: getLeft()
     summary: >-
-      Represents the distance, in points, from the anchor to the left edge of
-      the chart data label. Note that when getting the value, it may differ
-      slightly from the set value.
+      Specifies the distance, in points, from the anchor to the left edge of the
+      chart data label. Note that when getting the value, it may differ slightly
+      from the set value.
     remarks: ''
 
     isPreview: false
@@ -32,7 +32,7 @@ methods:
     package: ExcelScript!
     fullName: getTop()
     summary: >-
-      Represents the distance, in points, from the anchor to the top edge of the
+      Specifies the distance, in points, from the anchor to the top edge of the
       chart data label. Note that when getting the value, it may differ slightly
       from the set value.
     remarks: ''
@@ -49,9 +49,9 @@ methods:
     package: ExcelScript!
     fullName: setLeft(left)
     summary: >-
-      Represents the distance, in points, from the anchor to the left edge of
-      the chart data label. Note that when getting the value, it may differ
-      slightly from the set value.
+      Specifies the distance, in points, from the anchor to the left edge of the
+      chart data label. Note that when getting the value, it may differ slightly
+      from the set value.
     remarks: ''
 
     isPreview: false
@@ -70,7 +70,7 @@ methods:
     package: ExcelScript!
     fullName: setTop(top)
     summary: >-
-      Represents the distance, in points, from the anchor to the top edge of the
+      Specifies the distance, in points, from the anchor to the top edge of the
       chart data label. Note that when getting the value, it may differ slightly
       from the set value.
     remarks: ''

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

@@ -157,12 +157,11 @@ methods:
     package: ExcelScript!
     fullName: getShowAsStickyCallout()
     summary: >-
-      Gets a value that indicates whether the data labels are shown as a callout
-      with the tail anchor attached to the data point. If `true`<!-- -->, the
-      callout is one of the following values: "AccentCallout1",
-      "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout",
-      "WedgeRRectCallout" or "WedgeEllipseCallout". See Excel.GeometricShapeType
-      for more details.
+      Specifies if the data labels are shown as a callout with the tail anchor
+      attached to the data point. If `true`<!-- -->, the callout is one of the
+      following values: "AccentCallout1", "AccentCallout2", "BorderCallout1",
+      "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or
+      "WedgeEllipseCallout".
     remarks: ''
 
     isPreview: false
@@ -205,9 +204,8 @@ methods:
     package: ExcelScript!
     fullName: getShowLeaderLines()
     summary: >-
-      Specifies a value that indicates whether leader lines are displayed for
-      the data labels. `true` if leader lines are shown; otherwise, `false`<!--
-      -->.
+      Specifies if leader lines are displayed for the data labels. `true` if
+      leader lines are shown; otherwise, `false`<!-- -->.
     remarks: ''
 
     isPreview: false
@@ -491,9 +489,8 @@ methods:
     package: ExcelScript!
     fullName: setShowLeaderLines(showLeaderLines)
     summary: >-
-      Specifies a value that indicates whether leader lines are displayed for
-      the data labels. `true` if leader lines are shown; otherwise, `false`<!--
-      -->.
+      Specifies if leader lines are displayed for the data labels. `true` if
+      leader lines are shown; otherwise, `false`<!-- -->.
     remarks: ''
 
     isPreview: false

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

@@ -83,7 +83,7 @@ methods:
     package: ExcelScript!
     fullName: getHeight()
     summary: >-
-      Represents the height, in points, of the slicer. Throws an
+      Specifies the height, in points, of the slicer. Throws an
       `InvalidArgument` exception when set with a negative value or zero as an
       input.
     remarks: ''
@@ -211,7 +211,7 @@ methods:
     package: ExcelScript!
     fullName: getSortBy()
     summary: >-
-      Represents the sort order of the items in the slicer. Possible values are:
+      Specifies the sort order of the items in the slicer. Possible values are:
       "DataSourceOrder", "Ascending", "Descending".
     remarks: ''
 
@@ -331,7 +331,7 @@ methods:
     package: ExcelScript!
     fullName: setHeight(height)
     summary: >-
-      Represents the height, in points, of the slicer. Throws an
+      Specifies the height, in points, of the slicer. Throws an
       `InvalidArgument` exception when set with a negative value or zero as an
       input.
     remarks: ''
@@ -391,7 +391,7 @@ methods:
     package: ExcelScript!
     fullName: setSortBy(sortBy)
     summary: >-
-      Represents the sort order of the items in the slicer. Possible values are:
+      Specifies the sort order of the items in the slicer. Possible values are:
       "DataSourceOrder", "Ascending", "Descending".
     remarks: ''
 

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

@@ -1768,7 +1768,10 @@ methods:
     uid: ExcelScript!ExcelScript.Worksheet#getUsedRange:member(1)
     package: ExcelScript!
     fullName: getUsedRange(valuesOnly)
-    summary: ''
+    summary: >-
+      The used range is the smallest range that encompasses any cells that have
+      a value or formatting assigned to them. If the entire worksheet is blank,
+      then this method returns `undefined`<!-- -->.
     remarks: ''
 
     isPreview: false

generate-docs/API Coverage Report.csv

@@ -447,10 +447,10 @@ ExcelScript.ChartDataLabel,"getHeight()",Method,Excellent,false
 ExcelScript.ChartDataLabel,"getHorizontalAlignment()",Method,Great,false
 ExcelScript.ChartDataLabel,"getLeft()",Method,Great,false
 ExcelScript.ChartDataLabel,"getLinkNumberFormat()",Method,Excellent,false
-ExcelScript.ChartDataLabel,"getNumberFormat()",Method,Great,false
+ExcelScript.ChartDataLabel,"getNumberFormat()",Method,Good,false
 ExcelScript.ChartDataLabel,"getPosition()",Method,Good,false
 ExcelScript.ChartDataLabel,"getSeparator()",Method,Great,false
-ExcelScript.ChartDataLabel,"getShowAsStickyCallout()",Method,Great,false
+ExcelScript.ChartDataLabel,"getShowAsStickyCallout()",Method,Excellent,false
 ExcelScript.ChartDataLabel,"getShowBubbleSize()",Method,Great,false
 ExcelScript.ChartDataLabel,"getShowCategoryName()",Method,Great,false
 ExcelScript.ChartDataLabel,"getShowLegendKey()",Method,Good,false
@@ -471,7 +471,7 @@ ExcelScript.ChartDataLabel,"setHeight(height)",Method,Poor,false
 ExcelScript.ChartDataLabel,"setHorizontalAlignment(horizontalAlignment)",Method,Great,false
 ExcelScript.ChartDataLabel,"setLeft(left)",Method,Great,false
 ExcelScript.ChartDataLabel,"setLinkNumberFormat(linkNumberFormat)",Method,Excellent,false
-ExcelScript.ChartDataLabel,"setNumberFormat(numberFormat)",Method,Great,false
+ExcelScript.ChartDataLabel,"setNumberFormat(numberFormat)",Method,Good,false
 ExcelScript.ChartDataLabel,"setPosition(position)",Method,Good,false
 ExcelScript.ChartDataLabel,"setSeparator(separator)",Method,Great,false
 ExcelScript.ChartDataLabel,"setShowBubbleSize(showBubbleSize)",Method,Great,false
@@ -517,10 +517,10 @@ ExcelScript.ChartDataLabels,"getLinkNumberFormat()",Method,Excellent,false
 ExcelScript.ChartDataLabels,"getNumberFormat()",Method,Good,false
 ExcelScript.ChartDataLabels,"getPosition()",Method,Good,false
 ExcelScript.ChartDataLabels,"getSeparator()",Method,Great,false
-ExcelScript.ChartDataLabels,"getShowAsStickyCallout()",Method,Great,false
+ExcelScript.ChartDataLabels,"getShowAsStickyCallout()",Method,Excellent,false
 ExcelScript.ChartDataLabels,"getShowBubbleSize()",Method,Great,false
 ExcelScript.ChartDataLabels,"getShowCategoryName()",Method,Great,false
-ExcelScript.ChartDataLabels,"getShowLeaderLines()",Method,Excellent,false
+ExcelScript.ChartDataLabels,"getShowLeaderLines()",Method,Great,false
 ExcelScript.ChartDataLabels,"getShowLegendKey()",Method,Good,false
 ExcelScript.ChartDataLabels,"getShowPercentage()",Method,Good,false
 ExcelScript.ChartDataLabels,"getShowSeriesName()",Method,Great,false
@@ -536,7 +536,7 @@ ExcelScript.ChartDataLabels,"setPosition(position)",Method,Good,false
 ExcelScript.ChartDataLabels,"setSeparator(separator)",Method,Great,false
 ExcelScript.ChartDataLabels,"setShowBubbleSize(showBubbleSize)",Method,Great,false
 ExcelScript.ChartDataLabels,"setShowCategoryName(showCategoryName)",Method,Great,false
-ExcelScript.ChartDataLabels,"setShowLeaderLines(showLeaderLines)",Method,Excellent,false
+ExcelScript.ChartDataLabels,"setShowLeaderLines(showLeaderLines)",Method,Great,false
 ExcelScript.ChartDataLabels,"setShowLegendKey(showLegendKey)",Method,Good,false
 ExcelScript.ChartDataLabels,"setShowPercentage(showPercentage)",Method,Good,false
 ExcelScript.ChartDataLabels,"setShowSeriesName(showSeriesName)",Method,Great,false
@@ -2956,7 +2956,7 @@ ExcelScript.Slicer,"getName()",Method,Poor,false
 ExcelScript.Slicer,"getSelectedItems()",Method,Good,false
 ExcelScript.Slicer,"getSlicerItem(key)",Method,Excellent,false
 ExcelScript.Slicer,"getSlicerItems()",Method,Fine,false
-ExcelScript.Slicer,"getSortBy()",Method,Good,false
+ExcelScript.Slicer,"getSortBy()",Method,Excellent,false
 ExcelScript.Slicer,"getStyle()",Method,Great,false
 ExcelScript.Slicer,"getTop()",Method,Excellent,false
 ExcelScript.Slicer,"getWidth()",Method,Excellent,false
@@ -2966,7 +2966,7 @@ ExcelScript.Slicer,"setCaption(caption)",Method,Poor,false
 ExcelScript.Slicer,"setHeight(height)",Method,Excellent,false
 ExcelScript.Slicer,"setLeft(left)",Method,Excellent,false
 ExcelScript.Slicer,"setName(name)",Method,Poor,false
-ExcelScript.Slicer,"setSortBy(sortBy)",Method,Good,false
+ExcelScript.Slicer,"setSortBy(sortBy)",Method,Excellent,false
 ExcelScript.Slicer,"setStyle(style)",Method,Great,false
 ExcelScript.Slicer,"setTop(top)",Method,Excellent,false
 ExcelScript.Slicer,"setWidth(width)",Method,Excellent,false
@@ -3285,7 +3285,7 @@ ExcelScript.WorkbookRangeAreas,"getAddresses()",Method,Excellent,false
 ExcelScript.WorkbookRangeAreas,"getAreas()",Method,Great,false
 ExcelScript.WorkbookRangeAreas,"getRangeAreasBySheet(key)",Method,Excellent,false
 ExcelScript.WorkbookRangeAreas,"getRanges()",Method,Great,false
-ExcelScript.Worksheet,N/A,Interface,Missing,true
+ExcelScript.Worksheet,N/A,Interface,Unknown,true
 ExcelScript.Worksheet,"activate()",Method,Poor,true
 ExcelScript.Worksheet,"addChart(type, sourceData, seriesBy)",Method,Poor,true
 ExcelScript.Worksheet,"addComment(cellAddress, content, contentType)",Method,Excellent,false
@@ -3351,7 +3351,7 @@ ExcelScript.Worksheet,"getTabColor()",Method,Excellent,false
 ExcelScript.Worksheet,"getTabId()",Method,Excellent,false
 ExcelScript.Worksheet,"getTable(key)",Method,Excellent,false
 ExcelScript.Worksheet,"getTables()",Method,Fine,false
-ExcelScript.Worksheet,"getUsedRange(valuesOnly)",Method,Missing,false
+ExcelScript.Worksheet,"getUsedRange(valuesOnly)",Method,Excellent,false
 ExcelScript.Worksheet,"getVerticalPageBreaks()",Method,Fine,false
 ExcelScript.Worksheet,"getVisibility()",Method,Poor,false
 ExcelScript.Worksheet,"getWorksheetCustomProperty(key)",Method,Excellent,false