Excel.Interfaces.LinkedEntityDataDomainData interface

linkedEntityDataDomain.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。

プロパティ

dataProvider

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

id

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

lastRefreshed

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

loadFunctionId

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

name

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

periodicRefreshInterval

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

refreshMode

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

serviceId

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

supportedRefreshModes

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

プロパティの詳細

dataProvider

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

dataProvider?: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.19

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

id

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

id?: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.19

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

lastRefreshed

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

lastRefreshed?: Date;

プロパティ値

Date

注釈

API セット: ExcelApi 1.19

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

loadFunctionId

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

loadFunctionId?: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.19

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

name

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

name?: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.19

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

periodicRefreshInterval

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

periodicRefreshInterval?: number;

プロパティ値

number

注釈

API セット: ExcelApi 1.19

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

refreshMode

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

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

プロパティ値

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

注釈

API セット: ExcelApi 1.19

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

serviceId

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

serviceId?: number;

プロパティ値

number

注釈

API セット: ExcelApi 1.19

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

supportedRefreshModes

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

supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];

プロパティ値

注釈

API セット: ExcelApi 1.19

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