# autoFilter-设置筛选
调用autoFilter函数在指定Excel工作表区域设置筛选选项。
最小支持版本:5.0.0
# 接口说明
已通过getRangeByAddress函数创建实例对象excelRange,详情请参见getRangeByAddress (opens new window)。
指定的Excel工作表区域不能为空,否则调用本函数将产生“无效区域”或“空白区域”的等报错。
# 语法
<ExcelRange object>.autoFilter(-1, [], 7, [], "", false)
1
<ExcelRange object>.设置筛选(-1, [], 7, [], "", false)
1
# 函数类型
实例函数
# 请求参数
参数名称 | 类型 | 是否必选 | 默认值 | 示例值 | 描述 |
---|---|---|---|---|---|
field | Cube.Lang.Number | 是 | -1 | 1 | 列偏移量,即需要设置筛选条件的列在Excel区域内的偏移量。1表示Excel区域内的第一列,2表示Excel区域内的第二列,依此类推。默认为-1,表示为Excel默认列设置筛选条件,一般为Excel区域内的第一列。 |
criteria1 | Cube.Lang.List | 是 | [] | ["Mary", "Alex"] | 筛选条件列表1,列表中各项为字符串且各项之间的关系为"或"。默认值:[]。例如["Mary","Alex"]表示筛选目标列中值为"Mary"或者"Alex"的项。 |
operator | Cube.Lang.Number | 是 | 7 | 7 | 筛选操作方式。 1: 筛选条件列表1与筛选条件列表2之间为"与"的关系 4: 对筛选条件1筛选的结果取后10项 6: 对筛选条件1筛选的结果取后10% 8: 筛选单元格颜色 11: 动态筛选 9: 筛选字体颜色 10: 筛选图标 7: 筛选值 2: 筛选条件列表1与筛选条件列表2之间为"或"的关系 3: 对筛选条件1筛选的结果取前10项 5: 对筛选条件1筛选的结果取前10% |
criteria2 | Cube.Lang.List | 是 | [] | [] | 筛选条件列表2,列表中各项为字符串且各项之间的关系为"或"。默认值:[]。与参数criteria1和operator合成综合条件进行筛选。当传入criteria1、criteria2两个筛选条件时,参数operator需选择1或2。例如,筛选大于1000且不等于1000的值,则criteria1传入[“>1000”],operator传入1,criteria2传入[“<>1000”]。 |
subField | Cube.Lang.String | 是 | 无 | "Population" | 某个标准数据类型中的字段, 例如Geography中的"Population"字段或Stocks中的"Volume"字段。 |
visibleDropDown | Cube.Lang.Boolean | 是 | true | true | 是否显示筛选箭头。取值: true:显示筛选箭头。 false:不显示筛选箭头。 |
# 返回参数
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Result | Cube.Lang.Null | 无 | 该函数返回值为空值。 |
# 请求示例
excelRange.autoFilter(1,["Mary", "Alex"],7,[],"Population",true)
1
最近更新时间: {
"value": "2023-09-12",
"effect": true
}