数据列表配置
数据列表(列配置)决定视图列表展示哪些字段列,以及每列的搜索、排序、链接、渲染与导入等行为。
概述
数据列表是视图列表的主体,一个字段对应一列。在编辑器的 列表配置 卡片中:
- 左侧「选择字段」: 勾选对象的字段,勾选后字段会加入右侧列表;取消勾选则移除。
- 右侧「列字段布局」:拖动调整列的顺序,点击某一列打开属性抽屉进行详细配置。
来源说明
可选字段来自所属实体对象(含 Lookup 关联字段,带 Fork 图标标识)。列的名称默认取字段名称,可单独修改;列编码 Code 只读不可改。
配置项
列的配置按抽屉中的分组划分,汇总如下:
| 配置项 | 说明 |
|---|---|
| 字段编码 | 列对应的对象字段编码,只读 |
| 字段名称 | 列显示名称,可修改 |
| 禁用用户搜索 | 是否禁止用户在搜索区使用该字段 |
| 是否默认展示在搜索区 | 该字段是否默认出现在搜索条件中 |
| 搜索方式 | 搜索匹配方式(等于、不等于、模糊、大小比较、范围) |
| 搜索默认值 | 搜索条件的默认值,支持内置动态值 |
| 是否在列表中隐藏 | 是否在表格中隐藏该列(仍可作为搜索项) |
| 是否启用排序 | 是否允许按该列排序 |
| 排序方式 | 手动 / 正序 / 倒序 |
| 排序优先级 | 多列排序时的优先级,0 最小 |
| 是否显示为超链接 | 列值是否渲染为可点击链接 |
| 链接类型 | 点击链接执行的动作类型 |
| 自动省略超长字符 | 超长内容是否省略 |
| 自动省略超过字符长度 | 触发省略的字符长度阈值 |
| 列最小宽度 | 该列的最小宽度(px) |
| 是否在推屏详情中隐藏 | 是否在推屏详情页隐藏该字段 |
| 启用自定义渲染 | 是否用自定义 HTML / JavaScript 渲染该列 |
| 渲染模式 | HTML 模式或 JavaScript 模式 |
| 导入时是否必填 | 数据导入时该列是否必填 |
| 自定义导入模板列名 | 覆盖导入模板中的默认列名 |
| 导入示例值 | 生成导入模板时的示例值 |
| 移动端占位符绑定 | 绑定到移动端页面模板的字段占位符位置(1–20) |
| 显示字段名称 | 是否在列中额外展示字段名称 |
| 切换页面或搜索时自动将该字段值拼接到 URL 参数中 | 是否把该字段值透传到 URL query |
| 自定义拼接的 URL 查询参数 key | 透传时使用的 query 参数名 |
搜索配置
控制该字段在搜索区的行为:
- 禁用用户搜索:开启后该字段不出现在搜索区。
- 是否默认展示在搜索区:开启后该字段默认作为可见搜索条件。
- 搜索方式:可选项与字段类型相关(详见下方「搜索方式与 字段类型」)。
- 搜索默认值:搜索条件预填值,支持内置动态值(如当前时间、当前用户、当前组织)。
列表区域配置
控制该列在表格中的展示与行为:
- 是否在列表中隐藏:隐藏列但仍保留其搜索能力。
- 是否启用排序:开启后可点击列头排序,并可设置排序方式与优先级;多列排序按
SortPriority从小到大应用。 - 是否显示为超链接:列值渲染为链接,链接类型 目前仅支持 执行事件流,需配置对应事件流。
- 自动省略超长字符:开启后超过阈值的内容自动省略,阈值默认 20。
- 列最小宽度:单独控制该列最小宽度,覆盖视图级设置。
详情配置
- 是否在推屏详情中隐藏:开启后该字段不出现在推屏详情页。
自定义渲染配置
开启 启用自定义渲染 后,该列不再按字段类型默认展示,而是使用自定义代码渲染:
| 渲染模式 | 说明 |
|---|---|
| HTML 模式 | 直接编写 HTML,用 {data.Fields.xxx.Text} 占位符插入行数据 |
| JavaScript 模式 | 编写 renderHtml(api, data) 函数返回 HTML 字符串 |
详细语法与示例见 列表行自定义渲染。
导入配置
用于生成数据导入模板:
- 导入时是否必填:导入校验时该列是否必填。
- 自定义导入模板列名:覆盖导入模板中的默认列名。
- 导入示例值:写入导入模板的示例数据。
移动端配置
- 移动端占位符绑定:将该列绑定到移动端页面模板的某个字段占位符(1–20),运行时该占位符渲染本列字段值,占位符上配置的「自定义元素样式」会透传到字段上。
- 显示字段名称:在移动端渲染时是否显示字段名称。
其他配置
- 切换页面或搜索时自动将该字段值拼接到 URL 参数中:开启后,页面跳转或搜索时把该列值拼入 URL query。
- 自定义拼接的 URL 查询 参数 key:指定透传时使用的 query 参数名。
下一步
- 列表行自定义渲染 - HTML / JavaScript 渲染语法
- 功能按钮 - 配置列表工具栏按钮
- 视图列表配置总览 - 分页、搜索默认值、数据源与导出
- 占位组件 - 字段占位符的样式配置与渲染规则
属性明细
以下内容面向技术实现与 AI 检索,逐个说明数据列表项 MetaViewListItem 的属性。
MetaViewListItem 属性表
| 属性名 | 类型 | 含义 | 取值/存储值 |
|---|---|---|---|
MetaFieldId | string | 字段 ID | 字段 FullId;Lookup 关联字段含 ~ |
Code | string | 字段编码 | 只读,等同字段 Code |
Name | string | 列显示名称 | 默认取字段名称,可修改 |
MetaFieldType | int | 字段类型 | 见 MetaFieldTypeEnum,如 2(文本)、3(日期时间)、9(数字)、10(货币数值)、30(人员选择)、32(组织选择)、35(数据源) |
ListIsHide | bool | 是否在列表中隐藏 | 默认 false |
Ellipsis | bool | 超长自动省略 | 默认 false |
EllipsisLength | int | 自动省略长度 | 默认 20,范围 1–1000 |
DisableUserSearch | bool | 禁止用户搜索 | 默认 false |
SearchDefaultDisplay | bool | 默认搜索是否显示 | 默认 false |
SearchType | string | 搜索方式 | eq/ne/ct/lt/lte/gt/gte/range,默认 eq |
SearchDefaultValue | string | 搜索默认值 | 支持内置动态值 |
SortEnable | bool | 排序启用 | 默认 false |
SortType | string | 默认排序方式 | ''(手动)、ascend(正序)、descend(倒序) |
SortPriority | int | 排序优先级 | 默认 0,范围 0–999 |
DetailIsHide | bool | 是否详情页隐藏 | 默认 false |
IsLink | bool | 是否链接 | 默认 false |
LinkType | string | 链接类型 | 目前为 ExecuteActionPipeline |
ActionPipeline | string | 事件流 | JSON 字符串 |
IsImportRequired | bool | 导入时是否必填 | 默认 false |
ImportExampleValue | string | 导入示例值 | 纯文本 |
CustomImportColumnName | string | 自定义导入模板列名 | 为空时用默认列名 |
MobilePlaceholderIndex | int? | 移动端占位符索引 | 字段占位符 1–20,未绑定为 null |
PassToQuery | bool | 是否透传到 URL query | 默认 false |
CustomPassToQueryKey | string | 自定义 query key | 纯文本 |
ColumnMinWidth | int? | 列最小宽度 | 0–999(px),未设置为 null |
DisplayFieldName | bool | 是否展示字段名称 | 默认 false |
EnableCustomRender | bool | 是否启用自定义渲染 | 默认 false |
CustomRenderMode | string | 自定义渲染模式 | HTML 或 JavaScript,默认 HTML |
CustomRenderScript | string | 自定义渲染脚本 | HTML 或 JavaScript 源码 |
Meta | Dictionary | 字段元数据 | 不存值,返回时动态附带 |
搜索方式与字段类型
可选搜索方式由 MetaFieldType 决定(前端 calculateSupportedSearchType):
| 字段类型 | 可用搜索方式 |
|---|---|
| 全部类型 | eq(等于)、ne(不等于) |
文本 2、人员选择 30、组织选择 32、数据源 35 | 追加 ct(模糊搜索) |
日期时间 3、数字 9、货币数值 10 | 追加 lt(小于)、lte(小于或等于)、gt(大于)、gte(大于或等于)、range(范围) |
存储示例
{
"MetaFieldId": "book-price",
"Code": "price",
"Name": "价格",
"MetaFieldType": 10,
"ListIsHide": false,
"Ellipsis": true,
"EllipsisLength": 20,
"DisableUserSearch": false,
"SearchDefaultDisplay": true,
"SearchType": "gte",
"SearchDefaultValue": "",
"SortEnable": true,
"SortType": "descend",
"SortPriority": 1,
"DetailIsHide": false,
"IsLink": false,
"LinkType": "ExecuteActionPipeline",
"ActionPipeline": "[]",
"IsImportRequired": true,
"ImportExampleValue": "99.00",
"CustomImportColumnName": "图书价格",
"MobilePlaceholderIndex": 2,
"PassToQuery": true,
"CustomPassToQueryKey": "price",
"ColumnMinWidth": 120,
"DisplayFieldName": false,
"EnableCustomRender": false,
"CustomRenderMode": "HTML",
"CustomRenderScript": ""
}