Excel.Query class

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

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

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

Obtiene la consulta cargada en el tipo de objeto.

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

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

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

readonly loadedToDataModel: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

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

readonly name: string;

Valor de propiedad

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

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

readonly refreshDate: Date;

Valor de propiedad

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

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

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

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

Devoluciones

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

Devoluciones

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

Devoluciones

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 original Excel.Query 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