Excel.LinkedEntityDataDomainCreateOptions interface

パッケージ:: excel

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

注釈

このインターフェイスは、Excel on the webではサポートされていません。

使用元

Excel.LinkedEntityDataDomainCollection: add

例

// Registers linked entity data domains when the add-in loads.
await Excel.run(async (context) => {
    const productsDomainOptions: Excel.LinkedEntityDataDomainCreateOptions = {
        dataProvider: "Contoso",
        id: "products",
        name: "Products",
        // ID of the custom function called by Excel to resolve or refresh linked entity cell values.
        loadFunctionId: "CONTOSOLOADSERVICE",
        // periodicRefreshInterval is only required when supportedRefreshModes contains "Periodic".
        periodicRefreshInterval: 300,
        // Manual refresh mode is always supported, even if unspecified.
        supportedRefreshModes: [
            Excel.LinkedEntityDataDomainRefreshMode.periodic,
            Excel.LinkedEntityDataDomainRefreshMode.onLoad
        ]
    };

    // Add the data domain to the collection to register it.
    context.workbook.linkedEntityDataDomains.add(productsDomainOptions);
    await context.sync();
});

プロパティ

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

このプロパティは、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 が "Periodic" に設定されている場合にのみ適用されます。

periodicRefreshInterval?: number;

プロパティ値

number

注釈

API セット: ExcelApi 1.19

このプロパティは、Excel on the webではサポートされていません。

supportedRefreshModes

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

supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];

プロパティ値

Excel.LinkedEntityDataDomainRefreshMode[]

注釈

API セット: ExcelApi 1.19

このプロパティは、Excel on the webではサポートされていません。

フィードバック

このページはお役に立ちましたか?