Skip to content

Commit bced03f

Browse files
ElizabethSamuel-MSFTgithub-actions
ElizabethSamuel-MSFT
and
github-actions
authored
Automatically generated docs (#2294)
* Automatically generated docs * Pull in fixes --------- Co-authored-by: github-actions <[email protected]>
1 parent 25cc113 commit bced03f

File tree

50 files changed

+631
-252
lines changed

Some content is hidden

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

50 files changed

+631
-252
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,7 @@ classes:
262262
- excel!Excel.ConditionalRangeFormat:class
263263
- excel!Excel.CultureInfo:class
264264
- excel!Excel.CustomConditionalFormat:class
265+
- excel!Excel.CustomFunctionManager:class
265266
- excel!Excel.CustomProperty:class
266267
- excel!Excel.CustomPropertyCollection:class
267268
- excel!Excel.CustomXmlPart:class
@@ -446,6 +447,7 @@ interfaces:
446447
- excel!Excel.ConditionalTopBottomRule:interface
447448
- excel!Excel.ConnectErrorCellValue:interface
448449
- excel!Excel.CustomDataValidation:interface
450+
- excel!Excel.CustomFunctionVisibilityOptions:interface
449451
- excel!Excel.DataValidationErrorAlert:interface
450452
- excel!Excel.DataValidationPrompt:interface
451453
- excel!Excel.DataValidationRule:interface
@@ -695,6 +697,7 @@ interfaces:
695697
- excel!Excel.Interfaces.CustomConditionalFormatData:interface
696698
- excel!Excel.Interfaces.CustomConditionalFormatLoadOptions:interface
697699
- excel!Excel.Interfaces.CustomConditionalFormatUpdateData:interface
700+
- excel!Excel.Interfaces.CustomFunctionManagerData:interface
698701
- excel!Excel.Interfaces.CustomPropertyCollectionData:interface
699702
- excel!Excel.Interfaces.CustomPropertyCollectionLoadOptions:interface
700703
- excel!Excel.Interfaces.CustomPropertyCollectionUpdateData:interface

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ properties:
7272
"PythonGridQuery" | "PythonPowerQueryDataUploadEtagChanged" |
7373
"PythonPowerQueryDataUploadSizeLimitExceeded" | "InvalidPythonObject" |
7474
"QueryInCell" | "UninitializedPythonObject" | "ExternalQueryRef" |
75-
"ERegexReplaceCharLimit" | "UnexpectedReturnValue";
75+
"ERegexReplaceCharLimit" | "UnexpectedReturnValue" | "FunctionInCell";
7676
return:
7777
type: >-
7878
<xref uid="excel!Excel.CalcErrorCellValueSubType:enum" /> | "Unknown"
@@ -83,7 +83,7 @@ properties:
8383
"PythonPowerQueryDataUploadEtagChanged" |
8484
"PythonPowerQueryDataUploadSizeLimitExceeded" | "InvalidPythonObject"
8585
| "QueryInCell" | "UninitializedPythonObject" | "ExternalQueryRef" |
86-
"ERegexReplaceCharLimit" | "UnexpectedReturnValue"
86+
"ERegexReplaceCharLimit" | "UnexpectedReturnValue" | "FunctionInCell"
8787
- name: errorType
8888
uid: excel!Excel.CalcErrorCellValue#errorType:member
8989
package: excel!

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

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,18 @@ fields:
8484
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
8585
\]
8686
value: '"ExternalQueryRef"'
87+
- name: functionInCell
88+
uid: excel!Excel.CalcErrorCellValueSubType.functionInCell:member
89+
package: excel!
90+
summary: >-
91+
An error caused by a cell's formula evaluating to a function or function
92+
reference. Displays as error type \#CALC! in Excel.
93+
94+
95+
* \[ [API set: ExcelApi BETA (PREVIEW
96+
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
97+
\]
98+
value: '"FunctionInCell"'
8799
- name: invalidPythonObject
88100
uid: excel!Excel.CalcErrorCellValueSubType.invalidPythonObject:member
89101
package: excel!
@@ -105,9 +117,10 @@ fields:
105117
as error type \#CALC! in Excel.
106118
107119
108-
* \[ [API set: ExcelApi
109-
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
110-
\]
120+
Warning: `lambdaInCell` was deprecated in ExcelAPI 1.19.
121+
122+
123+
* \[Api set: ExcelApi 1.16\]
111124
value: '"LambdaInCell"'
112125
- name: pythonGridQuery
113126
uid: excel!Excel.CalcErrorCellValueSubType.pythonGridQuery:member

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

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
### YamlMime:TSType
2+
name: Excel.CustomFunctionManager
3+
uid: excel!Excel.CustomFunctionManager:class
4+
package: excel!
5+
fullName: Excel.CustomFunctionManager
6+
summary: Manages settings on custom functions.
7+
remarks: >-
8+
\[ [API set: ExcelApi BETA (PREVIEW
9+
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
10+
11+
isPreview: true
12+
isDeprecated: false
13+
type: class
14+
properties:
15+
- name: context
16+
uid: excel!Excel.CustomFunctionManager#context:member
17+
package: excel!
18+
fullName: context
19+
summary: >-
20+
The request context associated with the object. This connects the add-in's
21+
process to the Office host application's process.
22+
remarks: ''
23+
24+
isPreview: true
25+
isDeprecated: false
26+
syntax:
27+
content: 'context: RequestContext;'
28+
return:
29+
type: <xref uid="excel!Excel.RequestContext:class" />
30+
methods:
31+
- name: load(propertyNames)
32+
uid: excel!Excel.CustomFunctionManager#load:member(1)
33+
package: excel!
34+
fullName: load(propertyNames)
35+
summary: >-
36+
Queues up a command to load the specified properties of the object. You
37+
must call `context.sync()` before reading the properties.
38+
remarks: >-
39+
\[ [API set: ExcelApi BETA (PREVIEW
40+
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
41+
\]
42+
43+
isPreview: true
44+
isDeprecated: false
45+
syntax:
46+
content: 'load(propertyNames?: string | string[]): Excel.CustomFunctionManager;'
47+
parameters:
48+
- id: propertyNames
49+
description: >-
50+
A comma-delimited string or an array of strings that specify the
51+
properties to load.
52+
type: string | string[]
53+
return:
54+
type: <xref uid="excel!Excel.CustomFunctionManager:class" />
55+
description: ''
56+
- name: load(propertyNamesAndPaths)
57+
uid: excel!Excel.CustomFunctionManager#load:member(2)
58+
package: excel!
59+
fullName: load(propertyNamesAndPaths)
60+
summary: >-
61+
Queues up a command to load the specified properties of the object. You
62+
must call `context.sync()` before reading the properties.
63+
remarks: >-
64+
\[ [API set: ExcelApi BETA (PREVIEW
65+
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
66+
\]
67+
68+
isPreview: true
69+
isDeprecated: false
70+
syntax:
71+
content: |-
72+
load(propertyNamesAndPaths?: {
73+
select?: string;
74+
expand?: string;
75+
}): Excel.CustomFunctionManager;
76+
parameters:
77+
- id: propertyNamesAndPaths
78+
description: >-
79+
`propertyNamesAndPaths.select` is a comma-delimited string that
80+
specifies the properties to load, and `propertyNamesAndPaths.expand`
81+
is a comma-delimited string that specifies the navigation properties
82+
to load.
83+
type: |-
84+
{
85+
select?: string;
86+
expand?: string;
87+
}
88+
return:
89+
type: <xref uid="excel!Excel.CustomFunctionManager:class" />
90+
description: ''
91+
- name: toJSON()
92+
uid: excel!Excel.CustomFunctionManager#toJSON:member(1)
93+
package: excel!
94+
fullName: toJSON()
95+
summary: >-
96+
Overrides the JavaScript `toJSON()` method in order to provide more useful
97+
output when an API object is passed to `JSON.stringify()`<!-- -->.
98+
(`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the
99+
object that's passed to it.) Whereas the original
100+
`Excel.CustomFunctionManager` object is an API object, the `toJSON` method
101+
returns a plain JavaScript object (typed as
102+
`Excel.Interfaces.CustomFunctionManagerData`<!-- -->) that contains
103+
shallow copies of any loaded child properties from the original object.
104+
remarks: >-
105+
\[ [API set: ExcelApi BETA (PREVIEW
106+
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
107+
\]
108+
109+
isPreview: true
110+
isDeprecated: false
111+
syntax:
112+
content: 'toJSON(): Excel.Interfaces.CustomFunctionManagerData;'
113+
return:
114+
type: >-
115+
<xref uid="excel!Excel.Interfaces.CustomFunctionManagerData:interface"
116+
/>
117+
description: ''
118+
extends: <xref uid="office!OfficeExtension.ClientObject:class" />

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

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
### YamlMime:TSType
2+
name: Excel.CustomFunctionVisibilityOptions
3+
uid: excel!Excel.CustomFunctionVisibilityOptions:interface
4+
package: excel!
5+
fullName: Excel.CustomFunctionVisibilityOptions
6+
summary: Represents which custom functions to show or hide in Excel AutoComplete.
7+
remarks: >-
8+
\[ [API set: ExcelApi BETA (PREVIEW
9+
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
10+
11+
isPreview: true
12+
isDeprecated: false
13+
type: interface
14+
properties:
15+
- name: hide
16+
uid: excel!Excel.CustomFunctionVisibilityOptions#hide:member
17+
package: excel!
18+
fullName: hide
19+
summary: A list of custom functions to hide from Excel AutoComplete.
20+
remarks: >-
21+
\[ [API set: ExcelApi BETA (PREVIEW
22+
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
23+
\]
24+
25+
isPreview: true
26+
isDeprecated: false
27+
syntax:
28+
content: 'hide?: string[];'
29+
return:
30+
type: string[]
31+
- name: show
32+
uid: excel!Excel.CustomFunctionVisibilityOptions#show:member
33+
package: excel!
34+
fullName: show
35+
summary: A list of custom functions to show in Excel AutoComplete.
36+
remarks: >-
37+
\[ [API set: ExcelApi BETA (PREVIEW
38+
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
39+
\]
40+
41+
isPreview: true
42+
isDeprecated: false
43+
syntax:
44+
content: 'show?: string[];'
45+
return:
46+
type: string[]

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,19 @@ fields:
9696
* \[ [API set: ExcelApi
9797
1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
9898
value: '"CommentDeleted"'
99+
- name: externalCodeServiceDiffResultReceived
100+
uid: excel!Excel.EventType.externalCodeServiceDiffResultReceived:member
101+
package: excel!
102+
summary: >-
103+
ExternalCodeServiceDiffResultReceived represents the type of event
104+
registered when the diff result is received from the external code
105+
service.
106+
107+
108+
* \[ [API set: ExcelApi BETA (PREVIEW
109+
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
110+
\]
111+
value: '"ExternalCodeServiceDiffResultReceived"'
99112
- name: linkedDataTypeLinkedDataTypeAdded
100113
uid: excel!Excel.EventType.linkedDataTypeLinkedDataTypeAdded:member
101114
package: excel!

‎docs/docs-ref-autogen/excel/excel/excel.interfaces.customfunctionmanagerdata.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### YamlMime:TSType
2+
name: Excel.Interfaces.CustomFunctionManagerData
3+
uid: excel!Excel.Interfaces.CustomFunctionManagerData:interface
4+
package: excel!
5+
fullName: Excel.Interfaces.CustomFunctionManagerData
6+
summary: >-
7+
An interface describing the data returned by calling
8+
`customFunctionManager.toJSON()`<!-- -->.
9+
remarks: ''
10+
11+
isPreview: false
12+
isDeprecated: false
13+
type: interface

‎docs/docs-ref-autogen/excel/excel/excel.interfaces.linkedentitydatadomaincollectionloadoptions.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ package: excel!
55
fullName: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions
66
summary: >-
77
Represents a collection of `LinkedEntityDataDomain` objects. The collection
8-
can contain linked entity data domains such as stocks, geography or currencies
9-
defined by service data providers, such as Bing or Power BI, or linked entity
10-
data domains defined by Office Add-ins.
8+
can contain linked entity data domains such as stocks, geography, or
9+
currencies defined by service data providers, such as Bing or Power BI, or
10+
linked entity data domains defined by Office Add-ins.
1111
remarks: >-
1212
\[ [API set: ExcelApi
1313
1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]

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

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2214,11 +2214,7 @@ methods:
22142214
uid: excel!Excel.Range#getImage:member(1)
22152215
package: excel!
22162216
fullName: getImage()
2217-
summary: >-
2218-
Renders the range as a Base64-encoded PNG image. *Important**: This API
2219-
is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js
2220-
Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the
2221-
current status.
2217+
summary: Renders the range as a Base64-encoded PNG image.
22222218
remarks: >-
22232219
\[ [API set: ExcelApi
22242220
1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
@@ -3019,18 +3015,19 @@ methods:
30193015
content: >-
30203016
getSpecialCells(cellTypeString: "ConditionalFormats" | "DataValidations"
30213017
| "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" |
3022-
"SameDataValidation" | "Visible", cellValueTypeString?: "All" | "Errors"
3023-
| "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" |
3024-
"ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" |
3025-
"Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" |
3026-
"Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
3018+
"SameDataValidation" | "Visible" | "DirtyFormulas",
3019+
cellValueTypeString?: "All" | "Errors" | "ErrorsLogical" |
3020+
"ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" |
3021+
"ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers"
3022+
| "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" |
3023+
"Text"): Excel.RangeAreas;
30273024
parameters:
30283025
- id: cellTypeString
30293026
description: The type of cells to include.
30303027
type: >-
30313028
"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" |
30323029
"Formulas" | "SameConditionalFormat" | "SameDataValidation" |
3033-
"Visible"
3030+
"Visible" | "DirtyFormulas"
30343031
- id: cellValueTypeString
30353032
description: >-
30363033
If `cellType` is either `constants` or `formulas`<!-- -->, this
@@ -3105,19 +3102,19 @@ methods:
31053102
content: >-
31063103
getSpecialCellsOrNullObject(cellTypeString: "ConditionalFormats" |
31073104
"DataValidations" | "Blanks" | "Constants" | "Formulas" |
3108-
"SameConditionalFormat" | "SameDataValidation" | "Visible",
3109-
cellValueTypeString?: "All" | "Errors" | "ErrorsLogical" |
3110-
"ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" |
3111-
"ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers"
3112-
| "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" |
3113-
"Text"): Excel.RangeAreas;
3105+
"SameConditionalFormat" | "SameDataValidation" | "Visible" |
3106+
"DirtyFormulas", cellValueTypeString?: "All" | "Errors" |
3107+
"ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber"
3108+
| "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" |
3109+
"LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" |
3110+
"NumbersText" | "Text"): Excel.RangeAreas;
31143111
parameters:
31153112
- id: cellTypeString
31163113
description: The type of cells to include.
31173114
type: >-
31183115
"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" |
31193116
"Formulas" | "SameConditionalFormat" | "SameDataValidation" |
3120-
"Visible"
3117+
"Visible" | "DirtyFormulas"
31213118
- id: cellValueTypeString
31223119
description: >-
31233120
If `cellType` is either `constants` or `formulas`<!-- -->, this

0 commit comments

Comments
 (0)