Excel.FilterOn enum

Remarks

[ API set: ExcelApi 1.2 ]

Examples

// This function adds a custom AutoFilter to the active worksheet 
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
    // Retrieve the active worksheet and the used range on that worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // Add a filter that will only show the rows with values that end with the letter "e" in column 1.
    sheet.autoFilter.apply(farmData, 1, {
        criterion1: "=*e",
        filterOn: Excel.FilterOn.custom
    });

    await context.sync();
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/filter-data.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    const expensesTable = sheet.tables.getItem("ExpensesTable");

    let filter = expensesTable.columns.getItem("Amount").filter;
    filter.apply({
        filterOn: Excel.FilterOn.dynamic,
        dynamicCriteria: Excel.DynamicFilterCriteria.belowAverage
    });

    filter = expensesTable.columns.getItem("Category").filter;
    filter.apply({
            filterOn: Excel.FilterOn.values,
            values: ["Restaurant", "Groceries"]
    });

    await context.sync();
   });

Fields