Excel.LinkedEntityDataDomainCreateOptions interface
LinkedEntityDataDomainCollection
に追加されるLinkedEntityDataDomainオブジェクトを作成するために使用されるオプションを表します。
注釈
[API セット: ExcelApi 1.19]
このインターフェイスは、Excel on the web ではサポートされていません。
プロパティ
| data |
リンクされたエンティティ データ ドメインのデータ プロバイダーの名前を指定します。 |
| id | リンクされたエンティティ データ ドメインの ID を指定します。 この ID は、この Office アドインによって定義されているすべてのリンクされたエンティティ データ ドメインで一意である必要があります。 |
| load |
このリンクされたエンティティ データ ドメインの |
| name | リンクされたエンティティ データ ドメインの名前を指定します。 この名前は、この Office アドインによって定義されているすべてのリンクされたエンティティ データ ドメインで一意である必要があります。 |
| periodic |
このリンクされたエンティティ データ ドメインの |
| supported |
リンクされたエンティティ データ ドメインでサポートされるすべての更新モードを指定します。 既定値は |
プロパティの詳細
dataProvider
リンクされたエンティティ データ ドメインのデータ プロバイダーの名前を指定します。
dataProvider: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.19]
このプロパティは Excel on the web ではサポートされていません。
id
リンクされたエンティティ データ ドメインの ID を指定します。 この ID は、この Office アドインによって定義されているすべてのリンクされたエンティティ データ ドメインで一意である必要があります。
id: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.19]
このプロパティは Excel on the web ではサポートされていません。
loadFunctionId
このリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトを解決または更新するためにオンデマンドで呼び出されるカスタム関数の ID を指定します。 詳細については、「 カスタム関数の JSON メタデータを自動生成する: ID」を参照してください。
loadFunctionId: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.19]
このプロパティは Excel on the web ではサポートされていません。
name
リンクされたエンティティ データ ドメインの名前を指定します。 この名前は、この Office アドインによって定義されているすべてのリンクされたエンティティ データ ドメインで一意である必要があります。
name: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.19]
このプロパティは Excel on the web ではサポートされていません。
periodicRefreshInterval
このリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトが自動的に更新される頻度を秒単位で指定します。 有効な最小値は 300 です。 このプロパティは、 supportedRefreshModes 配列に値 "Periodic" が含まれている場合に必要です。 このプロパティは、リンクされたエンティティ データ ドメインの refreshMode が "定期" に設定されている場合にのみ適用されます。
periodicRefreshInterval?: number;
プロパティ値
number
注釈
[API セット: ExcelApi 1.19]
このプロパティは Excel on the web ではサポートされていません。
supportedRefreshModes
リンクされたエンティティ データ ドメインでサポートされるすべての更新モードを指定します。 既定値は ["Manual"] で、指定しなくても常にサポートされます。 ブックに保存された更新モードは、次に開いたブックで、リンクされたエンティティ データ ドメインの既定の更新モードとして読み込まれます。 更新モードがブックに保存されていない場合、配列内の最初の値が、リンクされたエンティティ データ ドメインの既定の更新モードとして設定されます。 配列の値が "Periodic" の場合は、リンクされたエンティティ データ ドメインに periodicRefreshInterval プロパティも設定する必要があります。
supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];
プロパティ値
注釈
[API セット: ExcelApi 1.19]
このプロパティは Excel on the web ではサポートされていません。