Excel.Query class

  • Referenz
Paket:
excel

Stellt eine Power Query Abfrage dar.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.14 ]

Eigenschaften

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
error

Ruft die Abfragefehlermeldung ab dem Zeitpunkt der letzten Aktualisierung der Abfrage ab.
loadedTo

Ruft die Abfrage ab, die in den Objekttyp geladen wurde.
loadedToDataModel

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

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

Ruft das Datum und die Uhrzeit der letzten Aktualisierung der Abfrage ab.
rowsLoadedCount

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

Methoden

delete()

Löscht die Abfrage und die zugeordnete Verbindung. Tabellen, die der Abfrage zugeordnet sind, werden nicht mehr verbunden.
load(options)

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)

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)

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.
refresh()

Aktualisiert die Abfrage. Dadurch wird nur die Aktualisierung gestartet.
toJSON()

Ü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 das Objekt übergeben wird.) Während das ursprüngliche Excel.Query-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.QueryData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

context

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

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

error

Ruft die Abfragefehlermeldung ab dem Zeitpunkt der letzten Aktualisierung der Abfrage ab.

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

Eigenschaftswert

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

Hinweise

[ API-Satz: ExcelApi 1.14 ]

loadedTo

Ruft die Abfrage ab, die in den Objekttyp geladen wurde.

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

Eigenschaftswert

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

Hinweise

[ API-Satz: ExcelApi 1.14 ]

loadedToDataModel

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

readonly loadedToDataModel: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.14 ]

name

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

readonly name: string;

Eigenschaftswert

string

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

refreshDate

Ruft das Datum und die Uhrzeit der letzten Aktualisierung der Abfrage ab.

readonly refreshDate: Date;

Eigenschaftswert

Date

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

rowsLoadedCount

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

readonly rowsLoadedCount: number;

Eigenschaftswert

number

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

Details zur Methode

delete()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Löscht die Abfrage und die zugeordnete Verbindung. Tabellen, die der Abfrage zugeordnet sind, werden nicht mehr verbunden.

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

load(options)

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

options
Excel.Interfaces.QueryLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.Query

load(propertyNames)

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

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Excel.Query

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

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

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.Query

refresh()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Aktualisiert die Abfrage. Dadurch wird nur die Aktualisierung gestartet.

refresh(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

toJSON()

Ü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 das Objekt übergeben wird.) Während das ursprüngliche Excel.Query-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.QueryData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.QueryData;

Gibt zurück

Excel.Interfaces.QueryData