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 для пользовательских функций: ID.
name

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

Указывает частоту в секундах, с которой LinkedEntityCellValue объекты этого связанного домена данных объекта обновляются автоматически. Минимально допустимое значение — 300. Это свойство необходимо, если supportedRefreshModes массив содержит значение "Periodic". Это свойство применимо только в том случае, refreshMode если для связанного домена данных сущности задано значение "Периодический".
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 для пользовательских функций: ID.

loadFunctionId: string;

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

string

Комментарии

Набор API: ExcelApi 1.19

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

name

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

name: string;

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

string

Комментарии

Набор API: ExcelApi 1.19

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

periodicRefreshInterval

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

periodicRefreshInterval?: number;

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

number

Комментарии

Набор API: ExcelApi 1.19

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

supportedRefreshModes

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

supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];

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

Excel.LinkedEntityDataDomainRefreshMode[]

Комментарии

Набор API: ExcelApi 1.19

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