Excel.LinkedEntityDataDomain class

Paket:: excel

Stellt eine bestimmte Kategorie oder ein bestimmtes Feld von Informationen dar, die einige gemeinsame Merkmale oder Attribute aufweisen. Eine Datendomäne ist mit einem Datenanbieter verknüpft, der als Datenquelle für LinkedEntityCellValue Objekte in der Arbeitsmappe fungiert. Eine Datendomäne ist eine Kategorie von Daten, z. B. Aktien, Geografie oder Währungen. Ein Datenanbieter ist ein Dienst, z. B. Bing, Power BI oder ein Office-Add-In.

Extends: OfficeExtension.ClientObject

Hinweise

API-Satz: ExcelApi 1.19

Diese Klasse wird in Excel im Web nicht unterstützt.

Verwendet von

Excel.LinkedEntityDataDomainCollection: getItem, getItemAt, getItemByName, getItemByNameOrNullObject, getItemOrNullObject, Elemente

Beispiele

// Refreshes all linked entity cell values for a specific data domain.
await Excel.run(async (context) => {
    const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;

    // Get a specific data domain by ID and refresh it.
    const productsDomain: Excel.LinkedEntityDataDomain = dataDomains.getItem("products");
    productsDomain.refresh();
    await context.sync();
});

Eigenschaften

context	Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
dataProvider	Ruft den Namen des Datenanbieters für die verknüpfte Entitätsdatendomäne ab. Dieser Name kann sich basierend auf den vom Datenanbieter bereitgestellten Informationen ändern.
id	Ruft die ID der verknüpften Entitätsdatendomäne ab, die von Office-Add-Ins definiert wird. Diese ID gilt nicht für Datendomänen verknüpfter Entitäten, die von Dienstdatenanbietern wie Bing oder Power BI definiert wurden.
lastRefreshed	Ruft das Datum und die Uhrzeit (in der lokalen Zeitzone) ab, seit die Arbeitsmappe geöffnet wurde und die `LinkedEntityCellValue` Objekte dieser verknüpften Entitätsdatendomäne zuletzt aktualisiert wurden. Gibt zurück `undefined` , ob `LinkedEntityCellValue` Objekte seit dem Öffnen der Arbeitsmappe nicht aktualisiert wurden.
loadFunctionId	Ruft die ID der benutzerdefinierten Funktion ab, die bei Bedarf aufgerufen wird, um die `LinkedEntityCellValue` Objekte der von Office-Add-Ins definierten verknüpften Entitätsdatendomäne aufzulösen oder zu aktualisieren. Weitere Informationen finden Sie unter Automatisches Generieren von JSON-Metadaten für benutzerdefinierte Funktionen: ID. Diese ID gilt nicht für Datendomänen verknüpfter Entitäten, die von Dienstdatenanbietern wie Bing oder Power BI definiert wurden.
name	Ruft den Namen der verknüpften Entitätsdatendomäne ab. Dieser Name kann sich basierend auf den vom Datenanbieter bereitgestellten Informationen ändern.
periodicRefreshInterval	Ruft die Häufigkeit in Sekunden ab, mit der `LinkedEntityCellValue` Objekte dieser verknüpften Entitätsdatendomäne automatisch aktualisiert werden. Das Aktualisierungsintervall gilt nur, wenn der `refreshMode` auf "Periodisch" festgelegt ist.
refreshMode	Gibt den Aktualisierungsmodus an, der definiert, wie und wann die `LinkedEntityCellValue` Objekte dieser verknüpften Entitätsdatendomäne aktualisiert werden. Wenn der festgelegte Aktualisierungsmodus von dieser verknüpften Entitätsdatendomäne nicht unterstützt wird, wird der aktuelle Aktualisierungsmodus nicht geändert. Wenn der Aktualisierungsmodus auf "Periodisch" eingestellt ist, wird das Aktualisierungsintervall auf das `periodicRefreshInterval` dieser verknüpften Entitätsdatendomäne festgelegt.
serviceId	Ruft die Dienst-ID der verknüpften Entitätsdatendomäne ab. Diese ID ist ein dauerhaft reservierter Wert für alle verknüpften Entitätsdatendomänen, die von Dienstdatenanbietern wie Bing oder Power BI oder von Office-Add-Ins definiert werden. Diese ID ändert sich nie zwischen Benutzersitzungen.
supportedRefreshModes	Ruft alle Aktualisierungsmodi ab, die von der verknüpften Entitätsdatendomäne unterstützt werden. Dieses Array kann sich basierend auf den vom Datenanbieter bereitgestellten Informationen ändern.

Methoden

delete()	Löscht dieses Objekt aus dem `LinkedEntityDataDomainCollection`. Nachdem die verknüpfte Entitätsdatendomäne gelöscht wurde, können keine neuen `LinkedEntityCellValue` Objekte dieser verknüpften Entitätsdatendomäne mehr erstellt und vorhandene `LinkedEntityCellValue` Objekte nicht aktualisiert werden. Ein Office-Add-In kann nur verknüpfte Entitätsdatendomänen löschen, die es erstellt hat.
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 alle `LinkedEntityCellValue` Objekte dieser verknüpften Entitätsdatendomäne. Die Aktualisierungsanforderung kann fehlschlagen, wenn der Datenanbieter ausgelastet oder vorübergehend nicht erreichbar ist.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche `Excel.LinkedEntityDataDomain` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (als `Excel.Interfaces.LinkedEntityDataDomainData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

Details zur Eigenschaft

context

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

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

dataProvider

Ruft den Namen des Datenanbieters für die verknüpfte Entitätsdatendomäne ab. Dieser Name kann sich basierend auf den vom Datenanbieter bereitgestellten Informationen ändern.

readonly dataProvider: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

id

Ruft die ID der verknüpften Entitätsdatendomäne ab, die von Office-Add-Ins definiert wird. Diese ID gilt nicht für Datendomänen verknüpfter Entitäten, die von Dienstdatenanbietern wie Bing oder Power BI definiert wurden.

readonly id: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

lastRefreshed

Ruft das Datum und die Uhrzeit (in der lokalen Zeitzone) ab, seit die Arbeitsmappe geöffnet wurde und die LinkedEntityCellValue Objekte dieser verknüpften Entitätsdatendomäne zuletzt aktualisiert wurden. Gibt zurück undefined , ob LinkedEntityCellValue Objekte seit dem Öffnen der Arbeitsmappe nicht aktualisiert wurden.

readonly lastRefreshed: Date;

Eigenschaftswert

Date

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

loadFunctionId

Ruft die ID der benutzerdefinierten Funktion ab, die bei Bedarf aufgerufen wird, um die LinkedEntityCellValue Objekte der von Office-Add-Ins definierten verknüpften Entitätsdatendomäne aufzulösen oder zu aktualisieren. Weitere Informationen finden Sie unter Automatisches Generieren von JSON-Metadaten für benutzerdefinierte Funktionen: ID. Diese ID gilt nicht für Datendomänen verknüpfter Entitäten, die von Dienstdatenanbietern wie Bing oder Power BI definiert wurden.

readonly loadFunctionId: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

name

Ruft den Namen der verknüpften Entitätsdatendomäne ab. Dieser Name kann sich basierend auf den vom Datenanbieter bereitgestellten Informationen ändern.

readonly name: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

periodicRefreshInterval

Ruft die Häufigkeit in Sekunden ab, mit der LinkedEntityCellValue Objekte dieser verknüpften Entitätsdatendomäne automatisch aktualisiert werden. Das Aktualisierungsintervall gilt nur, wenn der refreshMode auf "Periodisch" festgelegt ist.

readonly periodicRefreshInterval: number;

Eigenschaftswert

number

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

refreshMode

Gibt den Aktualisierungsmodus an, der definiert, wie und wann die LinkedEntityCellValue Objekte dieser verknüpften Entitätsdatendomäne aktualisiert werden. Wenn der festgelegte Aktualisierungsmodus von dieser verknüpften Entitätsdatendomäne nicht unterstützt wird, wird der aktuelle Aktualisierungsmodus nicht geändert. Wenn der Aktualisierungsmodus auf "Periodisch" eingestellt ist, wird das Aktualisierungsintervall auf das periodicRefreshInterval dieser verknüpften Entitätsdatendomäne festgelegt.

refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";

Eigenschaftswert

Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

serviceId

Ruft die Dienst-ID der verknüpften Entitätsdatendomäne ab. Diese ID ist ein dauerhaft reservierter Wert für alle verknüpften Entitätsdatendomänen, die von Dienstdatenanbietern wie Bing oder Power BI oder von Office-Add-Ins definiert werden. Diese ID ändert sich nie zwischen Benutzersitzungen.

readonly serviceId: number;

Eigenschaftswert

number

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

supportedRefreshModes

Ruft alle Aktualisierungsmodi ab, die von der verknüpften Entitätsdatendomäne unterstützt werden. Dieses Array kann sich basierend auf den vom Datenanbieter bereitgestellten Informationen ändern.

readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];

Eigenschaftswert

Excel.LinkedEntityDataDomainRefreshMode[]

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

Details zur Methode

delete()

Löscht dieses Objekt aus dem LinkedEntityDataDomainCollection. Nachdem die verknüpfte Entitätsdatendomäne gelöscht wurde, können keine neuen LinkedEntityCellValue Objekte dieser verknüpften Entitätsdatendomäne mehr erstellt und vorhandene LinkedEntityCellValue Objekte nicht aktualisiert werden. Ein Office-Add-In kann nur verknüpfte Entitätsdatendomänen löschen, die es erstellt hat.

delete(): void;

Gibt zurück

void

Hinweise

API-Satz: ExcelApi 1.19

Diese Methode wird in Excel im Web nicht unterstützt.

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.LinkedEntityDataDomainLoadOptions): Excel.LinkedEntityDataDomain;

Parameter

options: Excel.Interfaces.LinkedEntityDataDomainLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

Excel.LinkedEntityDataDomain

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.LinkedEntityDataDomain;

Parameter

propertyNames: string | string[]

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

Gibt zurück

Excel.LinkedEntityDataDomain

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.LinkedEntityDataDomain;

Parameter

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

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

Gibt zurück

Excel.LinkedEntityDataDomain

refresh()

Aktualisiert alle LinkedEntityCellValue Objekte dieser verknüpften Entitätsdatendomäne. Die Aktualisierungsanforderung kann fehlschlagen, wenn der Datenanbieter ausgelastet oder vorübergehend nicht erreichbar ist.

refresh(): void;

Gibt zurück

void

Hinweise

API-Satz: ExcelApi 1.19

Diese Methode wird in Excel im Web nicht unterstützt.

Beispiele

// Refreshes all linked entity cell values for a specific data domain.
await Excel.run(async (context) => {
    const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;

    // Get a specific data domain by ID and refresh it.
    const productsDomain: Excel.LinkedEntityDataDomain = dataDomains.getItem("products");
    productsDomain.refresh();
    await context.sync();
});

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

toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;

Gibt zurück

Excel.Interfaces.LinkedEntityDataDomainData

Feedback

War diese Seite hilfreich?