Excel.Interfaces.LinkedEntityDataDomainLoadOptions interface
いくつかの共通の特性または属性を共有する情報の特定のカテゴリまたはフィールドを表します。 データ ドメインは、ブック内の LinkedEntityCellValue オブジェクトのデータ ソースとして機能するデータ プロバイダーにリンクされます。 データ ドメインは、株式、地理、通貨などのデータのカテゴリです。 データ プロバイダーは、Bing、Power BI、Office アドインなどのサービスです。
プロパティ
| $all | 読み込みオプションに |
| data |
リンクされたエンティティ データ ドメインのデータ プロバイダーの名前を取得します。 この名前は、データ プロバイダーから提供される情報に基づいて変更される場合があります。 |
| id | Office アドインによって定義されたリンクされたエンティティ データ ドメインの ID を取得します。この ID は、Bing や Power BI などのサービス データ プロバイダーによって定義されたリンクされたエンティティ データ ドメインには適用されません。 |
| last |
ブックが開かれ、このリンクされたエンティティ データ ドメインの |
| load |
Office アドインによって定義されたリンクされたエンティティ データ ドメインの |
| name | リンクされたエンティティ データ ドメインの名前を取得します。 この名前は、データ プロバイダーから提供される情報に基づいて変更される場合があります。 |
| periodic |
このリンクされたエンティティ データ ドメインの |
| refresh |
このリンクされたエンティティ データ ドメインの |
| service |
リンクされたエンティティ データ ドメインのサービス ID を取得します。 この ID は、リンクされたすべてのエンティティ データ ドメインに対して永続的に予約された値であり、Bing や Power BI などのサービス データ プロバイダーによって定義されるか、Office アドインによって定義されます。この ID は、ユーザー セッション間で変更されることはありません。 |
| supported |
リンクされたエンティティ データ ドメインでサポートされているすべての更新モードを取得します。 この配列は、データ プロバイダーによって提供される情報に基づいて変更される可能性があります。 |
プロパティの詳細
$all
読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。
$all?: boolean;プロパティ値
boolean
dataProvider
リンクされたエンティティ データ ドメインのデータ プロバイダーの名前を取得します。 この名前は、データ プロバイダーから提供される情報に基づいて変更される場合があります。
dataProvider?: boolean;プロパティ値
boolean
注釈
id
Office アドインによって定義されたリンクされたエンティティ データ ドメインの ID を取得します。この ID は、Bing や Power BI などのサービス データ プロバイダーによって定義されたリンクされたエンティティ データ ドメインには適用されません。
id?: boolean;プロパティ値
boolean
注釈
lastRefreshed
ブックが開かれ、このリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトが最後に更新されてからの日時 (ローカル タイム ゾーン内) を取得します。 ブックを開いてからLinkedEntityCellValueオブジェクトが更新されていない場合はundefinedを返します。
lastRefreshed?: boolean;プロパティ値
boolean
注釈
loadFunctionId
Office アドインによって定義されたリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトを解決または更新するためにオンデマンドで呼び出されるカスタム関数の ID を取得します。詳細については、「 カスタム関数の JSON メタデータを自動生成する: ID」を参照してください。 この ID は、Bing や Power BI などのサービス データ プロバイダーによって定義されたリンクされたエンティティ データ ドメインには適用されません。
loadFunctionId?: boolean;プロパティ値
boolean
注釈
name
リンクされたエンティティ データ ドメインの名前を取得します。 この名前は、データ プロバイダーから提供される情報に基づいて変更される場合があります。
name?: boolean;プロパティ値
boolean
注釈
periodicRefreshInterval
このリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトが自動的に更新される頻度を秒単位で取得します。 更新間隔は、 refreshMode が "定期" に設定されている場合にのみ適用されます。
periodicRefreshInterval?: boolean;プロパティ値
boolean
注釈
refreshMode
このリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトをいつどのように更新するかを定義する更新モードを指定します。 設定されている更新モードがこのリンクされたエンティティ データ ドメインでサポートされていない場合、現在の更新モードは変更されません。 更新モードが "定期" に設定されている場合、更新間隔は、このリンクされたエンティティ データ ドメインの periodicRefreshInterval に設定されます。
refreshMode?: boolean;プロパティ値
boolean
注釈
serviceId
リンクされたエンティティ データ ドメインのサービス ID を取得します。 この ID は、リンクされたすべてのエンティティ データ ドメインに対して永続的に予約された値であり、Bing や Power BI などのサービス データ プロバイダーによって定義されるか、Office アドインによって定義されます。この ID は、ユーザー セッション間で変更されることはありません。
serviceId?: boolean;プロパティ値
boolean
注釈
supportedRefreshModes
リンクされたエンティティ データ ドメインでサポートされているすべての更新モードを取得します。 この配列は、データ プロバイダーによって提供される情報に基づいて変更される可能性があります。
supportedRefreshModes?: boolean;プロパティ値
boolean