Excel.LinkedEntityDataDomainRefreshMode enum

Paquete:
excel

Representa la configuración del modo de actualización para los LinkedEntityCellValue objetos de un LinkedEntityDataDomainarchivo .

Comentarios

Conjunto de API: ExcelApi 1.19

Usada por

Ejemplos

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

Actualización manual por parte del usuario. La actualización no se desencadena automáticamente.
onLoad = "OnLoad"

Actualización al cargar el libro, aplicable a los dominios de datos de entidad vinculados definidos por proveedores de datos de servicio, como Bing o Power BI. Actualización al cargar el complemento, aplicable a los dominios de datos de entidades vinculadas definidos por los complementos de Office.
periodic = "Periodic"

Se actualizará automáticamente en función de la frecuencia, en segundos, especificada por periodicRefreshInterval. En el caso de los dominios de datos de entidad vinculados definidos por los proveedores de datos de servicio, como Bing o Power BI, este valor también inicia una actualización cada vez que se abre el libro. En el caso de los dominios de datos de entidades vinculadas definidos por los complementos de Office, este valor también inicia una actualización cada vez que se carga el complemento.
unknown = "Unknown"

El modo de actualización es desconocido o no es compatible.