Excel.Query class

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Ruft die Abfragefehlermeldung ab dem Zeitpunkt ab, zu dem die Abfrage zuletzt aktualisiert wurde.

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

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.14

Ruft die Abfrage zum Objekttyp auf.

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

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.14

Gibt an, ob die Abfrage in das Datenmodell geladen wurde.

readonly loadedToDataModel: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.14

Ruft den Namen der Abfrage ab. Abfragenamen dürfen keine Punkte oder Anführungszeichen enthalten.

readonly name: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.14

Beispiele

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

Ruft das Datum und die Uhrzeit ab, zu dem die Abfrage zuletzt aktualisiert wurde.

readonly refreshDate: Date;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.14

Beispiele

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

Ruft die Anzahl der Zeilen ab, die beim letzten Aktualisieren der Abfrage geladen wurden. Wenn die letzte Aktualisierung Fehler aufweist, ist der Wert -1.

readonly rowsLoadedCount: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.14

Beispiele

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

Löscht die Abfrage und die zugehörige Verbindung. Mit der Abfrage verknüpfte Tabellen werden nicht mehr verbunden.

delete(): void;

Gibt zurück

Hinweise

API-Satz: ExcelApi BETA (NUR VORSCHAU)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.Query Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.QueryData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.QueryData;

Gibt zurück