次の方法で共有


Excel.LinkedEntityDataDomainCreateOptions interface

LinkedEntityDataDomainCollection に追加するLinkedEntityDataDomain オブジェクトの作成に使用するオプションを表します。

注釈

[ API セット: ExcelApi 1.19 ]

プロパティ

dataProvider

リンクされたエンティティ データ ドメインのデータ プロバイダーの名前を指定します。

id

リンクされたエンティティ データ ドメインの ID を指定します。 この ID は、この Office アドインによって定義されているすべてのリンクされたエンティティ データ ドメインで一意である必要があります。

loadFunctionId

このリンク エンティティ データ ドメインの LinkedEntityCellValue オブジェクトを解決または更新するために、オンデマンドで呼び出されるカスタム関数の ID を指定します。 詳細については、「 カスタム関数の自動生成 JSON メタデータ: ID」を参照してください。

name

リンクされたエンティティ データ ドメインの名前を指定します。 この名前は、この Office アドインによって定義されているすべてのリンクされたエンティティ データ ドメインで一意である必要があります。

periodicRefreshInterval

このリンクされたエンティティ データ ドメインのオブジェクト LinkedEntityCellValue 自動的に更新される頻度を秒単位で指定します。 有効な最小値は 300 です。 このプロパティは、 supportedRefreshModes 配列に値 "Periodic" が含まれている場合に必要です。 このプロパティは、リンクされたエンティティ データ ドメインの refreshMode が "Periodic" に設定されている場合にのみ適用されます。

supportedRefreshModes

リンクされたエンティティ データ ドメインでサポートされているすべての更新モードを指定します。 既定値は ["Manual"]であり、指定されていない場合でも常にサポートされます。 ブックに保存された更新モードは、次に開くブックのリンクされたエンティティ データ ドメインの既定の更新モードとして読み込まれます。 更新モードがブックに保存されていない場合、配列の最初の値は、リンクされたエンティティ データ ドメインの既定の更新モードとして設定されます。 配列の値が "Periodic" の場合は、リンクされたエンティティ データ ドメインに対して periodicRefreshInterval プロパティも設定する必要があります。

プロパティの詳細

dataProvider

リンクされたエンティティ データ ドメインのデータ プロバイダーの名前を指定します。

dataProvider: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.19 ]

id

リンクされたエンティティ データ ドメインの ID を指定します。 この ID は、この Office アドインによって定義されているすべてのリンクされたエンティティ データ ドメインで一意である必要があります。

id: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.19 ]

loadFunctionId

このリンク エンティティ データ ドメインの LinkedEntityCellValue オブジェクトを解決または更新するために、オンデマンドで呼び出されるカスタム関数の ID を指定します。 詳細については、「 カスタム関数の自動生成 JSON メタデータ: ID」を参照してください。

loadFunctionId: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.19 ]

name

リンクされたエンティティ データ ドメインの名前を指定します。 この名前は、この Office アドインによって定義されているすべてのリンクされたエンティティ データ ドメインで一意である必要があります。

name: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.19 ]

periodicRefreshInterval

このリンクされたエンティティ データ ドメインのオブジェクト LinkedEntityCellValue 自動的に更新される頻度を秒単位で指定します。 有効な最小値は 300 です。 このプロパティは、 supportedRefreshModes 配列に値 "Periodic" が含まれている場合に必要です。 このプロパティは、リンクされたエンティティ データ ドメインの refreshMode が "Periodic" に設定されている場合にのみ適用されます。

periodicRefreshInterval?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.19 ]

supportedRefreshModes

リンクされたエンティティ データ ドメインでサポートされているすべての更新モードを指定します。 既定値は ["Manual"]であり、指定されていない場合でも常にサポートされます。 ブックに保存された更新モードは、次に開くブックのリンクされたエンティティ データ ドメインの既定の更新モードとして読み込まれます。 更新モードがブックに保存されていない場合、配列の最初の値は、リンクされたエンティティ データ ドメインの既定の更新モードとして設定されます。 配列の値が "Periodic" の場合は、リンクされたエンティティ データ ドメインに対して periodicRefreshInterval プロパティも設定する必要があります。

supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];

プロパティ値

注釈

[ API セット: ExcelApi 1.19 ]