Skip to content

Commit 550c827

Browse files
authored
[Excel] Release ExcelApi 1.20 to GA (#2346)
* [Excel] Release ExcelApi 1.20 to GA * Update ExcelApi 1.20 article * Remove extra js and js.map files in tools dir
1 parent b54df42 commit 550c827

File tree

1,238 files changed

+255887
-121
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,238 files changed

+255887
-121
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,7 @@ _dependentPackages/
99
.vscode/
1010
*.DS_Store
1111
build-errors.txt
12-
build-log.txt
12+
build-log.txt
13+
tools/dts-utilities*
14+
tools/version-remover*
15+
tools/whats-new*

docs/docs-ref-autogen/common/toc.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -501,6 +501,9 @@ items:
501501
- name: ExcelApi online-only requirement set
502502
href: ../../requirement-sets/excel/excel-api-online-requirement-set.md
503503
displayName: Excel
504+
- name: ExcelApi 1.20 requirement set
505+
href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md
506+
displayName: Excel
504507
- name: ExcelApi 1.19 requirement set
505508
href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md
506509
displayName: Excel

docs/docs-ref-autogen/common_preview/toc.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -501,6 +501,9 @@ items:
501501
- name: ExcelApi online-only requirement set
502502
href: ../../requirement-sets/excel/excel-api-online-requirement-set.md
503503
displayName: Excel
504+
- name: ExcelApi 1.20 requirement set
505+
href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md
506+
displayName: Excel
504507
- name: ExcelApi 1.19 requirement set
505508
href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md
506509
displayName: Excel

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

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,16 @@ uid: excel!Excel.CardLayout:type
44
package: excel!
55
fullName: Excel.CardLayout
66
summary: Represents the layout of a card in card view.
7-
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout), [Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout)"
7+
remarks: >-
8+
\[ [API set: ExcelApi
9+
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
10+
11+
12+
Learn more about the types in this type alias through the following links.
13+
14+
15+
[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout),
16+
[Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout)
817
918
isPreview: false
1019
isDeprecated: false

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

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type
44
package: excel!
55
fullName: Excel.CardLayoutSection
66
summary: Represents the layout of a section of a card in card view.
7-
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)"
7+
remarks: >-
8+
\[ [API set: ExcelApi
9+
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
10+
11+
12+
Learn more about the types in this type alias through the following links.
13+
14+
15+
[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection),
16+
[Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection),
17+
[Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)
818
919
isPreview: false
1020
isDeprecated: false

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

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type
44
package: excel!
55
fullName: Excel.CellControl
66
summary: Represents an interactable control inside of a cell.
7-
remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```"
7+
remarks: >-
8+
\[ [API set: ExcelApi
9+
1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
10+
11+
12+
13+
14+
Learn more about the types in this type alias through the following links.
15+
16+
17+
[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol),
18+
[Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol),
19+
[Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol),
20+
[Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)
21+
22+
23+
#### Examples
24+
25+
26+
```TypeScript
27+
28+
// Link to full sample:
29+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml
30+
31+
32+
// Add checkboxes to the table.
33+
34+
await Excel.run(async (context) => {
35+
const sheet = context.workbook.worksheets.getActiveWorksheet();
36+
37+
// Get the second column in the table, without the header.
38+
const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();
39+
40+
// Change the boolean values to checkboxes.
41+
range.control = {
42+
type: Excel.CellControlType.checkbox
43+
};
44+
await context.sync();
45+
});
46+
47+
```
848
949
isPreview: false
1050
isDeprecated: false

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

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,30 @@ uid: excel!Excel.CellValue:type
44
package: excel!
55
fullName: Excel.CellValue
66
summary: Represents the value in a cell.
7-
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)"
7+
remarks: >-
8+
\[ [API set: ExcelApi
9+
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
10+
11+
12+
Learn more about the types in this type alias through the following links.
13+
14+
15+
[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue),
16+
[Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue),
17+
[Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue),
18+
[Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue),
19+
[Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue),
20+
[Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue),
21+
[Excel.ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue),
22+
[Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue),
23+
[Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue),
24+
[Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue),
25+
[Excel.LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue),
26+
[Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue),
27+
[Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue),
28+
[Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue),
29+
[Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue),
30+
[Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)
831
932
isPreview: false
1033
isDeprecated: false

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

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata
66
summary: >-
77
Represents the value and metadata of a property. The metadata applies to the
88
property (and not the value), but it is combined with the value in this type.
9-
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)"
9+
remarks: >-
10+
\[ [API set: ExcelApi
11+
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
12+
13+
14+
Learn more about the types in this type alias through the following links.
15+
16+
17+
[Excel.CellValue](/javascript/api/excel/excel.cellvalue),
18+
[Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)
1019
1120
isPreview: false
1221
isDeprecated: false

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,15 @@ fullName: Excel.CompactLayout
66
summary: >-
77
Represents the layout used when there is limited space to represent the
88
entity.
9-
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)"
9+
remarks: >-
10+
\[ [API set: ExcelApi
11+
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
12+
13+
14+
Learn more about the types in this type alias through the following links.
15+
16+
17+
[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)
1018
1119
isPreview: false
1220
isDeprecated: false

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ package: excel!
55
fullName: Excel.CustomFunctionManager
66
summary: Manages settings on custom functions.
77
remarks: >-
8-
\[ [API set: ExcelApi BETA (PREVIEW
9-
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
8+
\[ [API set: ExcelApi
9+
1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
1010
11-
isPreview: true
11+
isPreview: false
1212
isDeprecated: false
1313
type: class
1414
properties:
@@ -21,7 +21,7 @@ properties:
2121
process to the Office host application's process.
2222
remarks: ''
2323

24-
isPreview: true
24+
isPreview: false
2525
isDeprecated: false
2626
syntax:
2727
content: 'context: RequestContext;'
@@ -37,7 +37,7 @@ methods:
3737
must call `context.sync()` before reading the properties.
3838
remarks: ''
3939

40-
isPreview: true
40+
isPreview: false
4141
isDeprecated: false
4242
syntax:
4343
content: 'load(propertyNames?: string | string[]): Excel.CustomFunctionManager;'
@@ -58,11 +58,11 @@ methods:
5858
Queues up a command to load the specified properties of the object. You
5959
must call `context.sync()` before reading the properties.
6060
remarks: >-
61-
\[ [API set: ExcelApi BETA (PREVIEW
62-
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
61+
\[ [API set: ExcelApi
62+
1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
6363
\]
6464
65-
isPreview: true
65+
isPreview: false
6666
isDeprecated: false
6767
syntax:
6868
content: |-
@@ -91,11 +91,11 @@ methods:
9191
fullName: newObject(context)
9292
summary: Create a new instance of the `Excel.CustomFunctionManager` object.
9393
remarks: >-
94-
\[ [API set: ExcelApi BETA (PREVIEW
95-
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
94+
\[ [API set: ExcelApi
95+
1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
9696
\]
9797
98-
isPreview: true
98+
isPreview: false
9999
isDeprecated: false
100100
syntax:
101101
content: >-
@@ -114,11 +114,11 @@ methods:
114114
fullName: setVisibility(customFunctionVisibilityOptions)
115115
summary: Show or hide custom functions in Excel AutoComplete.
116116
remarks: >-
117-
\[ [API set: ExcelApi BETA (PREVIEW
118-
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
117+
\[ [API set: ExcelApi
118+
1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
119119
\]
120120
121-
isPreview: true
121+
isPreview: false
122122
isDeprecated: false
123123
syntax:
124124
content: >-
@@ -146,7 +146,7 @@ methods:
146146
shallow copies of any loaded child properties from the original object.
147147
remarks: ''
148148

149-
isPreview: true
149+
isPreview: false
150150
isDeprecated: false
151151
syntax:
152152
content: 'toJSON(): Excel.Interfaces.CustomFunctionManagerData;'

0 commit comments

Comments
 (0)