Excel.Query class
Representa uma consulta Power Query.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.14 ]
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| error | Obtém a mensagem de erro de consulta de quando a consulta foi atualizada pela última vez. |
| loaded |
Obtém a consulta carregada para o tipo de objeto. |
| loaded |
Especifica se a consulta foi carregada para o modelo de dados. |
| name | Obtém o nome da consulta. Os nomes das consultas não podem conter pontos finais ou aspas. |
| refresh |
Obtém a data e hora em que a consulta foi atualizada pela última vez. |
| rows |
Obtém o número de linhas que foram carregadas quando a consulta foi atualizada pela última vez. Se a última atualização tiver erros, o valor será -1. |
Métodos
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
error
Obtém a mensagem de erro de consulta de quando a consulta foi atualizada pela última vez.
readonly error: Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload";Valor da propriedade
Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload"
Comentários
loadedTo
Obtém a consulta carregada para o tipo de objeto.
readonly loadedTo: Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart";Valor da propriedade
Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart"
Comentários
loadedToDataModel
Especifica se a consulta foi carregada para o modelo de dados.
readonly loadedToDataModel: boolean;Valor da propriedade
boolean
Comentários
name
Obtém o nome da consulta. Os nomes das consultas não podem conter pontos finais ou aspas.
readonly name: string;Valor da propriedade
string
Comentários
[ Conjunto de API: ExcelApi 1.14 ]
Exemplos
// This function retrieves the query collection in a workbook,
// loads the query items in that collection, and then
// logs the name of each query to the console.
await Excel.run(async (context) => {
const queries = context.workbook.queries;
queries.load("items");
await context.sync();
console.log("Name of each query: ")
console.log(" " + queries.items.map((query) => query.name).join("\n "));
});
refreshDate
Obtém a data e hora em que a consulta foi atualizada pela última vez.
readonly refreshDate: Date;Valor da propriedade
Date
Comentários
[ Conjunto de API: ExcelApi 1.14 ]
Exemplos
// This function retrieves the query collection in a workbook,
// loads the query items in that collection, and then
// logs the last refresh date of each query to the console.
await Excel.run(async (context) => {
const queries = context.workbook.queries;
queries.load("items");
await context.sync();
console.log("Last refresh date of each query: ")
console.log(" " + queries.items.map((query) => query.refreshDate).join("\n "));
});
rowsLoadedCount
Obtém o número de linhas que foram carregadas quando a consulta foi atualizada pela última vez. Se a última atualização tiver erros, o valor será -1.
readonly rowsLoadedCount: number;Valor da propriedade
number
Comentários
[ Conjunto de API: ExcelApi 1.14 ]
Exemplos
// This function retrieves the query collection in a workbook,
// loads the query items in that collection, and then
// logs the number of rows loaded in each query.
await Excel.run(async (context) => {
const queries = context.workbook.queries;
queries.load("items");
await context.sync();
console.log("Rows loaded from each query: ")
console.log(" " + queries.items.map((query) => query.rowsLoadedCount).join("\n "));
});
Detalhes do método
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Excel.Interfaces.QueryLoadOptions): Excel.Query;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Excel.Query;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Query;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.Query é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.QueryData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.QueryData;