Excel.FilterOn enum

Package:

excel

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();
});

Fields

bottomItems = "BottomItems"	[ API set: ExcelApi 1.2 ]
bottomPercent = "BottomPercent"	[ API set: ExcelApi 1.2 ]
cellColor = "CellColor"	[ API set: ExcelApi 1.2 ]
custom = "Custom"	[ API set: ExcelApi 1.2 ]
dynamic = "Dynamic"	[ API set: ExcelApi 1.2 ]
fontColor = "FontColor"	[ API set: ExcelApi 1.2 ]
icon = "Icon"	[ API set: ExcelApi 1.2 ]
topItems = "TopItems"	[ API set: ExcelApi 1.2 ]
topPercent = "TopPercent"	[ API set: ExcelApi 1.2 ]
values = "Values"	[ API set: ExcelApi 1.2 ]