次の方法で共有

Excel.LinkedEntityDataDomain class

パッケージ:
excel

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

Extends
OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.19 ]

プロパティ

context

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

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

メソッド

delete()

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

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

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

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

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

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

dataProvider

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

readonly dataProvider: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.19 ]

id

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

readonly id: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.19 ]

lastRefreshed

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

readonly lastRefreshed: Date;

プロパティ値

Date

注釈

[ API セット: ExcelApi 1.19 ]

loadFunctionId

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

readonly loadFunctionId: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.19 ]

name

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

readonly name: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.19 ]

periodicRefreshInterval

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

readonly periodicRefreshInterval: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.19 ]

refreshMode

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

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

プロパティ値

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

注釈

[ API セット: ExcelApi 1.19 ]

serviceId

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

readonly serviceId: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.19 ]

supportedRefreshModes

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

readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];

プロパティ値

Excel.LinkedEntityDataDomainRefreshMode[]

注釈

[ API セット: ExcelApi 1.19 ]

メソッドの詳細

delete()

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

delete(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.19 ]

load(options)

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

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

パラメーター

options
Excel.Interfaces.LinkedEntityDataDomainLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.LinkedEntityDataDomain

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.LinkedEntityDataDomain

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.LinkedEntityDataDomain

refresh()

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

refresh(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.19 ]

toJSON()

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

toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;

戻り値

Excel.Interfaces.LinkedEntityDataDomainData