-
Notifications
You must be signed in to change notification settings - Fork 64
/
excel.interfaces.querydata.yml
89 lines (89 loc) · 3.47 KB
/
excel.interfaces.querydata.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
### YamlMime:TSType
name: Excel.Interfaces.QueryData
uid: 'excel!Excel.Interfaces.QueryData:interface'
package: excel!
fullName: Excel.Interfaces.QueryData
summary: An interface describing the data returned by calling `query.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: error
uid: 'excel!Excel.Interfaces.QueryData#error:member'
package: excel!
fullName: error
summary: 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?: Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" |
"FailedDownload" | "FailedToCompleteDownload";
return:
type: >-
<xref uid="excel!Excel.QueryError:enum" /> | "Unknown" | "None" | "FailedLoadToWorksheet" |
"FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload"
- name: loadedTo
uid: 'excel!Excel.Interfaces.QueryData#loadedTo:member'
package: excel!
fullName: loadedTo
summary: 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?: Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart";'
return:
type: '<xref uid="excel!Excel.LoadToType:enum" /> | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart"'
- name: loadedToDataModel
uid: 'excel!Excel.Interfaces.QueryData#loadedToDataModel:member'
package: excel!
fullName: loadedToDataModel
summary: 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.QueryData#name:member'
package: excel!
fullName: name
summary: 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?: string;'
return:
type: string
- name: refreshDate
uid: 'excel!Excel.Interfaces.QueryData#refreshDate:member'
package: excel!
fullName: refreshDate
summary: 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?: Date;'
return:
type: Date
- name: rowsLoadedCount
uid: 'excel!Excel.Interfaces.QueryData#rowsLoadedCount:member'
package: excel!
fullName: rowsLoadedCount
summary: >-
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?: number;'
return:
type: number