Compartilhar via

Excel.Query class

  • Referência
Pacote:
excel

Representa uma consulta Power Query.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

Propriedades

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
error

Obtém a mensagem de erro de consulta de quando a consulta foi atualizada pela última vez.
loadedTo

Obtém a consulta carregada no tipo de objeto.
loadedToDataModel

Especifica se a consulta foi carregada no modelo de dados.
name

Obtém o nome da consulta. Os nomes de consulta não podem conter períodos ou aspas.
refreshDate

Obtém a data e a hora em que a consulta foi atualizada pela última vez.
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.

Métodos

delete()

Exclui a consulta e a conexão associada. As tabelas associadas à consulta não serão mais conectadas.
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(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
refresh()

Atualiza a consulta. Isso só inicia a atualização.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.Query original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.QueryData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

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

[ Conjunto de API: ExcelApi 1.14 ]

loadedTo

Obtém a consulta carregada no tipo de objeto.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

loadedToDataModel

Especifica se a consulta foi carregada no modelo de dados.

readonly loadedToDataModel: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

name

Obtém o nome da consulta. Os nomes de consulta não podem conter períodos 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 a 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

delete()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Exclui a consulta e a conexão associada. As tabelas associadas à consulta não serão mais conectadas.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

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

options
Excel.Interfaces.QueryLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.Query

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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.Query

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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.Query

refresh()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Atualiza a consulta. Isso só inicia a atualização.

refresh(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.Query original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.QueryData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.QueryData;

Retornos

Excel.Interfaces.QueryData