Excel.Interfaces.QueryData interface

Package:

excel

An interface describing the data returned by calling query.toJSON().

Properties

error	Gets the query error message from when the query was last refreshed.
loadedTo	Gets the query loaded to object type.
loadedToDataModel	Specifies if the query loaded to the data model.
name	Gets the name of the query. Query names cannot contain periods or quotation marks.
refreshDate	Gets the date and time when the query was last refreshed.
rowsLoadedCount	Gets the number of rows that were loaded when the query was last refreshed. If last refresh has errors the value will be -1.

Property Details

error

Gets the query error message from when the query was last refreshed.

error?: Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload";

Property Value

Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload"

Remarks

[ API set: ExcelApi 1.14 ]

loadedTo

Gets the query loaded to object type.

loadedTo?: Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart";

Property Value

Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart"

Remarks

[ API set: ExcelApi 1.14 ]

loadedToDataModel

Specifies if the query loaded to the data model.

loadedToDataModel?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.14 ]

name

Gets the name of the query. Query names cannot contain periods or quotation marks.

name?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.14 ]

refreshDate

Gets the date and time when the query was last refreshed.

refreshDate?: Date;

Property Value

Date

Remarks

[ API set: ExcelApi 1.14 ]

rowsLoadedCount

Gets the number of rows that were loaded when the query was last refreshed. If last refresh has errors the value will be -1.

rowsLoadedCount?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.14 ]