次の方法で共有


Excel.Interfaces.LinkedEntityDataDomainLoadOptions interface

一般的な特性または属性を共有する特定のカテゴリまたは情報フィールドを表します。 データ ドメインは、ブック内の LinkedEntityCellValue オブジェクトのデータ ソースとして機能するデータ プロバイダーにリンクされています。 データ ドメインは、株式、地域、通貨などのデータのカテゴリです。 データ プロバイダーは、Bing、Power BI、Office アドインなどのサービスです。

注釈

[ API セット: ExcelApi 1.19 ]

プロパティ

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

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 が "Periodic" に設定されている場合にのみ適用されます。

refreshMode

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

serviceId

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

supportedRefreshModes

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

プロパティの詳細

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

dataProvider

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

dataProvider?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.19 ]

id

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

id?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.19 ]

lastRefreshed

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

lastRefreshed?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.19 ]

loadFunctionId

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

loadFunctionId?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.19 ]

name

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

name?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.19 ]

periodicRefreshInterval

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

periodicRefreshInterval?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.19 ]

refreshMode

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

refreshMode?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.19 ]

serviceId

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

serviceId?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.19 ]

supportedRefreshModes

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

supportedRefreshModes?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.19 ]