Excel.AutoFilter class
表示 AutoFilter 对象。 自动筛选根据单元格内容将 Excel 列中的值转换为特定筛选器。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| criteria | 在自动筛选区域中保留所有筛选条件的数组。 |
| enabled | 指定是否启用自动筛选。 |
| is |
指定自动筛选是否具有筛选条件。 |
方法
| apply(range, column |
将自动筛选器应用于区域。 如果指定了列索引和筛选条件，则筛选列。 |
| clear |
清除自动筛选的列筛选条件。 |
| clear |
清除自动筛选的筛选条件和排序状态。 |
| get |
返回对象， |
| get |
返回对象， |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| reapply() | 应用区域上当前指定的 AutoFilter 对象。 |
| remove() | 删除区域的自动筛选。 |
| toJSON() | 重写 JavaScript |
属性详细信息
context
criteria
在自动筛选区域中保留所有筛选条件的数组。
readonly criteria: Excel.FilterCriteria[];属性值
注解
enabled
isDataFiltered
方法详细信息
apply(range, columnIndex, criteria)
将自动筛选器应用于区域。 如果指定了列索引和筛选条件，则筛选列。
apply(range: Range | string, columnIndex?: number, criteria?: Excel.FilterCriteria): void;参数
- range
-
Excel.Range | string
将应用自动筛选的范围。
- columnIndex
-
number
应用自动筛选的从零开始的列索引。
- criteria
- Excel.FilterCriteria
筛选条件。
返回
void
注解
示例
// 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();
});
clearColumnCriteria(columnIndex)
清除自动筛选的列筛选条件。
clearColumnCriteria(columnIndex: number): void;参数
- columnIndex
-
number
从零开始的列索引，表示需要清除哪个列筛选器。 如果不支持索引值 (例如，如果值为负数，或者该值大于) 范围内的可用列数， InvalidArgument 则会引发错误。
返回
void
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
// This function clears the AutoFilter setting from one column.
await Excel.run(async (context) => {
// Retrieve the active worksheet.
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Clear the filter from only column 3.
sheet.autoFilter.clearColumnCriteria(3);
await context.sync();
});
clearCriteria()
getRange()
getRangeOrNullObject()
返回对象， Range 该对象表示自动筛选应用到的范围。
Range如果没有与 AutoFilter 关联的对象，则此方法返回一个对象，其isNullObject属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getRangeOrNullObject(): Excel.Range;返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.AutoFilterLoadOptions): Excel.AutoFilter;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.AutoFilter;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.AutoFilter;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
reapply()
应用区域上当前指定的 AutoFilter 对象。
reapply(): void;返回
void
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
// This function refreshes the AutoFilter to ensure that changes are captured.
await Excel.run(async (context) => {
// Retrieve the active worksheet.
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Reapply the filter to capture changes.
sheet.autoFilter.reapply();
await context.sync();
});
remove()
删除区域的自动筛选。
remove(): void;返回
void
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
// This function removes all AutoFilters from the active worksheet.
await Excel.run(async (context) => {
// Retrieve the active worksheet.
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Remove all filters.
sheet.autoFilter.remove();
await context.sync();
});
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.AutoFilter对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.AutoFilterData) ，其中包含原始对象中任何已加载子属性的浅表副本。
toJSON(): Excel.Interfaces.AutoFilterData;