列表API

列表前端代码编辑器如下图所示。

列表按钮事件

请求后端服务前，前端可通过该方法执行判断逻辑。例如验证用户是否已选择数据或数据是否符合预期要求，若不符合预期可通过 return false 阻止向后端发起请求。

$.ListView.ActionPreDo = function(actionCode //按钮编码
                                 ){
  if(actionCode == "xxx"){
    //处理特定按钮的逻辑
  }
  return false;//阻止提交
};

获取选中的记录

在 列表设计 页面启用 批量操作 功能后，用户可在列表页面选择部分数据执行操作。通过此接口可获取用户当前选中的数据。

$.ListView.GetSelected();

返回结果为完整数据数组，需通过字段获取所需信息。人员及部门字段将拆分为三个独立字段：

• Id 标识字段（如 CreatedBy）
• 姓名字段（如 CreatedBy_Name）
• 原始对象字段（如 CreatedBy_Original）

示例数据结构如下：

[
  {
    "ObjectId": "63d9fb6a-109d-45a4-84b5-31d68fc57526",
    "Name": "2025-08-27 12:10:53",
    "CreatedBy": "18f923a7-5a5e-426d-94ae-a55ad1a4b239",
    "CreatedBy_Name": [
        "System"
    ],
    "CreatedBy_Original": [
        {
            "Id": "18f923a7-5a5e-426d-94ae-a55ad1a4b239",
            "Name": "System",
            "Avatar": null,
            "EntryId": "System",
            "UnitType": 4
        }
    ],
    "OwnerId": "18f923a7-5a5e-426d-94ae-a55ad1a4b239",
    "OwnerId_Name": [
        "System"
    ],
    "OwnerId_Original": [
        {
            "Id": "18f923a7-5a5e-426d-94ae-a55ad1a4b239",
            "Name": "System",
            "Avatar": null,
            "EntryId": "System",
            "UnitType": 4
        }
    ],
    "OwnerDeptId": "18f923a7-5a5e-426d-94ae-a55ad1a4b240",
    "OwnerDeptId_Name": [
        "氚云检测（Master）V1"
    ],
    "OwnerDeptId_Original": [
        {
            "Id": "18f923a7-5a5e-426d-94ae-a55ad1a4b240",
            "Name": "氚云检测（Master）V1",
            "Avatar": null,
            "EntryId": "1",
            "UnitType": 1
        }
    ],
    "CreatedTime": "2025-08-27 12:10:53",
    "ModifiedBy": "",
    "ModifiedBy_Name": [],
    "ModifiedBy_Original": [],
    "ModifiedTime": "2025-08-27 12:10:53",
    "WorkflowInstanceId": "",
    "Status": "",
    "F0000001": "2025-08-27 12:10:53",
    "F0000003": "",
    "Summary": ""
}
]

刷新列表

当后台服务执行导致数据变更，或需要在不刷新浏览器页面的情况下更新数据时，可调用此接口刷新列表数据。

$.ListView.RefreshView();

执行后端请求

前端调用后端自定义接口执行逻辑并返回数据，返回数据可用作判断依据或填充至界面控件。

后端逻辑需在 OnSubmit 方法中实现，通过 $.ListView.Post 执行调用：

// 接口定义
$.ListView.Post(actionName, //提交的ActionName
                data,       //提交至后台的数据
                callBack,   //回调函数
                errorBack,  //错误回调函数
                async);     //是否异步（默认同步）

// 调用示例
$.ListView.Post("GetName",
  {"param1":"value1"}, 
  function(data){
      console.log(data); //后端返回的数据
      $.ListView.RefreshView(); //需要刷新列表时执行
  },
  function(errorData){
    console.log(errorData);
  },
  true);