Excel.FilterCriteria interface

包:

excel

表示应用于列的筛选条件。

注解

[ API 集：ExcelApi 1.2 ]

属性

color	用于筛选单元格的 HTML 颜色字符串。 与 和 fontColor 筛选一起使用cellColor。
criterion1	第一个条件用于筛选数据。 在筛选的情况下 custom 用作运算符。 例如，“>50”表示大于 50 的数字，或者“=*s”表示以“s”结尾的值。 在顶部/底部项目/百分比 (情况下用作数字，例如，如果 filterOn 设置为 topItems) ，则为前 5 个项目的“5”。
criterion2	第二个条件用于筛选数据。 仅在筛选的情况下 custom 用作运算符。
dynamicCriteria	集中要应用于此列的动态条件 Excel.DynamicFilterCriteria 。 用于 dynamic 筛选。
filterOn	筛选器使用的属性，用于确定是否应将值保持为可见时。
icon	用于筛选单元格的图标。 用于 icon 筛选。
operator	使用筛选时，用于组合条件 1 和 2 的 custom 运算符。
subField	筛选器用于对富值执行丰富筛选的属性。
values	要用作筛选一部分的值 values 集。

属性详细信息

color

用于筛选单元格的 HTML 颜色字符串。 与 和 fontColor 筛选一起使用cellColor。

color?: string;

属性值

string

注解

[ API 集：ExcelApi 1.2 ]

criterion1

第一个条件用于筛选数据。 在筛选的情况下 custom 用作运算符。 例如，“>50”表示大于 50 的数字，或者“=*s”表示以“s”结尾的值。

在顶部/底部项目/百分比 (情况下用作数字，例如，如果 filterOn 设置为 topItems) ，则为前 5 个项目的“5”。

criterion1?: string;

属性值

string

注解

[ API 集：ExcelApi 1.2 ]

criterion2

第二个条件用于筛选数据。 仅在筛选的情况下 custom 用作运算符。

criterion2?: string;

属性值

string

注解

[ API 集：ExcelApi 1.2 ]

dynamicCriteria

集中要应用于此列的动态条件 Excel.DynamicFilterCriteria 。 用于 dynamic 筛选。

dynamicCriteria?: Excel.DynamicFilterCriteria | "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday";

属性值

Excel.DynamicFilterCriteria | "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"

注解

[ API 集：ExcelApi 1.2 ]

filterOn

筛选器使用的属性，用于确定是否应将值保持为可见时。

filterOn: Excel.FilterOn | "BottomItems" | "BottomPercent" | "CellColor" | "Dynamic" | "FontColor" | "Values" | "TopItems" | "TopPercent" | "Icon" | "Custom";

属性值

Excel.FilterOn | "BottomItems" | "BottomPercent" | "CellColor" | "Dynamic" | "FontColor" | "Values" | "TopItems" | "TopPercent" | "Icon" | "Custom"

注解

[ API 集：ExcelApi 1.2 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function adds a percentage 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 the top 50% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, {
        criterion1: "50",
        filterOn: Excel.FilterOn.topPercent
    });

    await context.sync();
});

icon

用于筛选单元格的图标。 用于 icon 筛选。

icon?: Excel.Icon;

属性值

Excel.Icon

注解

[ API 集：ExcelApi 1.2 ]

operator

使用筛选时，用于组合条件 1 和 2 的 custom 运算符。

operator?: Excel.FilterOperator | "And" | "Or";

属性值

Excel.FilterOperator | "And" | "Or"

注解

[ API 集：ExcelApi 1.2 ]

subField

筛选器用于对富值执行丰富筛选的属性。

subField?: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

values

要用作筛选一部分的值 values 集。

values?: Array<string | FilterDatetime>;

属性值

Array<string | Excel.FilterDatetime>

注解

[ API 集：ExcelApi 1.2 ]