Excel.LinkedEntityDataDomain class

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

リンクされたエンティティ データ ドメインのデータ プロバイダーの名前を取得します。 この名前は、データ プロバイダーから提供される情報に基づいて変更される場合があります。

readonly dataProvider: string;

プロパティ値

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

Office アドインによって定義されたリンクされたエンティティ データ ドメインの ID を取得します。この ID は、Bing や Power BI などのサービス データ プロバイダーによって定義されたリンクされたエンティティ データ ドメインには適用されません。

readonly id: string;

プロパティ値

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

ブックが開かれ、このリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトが最後に更新されてからの日時 (ローカル タイム ゾーン内) を取得します。 ブックを開いてからLinkedEntityCellValueオブジェクトが更新されていない場合はundefinedを返します。

readonly lastRefreshed: Date;

プロパティ値

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

Office アドインによって定義されたリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトを解決または更新するためにオンデマンドで呼び出されるカスタム関数の ID を取得します。詳細については、「 カスタム関数の JSON メタデータを自動生成する: ID」を参照してください。 この ID は、Bing や Power BI などのサービス データ プロバイダーによって定義されたリンクされたエンティティ データ ドメインには適用されません。

readonly loadFunctionId: string;

プロパティ値

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

リンクされたエンティティ データ ドメインの名前を取得します。 この名前は、データ プロバイダーから提供される情報に基づいて変更される場合があります。

readonly name: string;

プロパティ値

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

このリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトが自動的に更新される頻度を秒単位で取得します。 更新間隔は、 refreshMode が "定期" に設定されている場合にのみ適用されます。

readonly periodicRefreshInterval: number;

プロパティ値

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

このリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトをいつどのように更新するかを定義する更新モードを指定します。 設定されている更新モードがこのリンクされたエンティティ データ ドメインでサポートされていない場合、現在の更新モードは変更されません。 更新モードが "定期" に設定されている場合、更新間隔は、このリンクされたエンティティ データ ドメインの periodicRefreshInterval に設定されます。

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

プロパティ値

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

リンクされたエンティティ データ ドメインのサービス ID を取得します。 この ID は、リンクされたすべてのエンティティ データ ドメインに対して永続的に予約された値であり、Bing や Power BI などのサービス データ プロバイダーによって定義されるか、Office アドインによって定義されます。この ID は、ユーザー セッション間で変更されることはありません。

readonly serviceId: number;

プロパティ値

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

リンクされたエンティティ データ ドメインでサポートされているすべての更新モードを取得します。 この配列は、データ プロバイダーによって提供される情報に基づいて変更される可能性があります。

readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];

プロパティ値

注釈

API セット: ExcelApi 1.19

このプロパティは Excel on the web ではサポートされていません。

このオブジェクトを LinkedEntityDataDomainCollectionから削除します。 リンクされたエンティティ データ ドメインが削除されると、このリンクされたエンティティ データ ドメインの新しい LinkedEntityCellValue オブジェクトを作成したり、既存の LinkedEntityCellValue オブジェクトを更新したりできなくなります。 Office アドインは、作成したリンクされたエンティティ データ ドメインのみを削除できます。

delete(): void;

返品

注釈

API セット: ExcelApi 1.19

この方法は、Excel on the web ではサポートされていません。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.LinkedEntityDataDomainLoadOptions): Excel.LinkedEntityDataDomain;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

このリンクされたエンティティ データ ドメインのすべての LinkedEntityCellValue オブジェクトを更新します。 データ プロバイダーがビジー状態であるか、一時的にアクセスできない場合、更新要求は失敗する可能性があります。

refresh(): void;

返品

注釈

API セット: ExcelApi 1.19

この方法は、Excel on the web ではサポートされていません。

例

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

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.LinkedEntityDataDomain オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.LinkedEntityDataDomainData と型指定) を返します。

toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;

返品