Edit

Share via


Excel.FilterOn enum

Remarks

[ API set: ExcelApi 1.2 ]

Examples

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

bottomItems = "BottomItems"
bottomPercent = "BottomPercent"
cellColor = "CellColor"
custom = "Custom"
dynamic = "Dynamic"
fontColor = "FontColor"
icon = "Icon"
topItems = "TopItems"
topPercent = "TopPercent"
values = "Values"