Excel.LinkedEntityDataDomainRefreshMode enum

Pacote:
excel

Representa a configuração do modo de atualização para os LinkedEntityCellValue objetos de um LinkedEntityDataDomainarquivo .

Comentários

Conjunto de APIs: ExcelApi 1.19

Usada por

Exemplos

// 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.");
});

Campos

manual = "Manual"

Atualização manual pelo usuário. A atualização não é disparada automaticamente.
onLoad = "OnLoad"

Atualização ao carregar pasta de trabalho, aplicável a domínios de dados de entidade vinculados definidos por provedores de dados de serviço, como Bing ou Power BI. Atualização no carregamento do suplemento, aplicável aos domínios de dados de entidade vinculados definidos pelos Suplementos do Office.
periodic = "Periodic"

Atualize automaticamente com base na frequência, em segundos, especificada por periodicRefreshInterval. Para domínios de dados de entidade vinculados definidos por provedores de dados de serviço, como Bing ou Power BI, esse valor também inicia uma atualização sempre que a pasta de trabalho é aberta. Para domínios de dados de entidade vinculados definidos por Suplementos do Office, esse valor também inicia uma atualização sempre que o suplemento é carregado.
unknown = "Unknown"

O modo de atualização é desconhecido ou não tem suporte.