Excel.LinkedEntityDataDomainRefreshMode enum

Пакет:
excel

Представляет настройку режима обновления для LinkedEntityCellValue объектов LinkedEntityDataDomain.

Комментарии

Набор API: ExcelApi 1.19

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

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-linked-entities.yaml

// Register the product, category, and supplier data sources with Excel.
await Excel.run(async (context) => {
    const domains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;
    const refreshModes: Excel.LinkedEntityDataDomainRefreshMode[] = [
        Excel.LinkedEntityDataDomainRefreshMode.manual,
        Excel.LinkedEntityDataDomainRefreshMode.onLoad,
        Excel.LinkedEntityDataDomainRefreshMode.periodic
    ];
    // Script Lab prefixes the function ID with the companion sample's name, without spaces.
    const loadFunctionId = "LINKEDENTITYLOADSERVICE.CONTOSOLOADSERVICE";
    const options: Excel.LinkedEntityDataDomainCreateOptions[] = [
        {
            dataProvider: "Contoso",
            id: "products",
            name: "Products",
            loadFunctionId,
            periodicRefreshInterval: 300,
            supportedRefreshModes: refreshModes
        },
        {
            dataProvider: "Contoso",
            id: "categories",
            name: "Categories",
            loadFunctionId,
            periodicRefreshInterval: 300,
            supportedRefreshModes: refreshModes
        },
        {
            dataProvider: "Contoso",
            id: "suppliers",
            name: "Suppliers",
            loadFunctionId
        }
    ];

    // Replace only this sample's domains so registration is repeatable.
    const existingDomains: Excel.LinkedEntityDataDomain[] = options.map((options) =>
        domains.getItemOrNullObject(options.id)
    );
    await context.sync();
    existingDomains.forEach((domain) => {
        if (!domain.isNullObject) {
            domain.delete();
        }
    });
    options.forEach((options) => domains.add(options));
    await context.sync();
    console.log("Registered Products, Categories, and Suppliers. Manual refresh is the default.");
});

Поля

manual = "Manual"

Обновление вручную пользователем. Обновление не запускается автоматически.

Это поле не поддерживается в Excel в Интернете.
onLoad = "OnLoad"

Обновление при загрузке книги, применимо к доменам данных связанных сущностей, определенным поставщиками данных служб, такими как Bing или Power BI. Обновление при загрузке надстройки, применимо к доменам данных связанных сущностей, определенным надстройками Office.

Это поле не поддерживается в Excel в Интернете.
periodic = "Periodic"

Обновление автоматически на основе частоты в секундах, заданной как periodicRefreshInterval. Для доменов данных связанных сущностей, определенных поставщиками данных служб, такими как Bing или Power BI, это значение также инициирует обновление при каждом открытии книги. Для доменов данных связанных сущностей, определенных надстройками Office, это значение также инициирует обновление при каждой загрузке надстройки.

Это поле не поддерживается в Excel в Интернете.
unknown = "Unknown"

Режим обновления неизвестен или не поддерживается.

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