-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.interfaces.querycollectionloadoptions.yml
101 lines (101 loc) · 3.9 KB
/
excel.interfaces.querycollectionloadoptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
### YamlMime:TSType
name: Excel.Interfaces.QueryCollectionLoadOptions
uid: 'excel!Excel.Interfaces.QueryCollectionLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.QueryCollectionLoadOptions
summary: Represents the collection of queries in the workbook.
remarks: '\[ [API set: ExcelApi 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'excel!Excel.Interfaces.QueryCollectionLoadOptions#$all:member'
package: excel!
fullName: $all
summary: >-
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: error
uid: 'excel!Excel.Interfaces.QueryCollectionLoadOptions#error:member'
package: excel!
fullName: error
summary: 'For EACH ITEM in the collection: Gets the query error message from when the query was last refreshed.'
remarks: '\[ [API set: ExcelApi 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'error?: boolean;'
return:
type: boolean
- name: loadedTo
uid: 'excel!Excel.Interfaces.QueryCollectionLoadOptions#loadedTo:member'
package: excel!
fullName: loadedTo
summary: 'For EACH ITEM in the collection: Gets the query loaded to object type.'
remarks: '\[ [API set: ExcelApi 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'loadedTo?: boolean;'
return:
type: boolean
- name: loadedToDataModel
uid: 'excel!Excel.Interfaces.QueryCollectionLoadOptions#loadedToDataModel:member'
package: excel!
fullName: loadedToDataModel
summary: 'For EACH ITEM in the collection: Specifies if the query loaded to the data model.'
remarks: '\[ [API set: ExcelApi 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'loadedToDataModel?: boolean;'
return:
type: boolean
- name: name
uid: 'excel!Excel.Interfaces.QueryCollectionLoadOptions#name:member'
package: excel!
fullName: name
summary: >-
For EACH ITEM in the collection: Gets the name of the query. Query names cannot contain periods or quotation
marks.
remarks: '\[ [API set: ExcelApi 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'name?: boolean;'
return:
type: boolean
- name: refreshDate
uid: 'excel!Excel.Interfaces.QueryCollectionLoadOptions#refreshDate:member'
package: excel!
fullName: refreshDate
summary: 'For EACH ITEM in the collection: Gets the date and time when the query was last refreshed.'
remarks: '\[ [API set: ExcelApi 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'refreshDate?: boolean;'
return:
type: boolean
- name: rowsLoadedCount
uid: 'excel!Excel.Interfaces.QueryCollectionLoadOptions#rowsLoadedCount:member'
package: excel!
fullName: rowsLoadedCount
summary: >-
For EACH ITEM in the collection: Gets the number of rows that were loaded when the query was last refreshed. If
last refresh has errors the value will be -1.
remarks: '\[ [API set: ExcelApi 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'rowsLoadedCount?: boolean;'
return:
type: boolean