Excel.Query class

  • Referencia
Paquete:
excel

Representa una consulta Power Query.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

Propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
error

Obtiene el mensaje de error de consulta desde la última vez que se actualizó la consulta.
loadedTo

Obtiene la consulta cargada en el tipo de objeto.
loadedToDataModel

Especifica si la consulta se cargó en el modelo de datos.
name

Obtiene el nombre de la consulta. Los nombres de consulta no pueden contener puntos ni comillas.
refreshDate

Obtiene la fecha y hora en que se actualizó por última vez la consulta.
rowsLoadedCount

Obtiene el número de filas que se cargaron cuando se actualizó por última vez la consulta. Si la última actualización tiene errores, el valor será -1.

Métodos

delete()

Elimina la consulta y la conexión asociada. Las tablas asociadas a la consulta ya no se conectarán.
load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
refresh()

Actualiza la consulta. Esto solo inicia la actualización.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.Query original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.QueryData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

error

Obtiene el mensaje de error de consulta desde la última vez que se actualizó la consulta.

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

Valor de propiedad

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

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

loadedTo

Obtiene la consulta cargada en el tipo de objeto.

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

Valor de propiedad

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

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

loadedToDataModel

Especifica si la consulta se cargó en el modelo de datos.

readonly loadedToDataModel: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

name

Obtiene el nombre de la consulta. Los nombres de consulta no pueden contener puntos ni comillas.

readonly name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

Ejemplos

// 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

Obtiene la fecha y hora en que se actualizó por última vez la consulta.

readonly refreshDate: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

Ejemplos

// 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

Obtiene el número de filas que se cargaron cuando se actualizó por última vez la consulta. Si la última actualización tiene errores, el valor será -1.

readonly rowsLoadedCount: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

Ejemplos

// 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  "));
});

Detalles del método

delete()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Elimina la consulta y la conexión asociada. Las tablas asociadas a la consulta ya no se conectarán.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.QueryLoadOptions): Excel.Query;

Parámetros

options
Excel.Interfaces.QueryLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.Query

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.Query;

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.Query

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Query;

Parámetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.Query

refresh()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Actualiza la consulta. Esto solo inicia la actualización.

refresh(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.Query original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.QueryData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.QueryData;

Devoluciones

Excel.Interfaces.QueryData