Excel.Filter class

管理表格列的筛选。

扩展

属性

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

criteria

给定列上当前应用的筛选器。

方法

apply(criteria)

在给定列中应用给定的筛选条件。

applyBottomItemsFilter(count)

将“Bottom Item”筛选器应用于列,以获取给定数量的元素。

applyBottomPercentFilter(percent)

将“Bottom Percent”筛选器应用于列,以获取给定比例的元素。

applyCellColorFilter(color)

将“Cell Color”筛选器应用于列,以获取给定颜色。

applyCustomFilter(criteria1, criteria2, oper)

将“图标”筛选器应用于给定条件字符串的列。

applyCustomFilter(criteria1, criteria2, oper)

将“图标”筛选器应用于给定条件字符串的列。

applyDynamicFilter(criteria)

将“Dynamic”筛选器应用于列。

applyDynamicFilter(criteria)

将“Dynamic”筛选器应用于列。

applyFontColorFilter(color)

将“Font Color”筛选器应用于列,以获取给定颜色。

applyIconFilter(icon)

将“图标”筛选器应用于给定图标的列。

applyTopItemsFilter(count)

将“Top Item”筛选器应用于列,以获取给定数量的元素。

applyTopPercentFilter(percent)

将“Top Percent”筛选器应用于列,以获取给定比例的元素。

applyValuesFilter(values)

将“Values”筛选器应用于列,获取给定值。

clear()

清除给定列上的 filter。

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

toJSON()

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.Filter 对象是 API 对象, toJSON 但该方法返回一个纯 JavaScript 对象, (类型化为 Excel.Interfaces.FilterData) ,其中包含从原始对象加载的任何子属性的浅层副本。

属性详细信息

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

criteria

给定列上当前应用的筛选器。

readonly criteria: Excel.FilterCriteria;

属性值

注解

API 集:ExcelApi 1.2

方法详细信息

apply(criteria)

在给定列中应用给定的筛选条件。

apply(criteria: Excel.FilterCriteria): void;

参数

criteria
Excel.FilterCriteria

要应用的条件。

返回

void

注解

API 集:ExcelApi 1.2

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/get-visible-range-of-a-filtered-table.yaml

/** Filter the table*/
async function filterTable() {
    await Excel.run(async (context) => {
        const sheet = context.workbook.worksheets.getItem("Sample");
        const expensesTable = sheet.tables.getItem("ExpensesTable");
        const filter: Excel.Filter = expensesTable.columns.getItem("Amount").filter;

        filter.apply({
            filterOn: Excel.FilterOn.dynamic,
            dynamicCriteria: Excel.DynamicFilterCriteria.belowAverage
        });

        await context.sync();
    });

applyBottomItemsFilter(count)

将“Bottom Item”筛选器应用于列,以获取给定数量的元素。

applyBottomItemsFilter(count: number): void;

参数

count

number

要显示的底部元素的数量。

返回

void

注解

API 集:ExcelApi 1.2

applyBottomPercentFilter(percent)

将“Bottom Percent”筛选器应用于列,以获取给定比例的元素。

applyBottomPercentFilter(percent: number): void;

参数

percent

number

要显示的底部元素的百分比。

返回

void

注解

API 集:ExcelApi 1.2

applyCellColorFilter(color)

将“Cell Color”筛选器应用于列,以获取给定颜色。

applyCellColorFilter(color: string): void;

参数

color

string

要显示的单元格的背景颜色。

返回

void

注解

API 集:ExcelApi 1.2

applyCustomFilter(criteria1, criteria2, oper)

将“图标”筛选器应用于给定条件字符串的列。

applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.FilterOperator): void;

参数

criteria1

string

第一个条件字符串。

criteria2

string

可选。 第二个条件字符串。

oper
Excel.FilterOperator

可选。 说明这两个条件如何联接的运算符。

返回

void

注解

API 集:ExcelApi 1.2

applyCustomFilter(criteria1, criteria2, oper)

将“图标”筛选器应用于给定条件字符串的列。

applyCustomFilter(criteria1: string, criteria2?: string, oper?: "And" | "Or"): void;

参数

criteria1

string

第一个条件字符串。

criteria2

string

可选。 第二个条件字符串。

oper

"And" | "Or"

可选。 说明这两个条件如何联接的运算符。

返回

void

注解

API 集:ExcelApi 1.2

applyDynamicFilter(criteria)

将“Dynamic”筛选器应用于列。

applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;

参数

criteria
Excel.DynamicFilterCriteria

要应用的动态条件。

返回

void

注解

API 集:ExcelApi 1.2

applyDynamicFilter(criteria)

将“Dynamic”筛选器应用于列。

applyDynamicFilter(criteria: "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"): void;

参数

criteria

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

要应用的动态条件。

返回

void

注解

API 集:ExcelApi 1.2

applyFontColorFilter(color)

将“Font Color”筛选器应用于列,以获取给定颜色。

applyFontColorFilter(color: string): void;

参数

color

string

要显示的单元格的字体颜色。

返回

void

注解

API 集:ExcelApi 1.2

applyIconFilter(icon)

将“图标”筛选器应用于给定图标的列。

applyIconFilter(icon: Excel.Icon): void;

参数

icon
Excel.Icon

要显示的单元格图标。

返回

void

注解

API 集:ExcelApi 1.2

applyTopItemsFilter(count)

将“Top Item”筛选器应用于列,以获取给定数量的元素。

applyTopItemsFilter(count: number): void;

参数

count

number

要显示的顶部元素的数量。

返回

void

注解

API 集:ExcelApi 1.2

applyTopPercentFilter(percent)

将“Top Percent”筛选器应用于列,以获取给定比例的元素。

applyTopPercentFilter(percent: number): void;

参数

percent

number

要显示的顶部元素的百分比。

返回

void

注解

API 集:ExcelApi 1.2

applyValuesFilter(values)

将“Values”筛选器应用于列,获取给定值。

applyValuesFilter(values: Array<string | FilterDatetime>): void;

参数

values

Array<string | Excel.FilterDatetime>

要显示的值的列表。 必须是字符串数组或对象数 Excel.FilterDateTime 组。

返回

void

注解

API 集:ExcelApi 1.2

clear()

清除给定列上的 filter。

clear(): void;

返回

void

注解

API 集:ExcelApi 1.2

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter;

参数

options
Excel.Interfaces.FilterLoadOptions

为要加载的对象属性提供选项。

返回

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.Filter;

参数

propertyNames

string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

返回

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Filter;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串,以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

toJSON()

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.Filter 对象是 API 对象, toJSON 但该方法返回一个纯 JavaScript 对象, (类型化为 Excel.Interfaces.FilterData) ,其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): Excel.Interfaces.FilterData;

返回