Skip to content

筛选视图的筛选条件指南

筛选视图允许用户在独立界面按特定筛选条件筛选数据,查看筛选结果,不影响其他协作者的操作。筛选范围内的每一列都可以设置筛选条件。 本文档介绍电子表格筛选视图中筛选条件的相关参数和方法列表。 本文档介绍电子表格筛选视图中的筛选条件说明,要了解直接在工作表中创建、获取筛选等能力,参考筛选指南

注意事项

  • 筛选范围内的第一行不参与筛选。
  • 单个筛选视图仅可指定一个筛选范围。

筛选条件参数

筛选视图 ID filter_view_id

filter_view_id 是一个筛选视图的唯一标识。可以通过以下方式获取:

  • 通过查询筛选视图接口获取

  • 在电子表格中进入一个筛选视图后,从链接地址中获取。如下图所示,该视图的筛选视图 ID 为 ZnwY6af6dP

筛选条件 condition

筛选视图的筛选条件 condition 用于指定列的筛选条件信息,结构如下所示。

json
{
  "condition_id": "E", // 指定列的字母编号。
  "filter_type": "number", // 筛选类型。枚举值参考下文。
  "compare_type": "less", // 比较类型。枚举值由 filter_type 决定。具体可参考下文。
  "expected": [ // 筛选值。具体可参考下文。
    "6"
  ]
}

筛选条件 condition 中的筛选类型 filter_type 参数支持以下四种。每种筛选类型需要填写对应的比较类型(compare_type)和比较的值(expected)。具体说明如下所示。

多值筛选 multiValue

多值筛选指筛选特定的值。当筛选类型为多值时:

  • compare_type:不填
  • expected:要展示的值。数组类型,数组长度需大于 0 且小于等于筛选范围的行数。每个值的字符长度不得超过 50,000 个。
json
{
  "condition": {
    "filter_type": "multiValue",
    "expected": ["100", "200", "300"]  // 筛选出数据为 100,200 和 300 的单元格
  }
}

数字筛选 number

数字筛选指筛选符合特定数值条件的数据。当筛选类型为数字时,比较类型 compare_type 参数的枚举和对应的 expected 限制如下表所示。

compare_type 枚举描述expected 数组长度限制
equal等于1
notEqual不等于1
greater大于1
greaterOrEqual大于等于1
less小于1
lessOrEqual小于等于1
between介于2
notBetween不介于2
json
{
  "condition_id": "E",
  "filter_type": "number",
  "compare_type": "between",
  "expected": [
    "100",
    "200"
  ]
}

文本筛选 text

文本筛选指筛选符合特定文本条件的数据。当筛选类型为文本时:

  • expected:文本字符。数组类型,数组长度为 1。文本字符的长度不得超过 1,000。
  • compare_type 参数的枚举如下所示:
compare_type 枚举描述
beginsWith开头是
notBeginsWith开头不是
endsWith结尾是
notEndsWith结尾不是
contains包含
notContains不包含
json
{
  "condition_id": "E",
  "filter_type": "text",
  "compare_type": "contains",
  "expected": [
    "已完成"
  ]
}

颜色筛选 color

颜色筛选指筛选具有特定颜色属性的数据。当筛选类型为颜色时:

  • expected:颜色的十六进制代码,如 ["#ffffff"]。数组类型,数组长度为 1。

  • 比较类型 compare_type 参数的枚举如下表所示。

compare_type 枚举描述
backColor单元格颜色
foreColor字体颜色
json
{
  "condition_id": "E",
  "filter_type": "color",
  "compare_type": "backColor",
  "expected": [
    "#ffffff"
  ]
}

方法列表

以下为筛选条件的方法列表。其中,“商店”代表应用商店应用;“自建”代表企业自建应用,了解更多应用相关信息,参考应用类型简介。了解调用服务端 API 的流程,参考流程概述

方法 (API)权限要求(满足任一)访问凭证商店自建
``POST [创建筛选条件](https://open.larkoffice.com/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/create)/open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id/conditionsdrive:drive 查看、评论、编辑和管理云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格tenant_access_token user_access_token
``PUT [更新筛选条件](https://open.larkoffice.com/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/update) /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id/conditions/:condition_iddrive:drive 查看、评论、编辑和管理云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格tenant_access_token user_access_token
``GET [查询筛选条件](https://open.larkoffice.com/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/query) /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id/conditions/querydrive:drive 查看、评论、编辑和管理云空间中所有文件 drive:drive:readonly 查看、评论和下载云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 sheets:spreadsheet:readonly 查看、评论和导出电子表格tenant_access_token user_access_token
``GET [获取筛选条件](https://open.larkoffice.com/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/get)/open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id/conditions/:condition_iddrive:drive 查看、评论、编辑和管理云空间中所有文件 drive:drive:readonly 查看、评论和下载云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 sheets:spreadsheet:readonly 查看、评论和导出电子表格tenant_access_token user_access_token
``DELETE [删除筛选条件](https://open.larkoffice.com/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/delete) /open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id/conditions/:condition_iddrive:drive 查看、评论、编辑和管理云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格tenant_access_token user_access_token

内容来源:飞书开放平台 · 自动爬取整理