Skip to content

Commit 91c828b

Browse files
alison-mkalison-mk
authored
[excel] Update reference docs with latest IntelliSense file (#383)
* [excel] Update reference docs with latest IntelliSense file * Run GenerateDocs.sh
1 parent 8d27ebc commit 91c828b

11 files changed

Lines changed: 251 additions & 125 deletions

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

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,8 @@ functions:
332332
summary: >-
333333
Return the text encoding of the document as a PDF. If the document is
334334
empty, then the following error is shown: "We didn't find anything to
335-
print".
335+
print". Some actions made prior to using this API may not be captured in
336+
the PDF in Excel on the web.
336337
remarks: ''
337338

338339
isPreview: true
@@ -342,7 +343,11 @@ functions:
342343
return:
343344
type: string
344345
description: The content of the workbook as a string, in PDF format.
345-
- name: "Global.OfficeScript.downloadFile({\r\n name,\r\n content,\r\n })"
346+
- name: |-
347+
Global.OfficeScript.downloadFile({
348+
name,
349+
content,
350+
})
346351
uid: ExcelScript!Global.OfficeScript.downloadFile:function(1)
347352
package: ExcelScript!
348353
summary: >-
@@ -362,7 +367,11 @@ functions:
362367
content: string;
363368
}): void;
364369
parameters:
365-
- id: "{\r\n name,\r\n content,\r\n }"
370+
- id: |-
371+
{
372+
name,
373+
content,
374+
}
366375
description: ''
367376
type: |-
368377
{
@@ -385,6 +394,31 @@ functions:
385394
return:
386395
type: string
387396
description: ''
397+
- name: Global.OfficeScript.saveCopyAs(filename)
398+
uid: ExcelScript!Global.OfficeScript.saveCopyAs:function(1)
399+
package: ExcelScript!
400+
summary: >-
401+
Saves a copy of the current workbook in OneDrive, in the same directory as
402+
the original file, with the specified file name. The API has a timeout
403+
limit of 30 seconds. This limit is rarely exceeded. Note: Timeout doesn't
404+
necessarily indicate that the API failed. The workbook copy may still be
405+
created, but after the timeout limit this API does not return a success or
406+
failure message.
407+
remarks: ''
408+
409+
isPreview: true
410+
isDeprecated: false
411+
syntax:
412+
content: 'export function saveCopyAs(filename: string): void;'
413+
parameters:
414+
- id: filename
415+
description: >-
416+
The file name of the copied and saved file. The file name must end
417+
with ".xlsx".
418+
type: string
419+
return:
420+
type: void
421+
description: ''
388422
- name: Global.OfficeScript.sendMail(mailProperties)
389423
uid: ExcelScript!Global.OfficeScript.sendMail:function(1)
390424
package: ExcelScript!

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

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,16 @@ uid: ExcelScript!ExcelScript.CellControl:type
44
package: ExcelScript!
55
fullName: ExcelScript.CellControl
66
summary: Represents an interactable control inside of a cell.
7-
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)"
7+
remarks: >-
8+
9+
10+
Learn more about the types in this type alias through the following links.
11+
12+
13+
[ExcelScript.UnknownCellControl](/javascript/api/office-scripts/excelscript/excelscript.unknowncellcontrol),
14+
[ExcelScript.EmptyCellControl](/javascript/api/office-scripts/excelscript/excelscript.emptycellcontrol),
15+
[ExcelScript.MixedCellControl](/javascript/api/office-scripts/excelscript/excelscript.mixedcellcontrol),
16+
[ExcelScript.CheckboxCellControl](/javascript/api/office-scripts/excelscript/excelscript.checkboxcellcontrol)
817
918
isPreview: false
1019
isDeprecated: false

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,22 @@ fields:
1313
uid: ExcelScript!ExcelScript.CellControlType.checkbox:member
1414
package: ExcelScript!
1515
summary: Type representing a checkbox control.
16+
value: '"Checkbox"'
1617
- name: empty
1718
uid: ExcelScript!ExcelScript.CellControlType.empty:member
1819
package: ExcelScript!
1920
summary: Type representing an empty control.
21+
value: '"Empty"'
2022
- name: mixed
2123
uid: ExcelScript!ExcelScript.CellControlType.mixed:member
2224
package: ExcelScript!
2325
summary: Type representing a query that results in a mix of control results.
26+
value: '"Mixed"'
2427
- name: unknown
2528
uid: ExcelScript!ExcelScript.CellControlType.unknown:member
2629
package: ExcelScript!
2730
summary: >-
2831
Type representing an unknown control. This represents a control that was
2932
added in a future version of Excel, and the current version of Excel
3033
doesn't know how to display this control.
34+
value: '"Unknown"'

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ methods:
145145
uid: ExcelScript!ExcelScript.ChartDataLabel#getNumberFormat:member(1)
146146
package: ExcelScript!
147147
fullName: getNumberFormat()
148-
summary: String value that represents the format code for data label.
148+
summary: Specifies the format code for data label.
149149
remarks: ''
150150

151151
isPreview: false
@@ -190,12 +190,11 @@ methods:
190190
package: ExcelScript!
191191
fullName: getShowAsStickyCallout()
192192
summary: >-
193-
Gets a value that indicates whether the data labels are shown as a callout
194-
with the tail anchor attached to the data point. If `true`<!-- -->, the
195-
callout is one of the following values: "AccentCallout1",
196-
"AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout",
197-
"WedgeRRectCallout" or "WedgeEllipseCallout". See Excel.GeometricShapeType
198-
for more details.
193+
Specifies if the data label is shown as a callout with the tail anchor
194+
attached to the data point. If `true`<!-- -->, the callout is one of the
195+
following values: "AccentCallout1", "AccentCallout2", "BorderCallout1",
196+
"BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or
197+
"WedgeEllipseCallout".
199198
remarks: ''
200199

201200
isPreview: false
@@ -564,7 +563,7 @@ methods:
564563
uid: ExcelScript!ExcelScript.ChartDataLabel#setNumberFormat:member(1)
565564
package: ExcelScript!
566565
fullName: setNumberFormat(numberFormat)
567-
summary: String value that represents the format code for data label.
566+
summary: Specifies the format code for data label.
568567
remarks: ''
569568

570569
isPreview: false

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ methods:
1515
package: ExcelScript!
1616
fullName: getLeft()
1717
summary: >-
18-
Represents the distance, in points, from the anchor to the left edge of
19-
the chart data label. Note that when getting the value, it may differ
20-
slightly from the set value.
18+
Specifies the distance, in points, from the anchor to the left edge of the
19+
chart data label. Note that when getting the value, it may differ slightly
20+
from the set value.
2121
remarks: ''
2222

2323
isPreview: false
@@ -32,7 +32,7 @@ methods:
3232
package: ExcelScript!
3333
fullName: getTop()
3434
summary: >-
35-
Represents the distance, in points, from the anchor to the top edge of the
35+
Specifies the distance, in points, from the anchor to the top edge of the
3636
chart data label. Note that when getting the value, it may differ slightly
3737
from the set value.
3838
remarks: ''
@@ -49,9 +49,9 @@ methods:
4949
package: ExcelScript!
5050
fullName: setLeft(left)
5151
summary: >-
52-
Represents the distance, in points, from the anchor to the left edge of
53-
the chart data label. Note that when getting the value, it may differ
54-
slightly from the set value.
52+
Specifies the distance, in points, from the anchor to the left edge of the
53+
chart data label. Note that when getting the value, it may differ slightly
54+
from the set value.
5555
remarks: ''
5656

5757
isPreview: false
@@ -70,7 +70,7 @@ methods:
7070
package: ExcelScript!
7171
fullName: setTop(top)
7272
summary: >-
73-
Represents the distance, in points, from the anchor to the top edge of the
73+
Specifies the distance, in points, from the anchor to the top edge of the
7474
chart data label. Note that when getting the value, it may differ slightly
7575
from the set value.
7676
remarks: ''

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

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -157,12 +157,11 @@ methods:
157157
package: ExcelScript!
158158
fullName: getShowAsStickyCallout()
159159
summary: >-
160-
Gets a value that indicates whether the data labels are shown as a callout
161-
with the tail anchor attached to the data point. If `true`<!-- -->, the
162-
callout is one of the following values: "AccentCallout1",
163-
"AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout",
164-
"WedgeRRectCallout" or "WedgeEllipseCallout". See Excel.GeometricShapeType
165-
for more details.
160+
Specifies if the data labels are shown as a callout with the tail anchor
161+
attached to the data point. If `true`<!-- -->, the callout is one of the
162+
following values: "AccentCallout1", "AccentCallout2", "BorderCallout1",
163+
"BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or
164+
"WedgeEllipseCallout".
166165
remarks: ''
167166

168167
isPreview: false
@@ -205,9 +204,8 @@ methods:
205204
package: ExcelScript!
206205
fullName: getShowLeaderLines()
207206
summary: >-
208-
Specifies a value that indicates whether leader lines are displayed for
209-
the data labels. `true` if leader lines are shown; otherwise, `false`<!--
210-
-->.
207+
Specifies if leader lines are displayed for the data labels. `true` if
208+
leader lines are shown; otherwise, `false`<!-- -->.
211209
remarks: ''
212210

213211
isPreview: false
@@ -491,9 +489,8 @@ methods:
491489
package: ExcelScript!
492490
fullName: setShowLeaderLines(showLeaderLines)
493491
summary: >-
494-
Specifies a value that indicates whether leader lines are displayed for
495-
the data labels. `true` if leader lines are shown; otherwise, `false`<!--
496-
-->.
492+
Specifies if leader lines are displayed for the data labels. `true` if
493+
leader lines are shown; otherwise, `false`<!-- -->.
497494
remarks: ''
498495

499496
isPreview: false

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ methods:
8383
package: ExcelScript!
8484
fullName: getHeight()
8585
summary: >-
86-
Represents the height, in points, of the slicer. Throws an
86+
Specifies the height, in points, of the slicer. Throws an
8787
`InvalidArgument` exception when set with a negative value or zero as an
8888
input.
8989
remarks: ''
@@ -211,7 +211,7 @@ methods:
211211
package: ExcelScript!
212212
fullName: getSortBy()
213213
summary: >-
214-
Represents the sort order of the items in the slicer. Possible values are:
214+
Specifies the sort order of the items in the slicer. Possible values are:
215215
"DataSourceOrder", "Ascending", "Descending".
216216
remarks: ''
217217

@@ -331,7 +331,7 @@ methods:
331331
package: ExcelScript!
332332
fullName: setHeight(height)
333333
summary: >-
334-
Represents the height, in points, of the slicer. Throws an
334+
Specifies the height, in points, of the slicer. Throws an
335335
`InvalidArgument` exception when set with a negative value or zero as an
336336
input.
337337
remarks: ''
@@ -391,7 +391,7 @@ methods:
391391
package: ExcelScript!
392392
fullName: setSortBy(sortBy)
393393
summary: >-
394-
Represents the sort order of the items in the slicer. Possible values are:
394+
Specifies the sort order of the items in the slicer. Possible values are:
395395
"DataSourceOrder", "Ascending", "Descending".
396396
remarks: ''
397397

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1768,7 +1768,10 @@ methods:
17681768
uid: ExcelScript!ExcelScript.Worksheet#getUsedRange:member(1)
17691769
package: ExcelScript!
17701770
fullName: getUsedRange(valuesOnly)
1771-
summary: ''
1771+
summary: >-
1772+
The used range is the smallest range that encompasses any cells that have
1773+
a value or formatting assigned to them. If the entire worksheet is blank,
1774+
then this method returns `undefined`<!-- -->.
17721775
remarks: ''
17731776

17741777
isPreview: false

‎generate-docs/API Coverage Report.csv‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -447,10 +447,10 @@ ExcelScript.ChartDataLabel,"getHeight()",Method,Excellent,false
447447
ExcelScript.ChartDataLabel,"getHorizontalAlignment()",Method,Great,false
448448
ExcelScript.ChartDataLabel,"getLeft()",Method,Great,false
449449
ExcelScript.ChartDataLabel,"getLinkNumberFormat()",Method,Excellent,false
450-
ExcelScript.ChartDataLabel,"getNumberFormat()",Method,Great,false
450+
ExcelScript.ChartDataLabel,"getNumberFormat()",Method,Good,false
451451
ExcelScript.ChartDataLabel,"getPosition()",Method,Good,false
452452
ExcelScript.ChartDataLabel,"getSeparator()",Method,Great,false
453-
ExcelScript.ChartDataLabel,"getShowAsStickyCallout()",Method,Great,false
453+
ExcelScript.ChartDataLabel,"getShowAsStickyCallout()",Method,Excellent,false
454454
ExcelScript.ChartDataLabel,"getShowBubbleSize()",Method,Great,false
455455
ExcelScript.ChartDataLabel,"getShowCategoryName()",Method,Great,false
456456
ExcelScript.ChartDataLabel,"getShowLegendKey()",Method,Good,false
@@ -471,7 +471,7 @@ ExcelScript.ChartDataLabel,"setHeight(height)",Method,Poor,false
471471
ExcelScript.ChartDataLabel,"setHorizontalAlignment(horizontalAlignment)",Method,Great,false
472472
ExcelScript.ChartDataLabel,"setLeft(left)",Method,Great,false
473473
ExcelScript.ChartDataLabel,"setLinkNumberFormat(linkNumberFormat)",Method,Excellent,false
474-
ExcelScript.ChartDataLabel,"setNumberFormat(numberFormat)",Method,Great,false
474+
ExcelScript.ChartDataLabel,"setNumberFormat(numberFormat)",Method,Good,false
475475
ExcelScript.ChartDataLabel,"setPosition(position)",Method,Good,false
476476
ExcelScript.ChartDataLabel,"setSeparator(separator)",Method,Great,false
477477
ExcelScript.ChartDataLabel,"setShowBubbleSize(showBubbleSize)",Method,Great,false
@@ -517,10 +517,10 @@ ExcelScript.ChartDataLabels,"getLinkNumberFormat()",Method,Excellent,false
517517
ExcelScript.ChartDataLabels,"getNumberFormat()",Method,Good,false
518518
ExcelScript.ChartDataLabels,"getPosition()",Method,Good,false
519519
ExcelScript.ChartDataLabels,"getSeparator()",Method,Great,false
520-
ExcelScript.ChartDataLabels,"getShowAsStickyCallout()",Method,Great,false
520+
ExcelScript.ChartDataLabels,"getShowAsStickyCallout()",Method,Excellent,false
521521
ExcelScript.ChartDataLabels,"getShowBubbleSize()",Method,Great,false
522522
ExcelScript.ChartDataLabels,"getShowCategoryName()",Method,Great,false
523-
ExcelScript.ChartDataLabels,"getShowLeaderLines()",Method,Excellent,false
523+
ExcelScript.ChartDataLabels,"getShowLeaderLines()",Method,Great,false
524524
ExcelScript.ChartDataLabels,"getShowLegendKey()",Method,Good,false
525525
ExcelScript.ChartDataLabels,"getShowPercentage()",Method,Good,false
526526
ExcelScript.ChartDataLabels,"getShowSeriesName()",Method,Great,false
@@ -536,7 +536,7 @@ ExcelScript.ChartDataLabels,"setPosition(position)",Method,Good,false
536536
ExcelScript.ChartDataLabels,"setSeparator(separator)",Method,Great,false
537537
ExcelScript.ChartDataLabels,"setShowBubbleSize(showBubbleSize)",Method,Great,false
538538
ExcelScript.ChartDataLabels,"setShowCategoryName(showCategoryName)",Method,Great,false
539-
ExcelScript.ChartDataLabels,"setShowLeaderLines(showLeaderLines)",Method,Excellent,false
539+
ExcelScript.ChartDataLabels,"setShowLeaderLines(showLeaderLines)",Method,Great,false
540540
ExcelScript.ChartDataLabels,"setShowLegendKey(showLegendKey)",Method,Good,false
541541
ExcelScript.ChartDataLabels,"setShowPercentage(showPercentage)",Method,Good,false
542542
ExcelScript.ChartDataLabels,"setShowSeriesName(showSeriesName)",Method,Great,false
@@ -2956,7 +2956,7 @@ ExcelScript.Slicer,"getName()",Method,Poor,false
29562956
ExcelScript.Slicer,"getSelectedItems()",Method,Good,false
29572957
ExcelScript.Slicer,"getSlicerItem(key)",Method,Excellent,false
29582958
ExcelScript.Slicer,"getSlicerItems()",Method,Fine,false
2959-
ExcelScript.Slicer,"getSortBy()",Method,Good,false
2959+
ExcelScript.Slicer,"getSortBy()",Method,Excellent,false
29602960
ExcelScript.Slicer,"getStyle()",Method,Great,false
29612961
ExcelScript.Slicer,"getTop()",Method,Excellent,false
29622962
ExcelScript.Slicer,"getWidth()",Method,Excellent,false
@@ -2966,7 +2966,7 @@ ExcelScript.Slicer,"setCaption(caption)",Method,Poor,false
29662966
ExcelScript.Slicer,"setHeight(height)",Method,Excellent,false
29672967
ExcelScript.Slicer,"setLeft(left)",Method,Excellent,false
29682968
ExcelScript.Slicer,"setName(name)",Method,Poor,false
2969-
ExcelScript.Slicer,"setSortBy(sortBy)",Method,Good,false
2969+
ExcelScript.Slicer,"setSortBy(sortBy)",Method,Excellent,false
29702970
ExcelScript.Slicer,"setStyle(style)",Method,Great,false
29712971
ExcelScript.Slicer,"setTop(top)",Method,Excellent,false
29722972
ExcelScript.Slicer,"setWidth(width)",Method,Excellent,false
@@ -3285,7 +3285,7 @@ ExcelScript.WorkbookRangeAreas,"getAddresses()",Method,Excellent,false
32853285
ExcelScript.WorkbookRangeAreas,"getAreas()",Method,Great,false
32863286
ExcelScript.WorkbookRangeAreas,"getRangeAreasBySheet(key)",Method,Excellent,false
32873287
ExcelScript.WorkbookRangeAreas,"getRanges()",Method,Great,false
3288-
ExcelScript.Worksheet,N/A,Interface,Missing,true
3288+
ExcelScript.Worksheet,N/A,Interface,Unknown,true
32893289
ExcelScript.Worksheet,"activate()",Method,Poor,true
32903290
ExcelScript.Worksheet,"addChart(type, sourceData, seriesBy)",Method,Poor,true
32913291
ExcelScript.Worksheet,"addComment(cellAddress, content, contentType)",Method,Excellent,false
@@ -3351,7 +3351,7 @@ ExcelScript.Worksheet,"getTabColor()",Method,Excellent,false
33513351
ExcelScript.Worksheet,"getTabId()",Method,Excellent,false
33523352
ExcelScript.Worksheet,"getTable(key)",Method,Excellent,false
33533353
ExcelScript.Worksheet,"getTables()",Method,Fine,false
3354-
ExcelScript.Worksheet,"getUsedRange(valuesOnly)",Method,Missing,false
3354+
ExcelScript.Worksheet,"getUsedRange(valuesOnly)",Method,Excellent,false
33553355
ExcelScript.Worksheet,"getVerticalPageBreaks()",Method,Fine,false
33563356
ExcelScript.Worksheet,"getVisibility()",Method,Poor,false
33573357
ExcelScript.Worksheet,"getWorksheetCustomProperty(key)",Method,Excellent,false

0 commit comments

Comments
 (0)