Excel.LinkedEntityDataDomainCreateOptions interface

Пакет:
excel

Представляет параметры, используемые для создания LinkedEntityDataDomain объекта, добавляемого в LinkedEntityDataDomainCollection.

Комментарии

Набор API: ExcelApi 1.19

Этот интерфейс не поддерживается в Excel в Интернете.

Используется

Примеры

// 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

Указывает идентификатор домена данных связанной сущности. Этот идентификатор должен быть уникальным для всех доменов данных связанных сущностей, определенных этой надстройкой Office.
loadFunctionId

Указывает идентификатор пользовательской функции, которая будет вызываться по запросу для разрешения или обновления LinkedEntityCellValue объектов этого домена данных связанной сущности. Дополнительные сведения см. в разделе Автоматическое создание метаданных JSON для пользовательских функций: идентификатор.
name

Указывает имя домена данных связанной сущности. Это имя должно быть уникальным для всех доменов данных связанных сущностей, определенных этой надстройкой Office.
periodicRefreshInterval

Указывает частоту (в секундах), с которой LinkedEntityCellValue объекты этого домена данных связанной сущности обновляются автоматически. Минимальное допустимое значение — 300. Это свойство является обязательным, supportedRefreshModes если массив содержит значение "Periodic". Это свойство применяется только в refreshMode том случае, если для домена данных связанной сущности задано значение "Periodic".
supportedRefreshModes

Указывает все режимы обновления, поддерживаемые доменом данных связанной сущности. Значение по умолчанию — ["Manual"], которое всегда поддерживается, даже если не указано. Режим обновления, сохраненный в книге, загружается как режим обновления по умолчанию для домена данных связанной сущности в следующей открытой книге. Если режим обновления не был сохранен в книге, первое значение в массиве устанавливается в качестве режима обновления по умолчанию для домена данных связанной сущности. Если массив имеет значение "Periodic", periodicRefreshInterval свойство также должно быть задано для домена данных связанной сущности.

Сведения о свойстве

dataProvider

Указывает имя поставщика данных для домена данных связанной сущности.

dataProvider: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.19

Это свойство не поддерживается в Excel в Интернете.

id

Указывает идентификатор домена данных связанной сущности. Этот идентификатор должен быть уникальным для всех доменов данных связанных сущностей, определенных этой надстройкой Office.

id: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.19

Это свойство не поддерживается в Excel в Интернете.

loadFunctionId

Указывает идентификатор пользовательской функции, которая будет вызываться по запросу для разрешения или обновления LinkedEntityCellValue объектов этого домена данных связанной сущности. Дополнительные сведения см. в разделе Автоматическое создание метаданных JSON для пользовательских функций: идентификатор.

loadFunctionId: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.19

Это свойство не поддерживается в Excel в Интернете.

name

Указывает имя домена данных связанной сущности. Это имя должно быть уникальным для всех доменов данных связанных сущностей, определенных этой надстройкой Office.

name: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.19

Это свойство не поддерживается в Excel в Интернете.

periodicRefreshInterval

Указывает частоту (в секундах), с которой LinkedEntityCellValue объекты этого домена данных связанной сущности обновляются автоматически. Минимальное допустимое значение — 300. Это свойство является обязательным, supportedRefreshModes если массив содержит значение "Periodic". Это свойство применяется только в refreshMode том случае, если для домена данных связанной сущности задано значение "Periodic".

periodicRefreshInterval?: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.19

Это свойство не поддерживается в Excel в Интернете.

supportedRefreshModes

Указывает все режимы обновления, поддерживаемые доменом данных связанной сущности. Значение по умолчанию — ["Manual"], которое всегда поддерживается, даже если не указано. Режим обновления, сохраненный в книге, загружается как режим обновления по умолчанию для домена данных связанной сущности в следующей открытой книге. Если режим обновления не был сохранен в книге, первое значение в массиве устанавливается в качестве режима обновления по умолчанию для домена данных связанной сущности. Если массив имеет значение "Periodic", periodicRefreshInterval свойство также должно быть задано для домена данных связанной сущности.

supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];

Значение свойства

Excel.LinkedEntityDataDomainRefreshMode[]

Комментарии

Набор API: ExcelApi 1.19

Это свойство не поддерживается в Excel в Интернете.