Freigeben über

Excel.LinkedEntityDataDomain class

  • Referenz
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 wie Bing, Power BI oder ein Office-Add-In.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.19 ]

Eigenschaften

context

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

Ruft den Namen des Datenanbieters für die Datendomäne der verknüpften Entität 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 Dienstanbietern wie Bing oder Power BI definiert werden.
lastRefreshed

Ruft das Datum und die Uhrzeit (in der lokalen Zeitzone) ab, seit die Arbeitsmappe geöffnet und die LinkedEntityCellValue Objekte dieser Datendomäne der verknüpften Entität zuletzt aktualisiert wurden. Gibt zurück undefined , wenn 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 Objekte der LinkedEntityCellValue durch Office-Add-Ins definierten Datendomäne der verknüpften Entität 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 Dienstanbietern wie Bing oder Power BI definiert werden.
name

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

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

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

Ruft die Dienst-ID der Datendomäne der verknüpften Entität ab. Diese ID ist ein dauerhaft reservierter Wert für alle Datendomänen verknüpfter Entitäten, die von Dienstanbietern wie Bing oder Power BI oder office-Add-Ins definiert werden. Diese ID ändert sich nie über Benutzersitzungen hinweg.
supportedRefreshModes

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

Methoden

delete()

Löscht dieses Objekt aus der LinkedEntityDataDomainCollection. Nachdem die Datendomäne der verknüpften Entität gelöscht wurde, können keine neuen LinkedEntityCellValue Objekte dieser Datendomäne für verknüpfte Entitäten erstellt werden, und vorhandene LinkedEntityCellValue Objekte können 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 Datendomäne für verknüpfte Entitäten. Die Aktualisierungsanforderung kann fehlschlagen, wenn der Datenanbieter ausgelastet ist oder vorübergehend nicht zugegriffen werden kann.
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.LinkedEntityDataDomain Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.LinkedEntityDataDomainData) 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

dataProvider

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

readonly dataProvider: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.19 ]

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 Dienstanbietern wie Bing oder Power BI definiert werden.

readonly id: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.19 ]

lastRefreshed

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

readonly lastRefreshed: Date;

Eigenschaftswert

Date

Hinweise

[ API-Satz: ExcelApi 1.19 ]

loadFunctionId

Ruft die ID der benutzerdefinierten Funktion ab, die bei Bedarf aufgerufen wird, um die Objekte der LinkedEntityCellValue durch Office-Add-Ins definierten Datendomäne der verknüpften Entität 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 Dienstanbietern wie Bing oder Power BI definiert werden.

readonly loadFunctionId: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.19 ]

name

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

readonly name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.19 ]

periodicRefreshInterval

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

readonly periodicRefreshInterval: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.19 ]

refreshMode

Gibt den Aktualisierungsmodus an, der definiert, wie und wann die LinkedEntityCellValue Objekte dieser verknüpften Entitäts-Datendomäne aktualisiert werden. Wenn der festgelegte Aktualisierungsmodus von dieser Datendomäne der verknüpften Entität nicht unterstützt wird, wird der aktuelle Aktualisierungsmodus nicht geändert. Wenn der Aktualisierungsmodus auf "Periodisch" festgelegt ist, wird das Aktualisierungsintervall auf die 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 ]

serviceId

Ruft die Dienst-ID der Datendomäne der verknüpften Entität ab. Diese ID ist ein dauerhaft reservierter Wert für alle Datendomänen verknüpfter Entitäten, die von Dienstanbietern wie Bing oder Power BI oder office-Add-Ins definiert werden. Diese ID ändert sich nie über Benutzersitzungen hinweg.

readonly serviceId: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.19 ]

supportedRefreshModes

Ruft alle Aktualisierungsmodi ab, die von der Datendomäne der verknüpften Entität 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 ]

Details zur Methode

delete()

Löscht dieses Objekt aus der LinkedEntityDataDomainCollection. Nachdem die Datendomäne der verknüpften Entität gelöscht wurde, können keine neuen LinkedEntityCellValue Objekte dieser Datendomäne für verknüpfte Entitäten erstellt werden, und vorhandene LinkedEntityCellValue Objekte können 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 ]

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 dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

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

refresh()

Aktualisiert alle LinkedEntityCellValue Objekte dieser Datendomäne für verknüpfte Entitäten. Die Aktualisierungsanforderung kann fehlschlagen, wenn der Datenanbieter ausgelastet ist oder vorübergehend nicht zugegriffen werden kann.

refresh(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.19 ]

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

toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;

Gibt zurück

Excel.Interfaces.LinkedEntityDataDomainData