简体中文
通用参数
约 715 字大约 2 分钟
2025-12-16
对象列表Hook的functional回调会依次接收context和plugin两个参数。业务代码通常使用context;宿主会将当前事件的专属参数与以下通用能力合并到该对象中。
Hook函数入参
| 参数 | 说明 | 类型 |
|---|---|---|
| context | 列表插件上下文,包含事件专属参数和通用能力 | Object |
| plugin | 当前插件运行信息,业务逻辑通常不需要使用 | Object |
| context.bizApi | 列表业务操作方法 | Object |
| context.dataGetter | 列表数据读取方法 | Object |
| context.dataUpdater | 列表数据更新方法 | Object |
事件专属参数以对应事件文档为准。例如,list.previewImage.before会额外提供objectApiname、fieldName、data、trData、startIndex和field。
获取当前列表对象apiName时,请使用context.dataGetter.getOptions('apiname')。工具栏按钮callback(params)中的params.objectApiName仅属于按钮回调参数,不是Hook通用参数。
bizApi
filter(params)
追加插件筛选条件并触发列表重新查询。该方法依赖表格实例,应在表格初始化完成后调用,例如list.render.after或用户交互回调中。
| 参数 | 说明 | 类型 |
|---|---|---|
| params | 插件筛选参数 | Object |
| params.conditions | 筛选条件数组 | Object[] |
| conditions[].Comparison | 筛选操作符编号 | Number |
| conditions[].FieldName | 筛选字段apiName | String |
| conditions[].FilterValue | 筛选值 | Any |
返回void。context.filter(params)是context.bizApi.filter(params)的同功能别名。
refresh()
刷新当前列表和当前激活视图。无入参,返回void;详见refresh。
isCrossFilters()
判断当前列表是否处于跨对象筛选模式。无入参,返回Boolean。
dataGetter
getOptions(name)
读取当前列表实例中名为name的配置值。
| 参数 | 说明 | 类型 |
|---|---|---|
| name | 列表配置属性名 | String |
返回对应配置值,类型为Any。
getDescribe()
读取当前对象描述。无入参,返回Object;详见getDescribe。
getDescribeExt()
读取当前对象扩展描述。无入参,返回Object。请在对象描述加载完成后调用,例如list.render.after。
findIndex(name, value)
在当前页列表数据中查找第一个item[name] === value的行索引。
| 参数 | 说明 | 类型 |
|---|---|---|
| name | 用于匹配的行字段名 | String |
| value | 需要匹配的字段值 | Any |
返回Number。找到时返回当前页行索引,未找到或当前页没有数据时返回-1。
dataUpdater
dataUpdater中的方法依赖当前页表格数据,应在表格初始化完成后调用,并确保传入的rowId存在于当前页。
check(rowIds)
勾选当前页中rowId匹配的行。
| 参数 | 说明 | 类型 |
|---|---|---|
| rowIds | 需要勾选的行ID数组 | String[] |
返回void。
unCheck(rowIds)
取消勾选当前页中rowId匹配的行。
| 参数 | 说明 | 类型 |
|---|---|---|
| rowIds | 需要取消勾选的行ID数组 | String[] |
返回void。
updateData(rowId, data)
更新当前页中rowId匹配的行字段值。
| 参数 | 说明 | 类型 |
|---|---|---|
| rowId | 需要更新的行ID | String |
| data | 需要更新的字段值对象 | Object |
返回void。
