Excel.Filter class
管理表格列的筛选。
- 扩展
注解
属性
context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
criteria | 给定列上当前应用的筛选器。 |
方法
apply(criteria) | 在给定列中应用给定的筛选条件。 |
apply |
将“Bottom Item”筛选器应用于列,以获取给定数量的元素。 |
apply |
将“Bottom Percent”筛选器应用于列,以获取给定比例的元素。 |
apply |
将“Cell Color”筛选器应用于列,以获取给定颜色。 |
apply |
将“图标”筛选器应用于给定条件字符串的列。 |
apply |
将“图标”筛选器应用于给定条件字符串的列。 |
apply |
将“Dynamic”筛选器应用于列。 |
apply |
将“Dynamic”筛选器应用于列。 |
apply |
将“Font Color”筛选器应用于列,以获取给定颜色。 |
apply |
将“图标”筛选器应用于给定图标的列。 |
apply |
将“Top Item”筛选器应用于列,以获取给定数量的元素。 |
apply |
将“Top Percent”筛选器应用于列,以获取给定比例的元素。 |
apply |
将“Values”筛选器应用于列,获取给定值。 |
clear() | 清除给定列上的 filter。 |
load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
toJSON() | 重写 JavaScript |
属性详细信息
context
criteria
给定列上当前应用的筛选器。
readonly criteria: Excel.FilterCriteria;
属性值
注解
方法详细信息
apply(criteria)
在给定列中应用给定的筛选条件。
apply(criteria: Excel.FilterCriteria): void;
参数
- criteria
- Excel.FilterCriteria
要应用的条件。
返回
void
注解
applyBottomItemsFilter(count)
将“Bottom Item”筛选器应用于列,以获取给定数量的元素。
applyBottomItemsFilter(count: number): void;
参数
- count
-
number
要显示的底部元素的数量。
返回
void
注解
applyBottomPercentFilter(percent)
将“Bottom Percent”筛选器应用于列,以获取给定比例的元素。
applyBottomPercentFilter(percent: number): void;
参数
- percent
-
number
要显示的底部元素的百分比。
返回
void
注解
applyCellColorFilter(color)
将“Cell Color”筛选器应用于列,以获取给定颜色。
applyCellColorFilter(color: string): void;
参数
- color
-
string
要显示的单元格的背景颜色。
返回
void
注解
applyCustomFilter(criteria1, criteria2, oper)
将“图标”筛选器应用于给定条件字符串的列。
applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.FilterOperator): void;
参数
- criteria1
-
string
第一个条件字符串。
- criteria2
-
string
可选。 第二个条件字符串。
- oper
- Excel.FilterOperator
可选。 说明这两个条件如何联接的运算符。
返回
void
注解
applyCustomFilter(criteria1, criteria2, operString)
将“图标”筛选器应用于给定条件字符串的列。
applyCustomFilter(criteria1: string, criteria2?: string, operString?: "And" | "Or"): void;
参数
- criteria1
-
string
第一个条件字符串。
- criteria2
-
string
可选。 第二个条件字符串。
- operString
-
"And" | "Or"
可选。 说明这两个条件如何联接的运算符。
返回
void
注解
applyDynamicFilter(criteria)
将“Dynamic”筛选器应用于列。
applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;
参数
- criteria
- Excel.DynamicFilterCriteria
要应用的动态条件。
返回
void
注解
applyDynamicFilter(criteriaString)
将“Dynamic”筛选器应用于列。
applyDynamicFilter(criteriaString: "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;
参数
- criteriaString
-
"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
注解
applyFontColorFilter(color)
将“Font Color”筛选器应用于列,以获取给定颜色。
applyFontColorFilter(color: string): void;
参数
- color
-
string
要显示的单元格的字体颜色。
返回
void
注解
applyIconFilter(icon)
将“图标”筛选器应用于给定图标的列。
applyIconFilter(icon: Excel.Icon): void;
参数
- icon
- Excel.Icon
要显示的单元格图标。
返回
void
注解
applyTopItemsFilter(count)
将“Top Item”筛选器应用于列,以获取给定数量的元素。
applyTopItemsFilter(count: number): void;
参数
- count
-
number
要显示的顶部元素的数量。
返回
void
注解
applyTopPercentFilter(percent)
将“Top Percent”筛选器应用于列,以获取给定比例的元素。
applyTopPercentFilter(percent: number): void;
参数
- percent
-
number
要显示的顶部元素的百分比。
返回
void
注解
applyValuesFilter(values)
将“Values”筛选器应用于列,获取给定值。
applyValuesFilter(values: Array<string | FilterDatetime>): void;
参数
- values
-
Array<string | Excel.FilterDatetime>
要显示的值的列表。 这必须是字符串数组或对象的数组 Excel.FilterDateTime
。
返回
void
注解
clear()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter;
参数
提供要加载对象的属性的选项。
返回
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;