Skip to content

Commit 929a858

Browse files
ElizabethSamuel-MSFTgithub-actions
ElizabethSamuel-MSFT
and
github-actions
authored
Automatically generated docs (#2350)
Co-authored-by: github-actions <[email protected]>
1 parent 083cc6d commit 929a858

File tree

70 files changed

+171
-1225
lines changed

Some content is hidden

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

70 files changed

+171
-1225
lines changed

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

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,7 @@ 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: >-
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)
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)"
178

189
isPreview: false
1910
isDeprecated: false

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

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,7 @@ 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: >-
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)
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)"
188

199
isPreview: false
2010
isDeprecated: false

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

Lines changed: 1 addition & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -4,47 +4,7 @@ uid: excel!Excel.CellControl:type
44
package: excel!
55
fullName: Excel.CellControl
66
summary: Represents an interactable control inside of a cell.
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-
```
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```"
488

499
isPreview: false
5010
isDeprecated: false

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

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,7 @@ uid: excel!Excel.CellValue:type
44
package: excel!
55
fullName: Excel.CellValue
66
summary: Represents the value in a cell.
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)
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)"
318

329
isPreview: false
3310
isDeprecated: false

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

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,7 @@ 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: >-
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)
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)"
1910

2011
isPreview: false
2112
isDeprecated: false

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,7 @@ fullName: Excel.CompactLayout
66
summary: >-
77
Represents the layout used when there is limited space to represent the
88
entity.
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)
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)"
1810

1911
isPreview: false
2012
isDeprecated: false

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

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,7 @@ uid: excel!Excel.EntityPropertyType:type
44
package: excel!
55
fullName: Excel.EntityPropertyType
66
summary: Represents the value of a property.
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.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata),
16-
[Excel.CellValue](/javascript/api/excel/excel.cellvalue)
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.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)"
178

189
isPreview: false
1910
isDeprecated: false

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

Lines changed: 1 addition & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -4,64 +4,7 @@ uid: excel!Excel.ErrorCellValue:type
44
package: excel!
55
fullName: Excel.ErrorCellValue
66
summary: Represents a cell value which contains an error.
7-
remarks: >-
8-
\[ [API set: ExcelApi
9-
1.16](/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.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue),
18-
[Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue),
19-
[Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue),
20-
[Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue),
21-
[Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue),
22-
[Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue),
23-
[Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue),
24-
[Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue),
25-
[Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue),
26-
[Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue),
27-
[Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue),
28-
[Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue),
29-
[Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue),
30-
[Excel.PythonErrorCellValue](/javascript/api/excel/excel.pythonerrorcellvalue),
31-
[Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue),
32-
[Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue),
33-
[Excel.TimeoutErrorCellValue](/javascript/api/excel/excel.timeouterrorcellvalue),
34-
[Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)
35-
36-
37-
#### Examples
38-
39-
40-
```TypeScript
41-
42-
// Link to full sample:
43-
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml
44-
45-
46-
// This function sets the value of cell A1 to a #BUSY! error using data types.
47-
48-
await Excel.run(async (context) => {
49-
// Retrieve the Sample worksheet and cell A1 on that sheet.
50-
const sheet = context.workbook.worksheets.getItemOrNullObject("Sample");
51-
const range = sheet.getRange("A1");
52-
53-
// Get the error data type and set its type to `busy`.
54-
const error: Excel.ErrorCellValue = {
55-
type: Excel.CellValueType.error,
56-
errorType: Excel.ErrorCellValueType.busy
57-
};
58-
59-
// Set cell A1 as the busy error.
60-
range.valuesAsJson = [[error]];
61-
await context.sync();
62-
});
63-
64-
```
7+
remarks: "\\[ [API set: ExcelApi 1.16](/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.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.PythonErrorCellValue](/javascript/api/excel/excel.pythonerrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.TimeoutErrorCellValue](/javascript/api/excel/excel.timeouterrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```"
658

669
isPreview: false
6710
isDeprecated: false

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,7 @@ uid: excel!Excel.FunctionCellValue:type
44
package: excel!
55
fullName: Excel.FunctionCellValue
66
summary: Represents a cell value which can be evaluated as a function.
7-
remarks: >-
8-
\[ [API set: ExcelApi
9-
1.19](/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.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)
7+
remarks: "\\[ [API set: ExcelApi 1.19](/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.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)"
168

179
isPreview: false
1810
isDeprecated: false

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

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,7 @@ uid: excel!Excel.ReferencedValue:type
44
package: excel!
55
fullName: Excel.ReferencedValue
66
summary: Represents the value in a cell.
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.EntityCellValue](/javascript/api/excel/excel.entitycellvalue),
17-
[Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue),
18-
[Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue),
19-
[Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue),
20-
[Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)
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.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)"
218

229
isPreview: false
2310
isDeprecated: false

0 commit comments

Comments
 (0)