Skip to content

Commit fa37bf2

Browse files
ElizabethSamuel-MSFTgithub-actions
andauthored
Automatically generated docs (#2258)
Co-authored-by: github-actions <[email protected]>
1 parent 0ebbc02 commit fa37bf2

File tree

63 files changed

+1218
-444
lines changed

Some content is hidden

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

63 files changed

+1218
-444
lines changed

docs/docs-ref-autogen/excel/custom-functions-runtime/customfunctions.invocation.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,21 @@ properties:
4141
content: 'functionName?: string;'
4242
return:
4343
type: string
44+
- name: isInValuePreview
45+
uid: 'custom-functions-runtime!CustomFunctions.Invocation#isInValuePreview:member'
46+
package: custom-functions-runtime!
47+
fullName: isInValuePreview
48+
summary: >-
49+
Indicates whether the function is invoked as part of the formula value preview. `isInValuePreview` is read-only
50+
and can't be set by a custom functions add-in. This value is `true` if the function is invoked to preview the
51+
formula value; otherwise it is `false`<!-- -->.
52+
remarks: '\[ [API set: CustomFunctionsRuntime 1.5](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) \]'
53+
isPreview: false
54+
isDeprecated: false
55+
syntax:
56+
content: 'isInValuePreview?: string;'
57+
return:
58+
type: string
4459
- name: parameterAddresses
4560
uid: 'custom-functions-runtime!CustomFunctions.Invocation#parameterAddresses:member'
4661
package: custom-functions-runtime!

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ enums:
143143
- 'excel!Excel.PrintMarginUnit:enum'
144144
- 'excel!Excel.PrintOrder:enum'
145145
- 'excel!Excel.ProtectionSelectionMode:enum'
146+
- 'excel!Excel.PythonMarshalMode:enum'
146147
- 'excel!Excel.QueryError:enum'
147148
- 'excel!Excel.RangeCopyType:enum'
148149
- 'excel!Excel.RangeUnderlineStyle:enum'

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Excel.BasicCardLayout
33
uid: 'excel!Excel.BasicCardLayout:interface'
44
package: excel!
55
fullName: Excel.BasicCardLayout
6-
summary: 'Represents a card layout used for the boolean, double, and string basic types.'
6+
summary: 'Represents a card layout used for the Boolean, double, and string basic types.'
77
remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
88
isPreview: true
99
isDeprecated: false

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ properties:
7575
uid: 'excel!Excel.ExternalCodeServiceObjectCellValue#Python_str:member'
7676
package: excel!
7777
fullName: Python_str
78-
summary: Represents the output of str() function when used on this object.
78+
summary: Represents the output of the `str()` function when used on this object.
7979
remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
8080
isPreview: true
8181
isDeprecated: false

docs/docs-ref-autogen/excel/excel/excel.interfaces.pivottablecollectionloadoptions.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,20 @@ properties:
3737
content: 'allowMultipleFiltersPerField?: boolean;'
3838
return:
3939
type: boolean
40+
- name: autoRefresh
41+
uid: 'excel!Excel.Interfaces.PivotTableCollectionLoadOptions#autoRefresh:member'
42+
package: excel!
43+
fullName: autoRefresh
44+
summary: >-
45+
For EACH ITEM in the collection: Specifies whether the PivotTable auto refreshes when the source data changes.
46+
Corresponds to "Auto Refresh" setting in the UI.
47+
remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
48+
isPreview: true
49+
isDeprecated: false
50+
syntax:
51+
content: 'autoRefresh?: boolean;'
52+
return:
53+
type: boolean
4054
- name: enableDataValueEditing
4155
uid: 'excel!Excel.Interfaces.PivotTableCollectionLoadOptions#enableDataValueEditing:member'
4256
package: excel!

docs/docs-ref-autogen/excel/excel/excel.interfaces.pivottabledata.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,20 @@ properties:
2121
content: 'allowMultipleFiltersPerField?: boolean;'
2222
return:
2323
type: boolean
24+
- name: autoRefresh
25+
uid: 'excel!Excel.Interfaces.PivotTableData#autoRefresh:member'
26+
package: excel!
27+
fullName: autoRefresh
28+
summary: >-
29+
Specifies whether the PivotTable auto refreshes when the source data changes. Corresponds to "Auto Refresh"
30+
setting in the UI.
31+
remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
32+
isPreview: true
33+
isDeprecated: false
34+
syntax:
35+
content: 'autoRefresh?: boolean;'
36+
return:
37+
type: boolean
2438
- name: columnHierarchies
2539
uid: 'excel!Excel.Interfaces.PivotTableData#columnHierarchies:member'
2640
package: excel!

docs/docs-ref-autogen/excel/excel/excel.interfaces.pivottableloadoptions.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,20 @@ properties:
3737
content: 'allowMultipleFiltersPerField?: boolean;'
3838
return:
3939
type: boolean
40+
- name: autoRefresh
41+
uid: 'excel!Excel.Interfaces.PivotTableLoadOptions#autoRefresh:member'
42+
package: excel!
43+
fullName: autoRefresh
44+
summary: >-
45+
Specifies whether the PivotTable auto refreshes when the source data changes. Corresponds to "Auto Refresh"
46+
setting in the UI.
47+
remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
48+
isPreview: true
49+
isDeprecated: false
50+
syntax:
51+
content: 'autoRefresh?: boolean;'
52+
return:
53+
type: boolean
4054
- name: enableDataValueEditing
4155
uid: 'excel!Excel.Interfaces.PivotTableLoadOptions#enableDataValueEditing:member'
4256
package: excel!

docs/docs-ref-autogen/excel/excel/excel.interfaces.pivottablescopedcollectionloadoptions.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,20 @@ properties:
3939
content: 'allowMultipleFiltersPerField?: boolean;'
4040
return:
4141
type: boolean
42+
- name: autoRefresh
43+
uid: 'excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions#autoRefresh:member'
44+
package: excel!
45+
fullName: autoRefresh
46+
summary: >-
47+
For EACH ITEM in the collection: Specifies whether the PivotTable auto refreshes when the source data changes.
48+
Corresponds to "Auto Refresh" setting in the UI.
49+
remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
50+
isPreview: true
51+
isDeprecated: false
52+
syntax:
53+
content: 'autoRefresh?: boolean;'
54+
return:
55+
type: boolean
4256
- name: enableDataValueEditing
4357
uid: 'excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions#enableDataValueEditing:member'
4458
package: excel!

docs/docs-ref-autogen/excel/excel/excel.interfaces.pivottableupdatedata.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,20 @@ properties:
2121
content: 'allowMultipleFiltersPerField?: boolean;'
2222
return:
2323
type: boolean
24+
- name: autoRefresh
25+
uid: 'excel!Excel.Interfaces.PivotTableUpdateData#autoRefresh:member'
26+
package: excel!
27+
fullName: autoRefresh
28+
summary: >-
29+
Specifies whether the PivotTable auto refreshes when the source data changes. Corresponds to "Auto Refresh"
30+
setting in the UI.
31+
remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
32+
isPreview: true
33+
isDeprecated: false
34+
syntax:
35+
content: 'autoRefresh?: boolean;'
36+
return:
37+
type: boolean
2438
- name: enableDataValueEditing
2539
uid: 'excel!Excel.Interfaces.PivotTableUpdateData#enableDataValueEditing:member'
2640
package: excel!

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,20 @@ properties:
2323
content: 'allowMultipleFiltersPerField: boolean;'
2424
return:
2525
type: boolean
26+
- name: autoRefresh
27+
uid: 'excel!Excel.PivotTable#autoRefresh:member'
28+
package: excel!
29+
fullName: autoRefresh
30+
summary: >-
31+
Specifies whether the PivotTable auto refreshes when the source data changes. Corresponds to "Auto Refresh"
32+
setting in the UI.
33+
remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
34+
isPreview: true
35+
isDeprecated: false
36+
syntax:
37+
content: 'autoRefresh: boolean;'
38+
return:
39+
type: boolean
2640
- name: columnHierarchies
2741
uid: 'excel!Excel.PivotTable#columnHierarchies:member'
2842
package: excel!

0 commit comments

Comments
 (0)