注意点

  • 脚本必须使用ES5以下的语法规则编写

表单（适用于主子表表单）

  1. // 使用对象
  2. dataForm
  4. // 获取表单信息
  5. getDataFormInfo()
  7. // 获取所有子表组件
  8. getAllSubTable()
  10. // 获取子表组件，subCode表示子表code
  11. getSubTable(subCode)
  13. /**
  14.  * 添加表单字段监听
  15.  * code: 表单字段code
  16.  * callback: 子表字段值改变的回调
  17.  */
  18. addFieldListening(code, callback)
  20. /**
  21.  * 添加子表监听
  22.  * code: 子表code
  23.  * callback: 回调
  24.  */
  25. addSubTableListening(code, callback)
  27. // 获取字段结构，code为表单字段code
  28. getDataItem(code)
  30. // 获取表单字段的值，code为表单字段code
  31. getDataItemValue(code)
  33. // 设置表单字段的值，code为表单字段code
  34. setDataItemValue(code, value)
  36. /**
  37.  * 获取业务规则结果
  38.  * rule: 规则字符串
  39.  * 返回值: Promise对象
  40.  */
  41. getBusinessRuleResult(rule)
  43. /**
  44.  * 添加按钮前置
  45.  * title: 按钮名称
  46.  * callback: 回调
  47.  */
  48. addButtonBefore(title, callback)
  50. /**
  51.  * 隐藏表单字段或子表列
  52.  * 当隐藏表单字段时，code为字段code
  53.  * 当隐藏子表列时，code为[子表code].[子表列code]
  54.  */
  55. hideComponentByCode(code, isHidden)
  57. // 隐藏显示表单按钮
  58. isHiddenButton(title, isHidden)
  60. // 刷新子表，subCode为子表code
  61. refreshSubTable(subCode)
  63. // 添加表单按钮加载完成的回调
  64. addformBtnLoadedListening(callback)
  66. // 关闭表单
  67. closeView()
  69. // 设置某个字段的附属属性
  70. setExtendAttributeByCode(code, key, value)
  72. /**
  73.  * 执行按钮动作（仅在铁四院质量分支可用）
  74.  */
  75. executeFormButtonAction(title)
  77. // 效验表单数据（仅在铁四院质量分支可用）
  78. validateData()

子表

  1. // 使用对象
  2. subTable
  4. // 添加子表加载完成的回调
  5. addLoadedCallback()
  7. /**
  8.  * 显示或隐藏操作按钮
  9.  * title: 按钮名称
  10.  * isHidden: 是否隐藏
  11.  */
  12. isHiddenButton(title, isHidden)
  14. /**
  15.  * 添加按钮前置
  16.  * title: 按钮名称
  17.  * callback: 回调
  18.  */
  19. addButtonBefore(title, callback)
  21. /**
  22.  * 添加按钮后置
  23.  * title: 按钮名称
  24.  * callback: 回调
  25.  */
  26. addButtonAfter(title, callback)
  28. /**
  29.  * 列表数据拷贝
  30.  * code: 拷贝的列
  31.  * targetCode: 赋值的列
  32.  */
  33. columnDataCopy(code, targetCode)

主表

  1. // 使用对象
  2. dataTable
  4. /**
  5.  * 添加按钮前置
  6.  * title: 按钮名称
  7.  * callback: 回调
  8.  */
  9. addButtonBefore(title, callback(datas, resolve))
  11. /**
  12.  * 添加按钮后置-仅支持'删除'按钮
  13.  * title: 按钮名称
  14.  * callback: 回调
  15.  */
  16. addButtonAfter(title, callback)
  18. /**
  19.  * 获取选中的数据
  20.  */
  21. getSelectedItems()
  23. /**
  24.  * 设置列表的高级搜索值
  25.  *    value,必须为一对象,key为组件code
  26.  *     如    {f_2b8984cbcd: '男','f_2b8984abcd':'一年级'}
  27.  *    数字控件:必须为一数字区间,例 :{f_3da0dd965a: [4,7]}
  28.  *    日期组件,CreatedTime,ModifiedTime,必须为一时间区间,例 : f_61834d2e76: ['2020-09-01 00:00:00','2020-10-01 23:59:59']     
  29.  *    下拉,多选,单选,必须为一数组        f_8d60829d65 :[{
  30.  *                                                    name: "选项2",
  31.  *                                                        selectionId: "选项2"
  32.  *                                                    },{
  33.  *                                                    name: "选项1",
  34.  *                                                    selectionId: "选项1"
  35.  *                                                }]
  36.  * 如果下拉关联其它数据源,则为:     f_8d60829d65:[{
  37.  *                                                name: "湖北",
  38.  *                                                   value: '01',
  39.  *                                                   },{
  40.  *                                                   name: "湖南",
  41.  *                                                   value: '02',
  42.  *                                               }],
  43.  *  如果为状态,则为一数组:'State':[{code: '0', name: '草稿'}]                             
  44.  *
  45.  *  isSearchImmediate 是否设置后立即刷新列表
  46.  */
  47. setSearchConditionValue(value,isSearchImmediate)

公共组件

  1. // 使用对象
  2. dataForm、subTable、dataTable
  4. /**
  5.  * element提供的公共组件
  6.  * 请参考element文档[https://element.eleme.cn/#/zh-CN/component/message-box]
  7.  */
  8. $message、$alert
  9. // message目前支持warning,error,info
  10. dataForm.$message({
  11.       type: "warning",
  12.       message: "保存失败",
  13.     });
  15. dataForm.$alert('保存失败，是否继续', '提示', {
  16.   confirmButtonText: '确定',
  17.   cancelButtonText: '取消',
  18.   showCancelButton: true
  19. }).then(function () {
  20.   // 确定回调
  21. }).catch(function () {
  22.   // 取消回调
  23. });
  25. // 是否是移动端
  26. dataForm.$isMobile

公共接口

网络请求

  1. dataForm.$axios.get('http://localhost:8080/user?ID=12345')
  2.   .then(function (response) {
  3.     // handle success
  4.     console.log(response);
  5.   })
  6.   .catch(function (error) {
  7.     // handle error
  8.     console.log(error);
  9.   });
  11. dataForm.$axios.post('http://localhost:8080/user', {
  12.     firstName: 'Fred',
  13.     lastName: 'Flintstone'
  14.   })
  15.   .then(function (response) {
  16.     console.log(response);
  17.   })
  18.   .catch(function (error) {
  19.     console.log(error);
  20.   });
  22. // response结构
  23. {
  24.   // 接口返回的数据
  25.   data: {},
  26.   // 来自服务器响应的HTTP状态码
  27.   status: 200,
  28. }

注意：禁止设置$axios.defaults.baseURL

  • $http: 基于axios的封装，用于平台的接口请求，例： ```javascript // 用户登录 dataForm.$http.GET(‘api/Organization/LoginByCode/‘ + code) .then(function (response) {
    1. if (response.Status !== 1) {
    2. dataForm.$message({
    3. type: "error",
    4. message: response.Message || '登录失败',
    });
    1.   return;
    2. }
    3. console.log('登录信息', response.Result);
    }).catch(function (error) {
    1.   console.log(error);
    });

// 获取表单信息 dataForm.$http.POST(‘api/Form/GetFormInfo’, parameters) .then(function (response) { if (response.Status !== 1) { dataForm.$message({ type: “error”, message: response.Message || ‘获取表单信息错误’, }); return; } console.log(‘表单信息’, response.Result); }).catch(function (error) { console.log(error); });

// response结构 { // 状态，1表示成功 Status: 1, // 数据 Result: {}, // 消息 Message: ‘’, }

  2. <a name="fHFZq"></a>
  3. ### 获取当前登录人信息
  5. ```javascript
  6. var userInfo = dataForm.$getUserInfo();
  7. console.log('当前登录人姓名：', userInfo.Name);
  8. console.log('当前登录人UserID：', userInfo.ObjectID);
  9. console.log('当前登录人Code：', userInfo.Code);
  10. console.log('当前登录人所在部门：', userInfo.ParentName);
  11. console.log('当前登录人所在部门ID：', userInfo.ParentID);

脚本占位符

脚本里的 ##keyName## 形式的字符串会被替换成全局配置字段keyName的内容。

  1. console.log('##RESTfulUrl##');
  3. dataForm.$axios('##RESTfulUrl##/api/getUserInfo').then(function(res) {
  4.   // do something
  5. });

实例

实例一：统计行编辑子表的某个字段为是的数据数量

  1. // 监听子表
  2. dataForm.addSubTableListening(subCode,
  3. function() {
  4.   var formInfo = dataForm.getDataFormInfo();
  5.     var subCode = '6457f7126e';
  7.   // 统计数据条数
  8.     var rule1 = "ExecuteSql(\"select count(*) from i_" + subCode + " where ParentObjectID='" + formInfo.dataId + "'\")";
  9.     dataForm.getBusinessRuleResult(rule1).then(function(res) {
  10.         if (!res.Success) return;
  11.       // 返回值必须经常两次JSON装换
  12.         var count = JSON.parse(JSON.parse(res.Result));
  13.         dataForm.setDataItemValue('f_3ce454dfce', count)
  14.     });
  16.   // 统计f_7ab2df8515值为1的数据条数
  17.     var rule2 = "ExecuteSql(\"select count(*) from i_" + subCode + " where ParentObjectID='" + formInfo.dataId + "' and f_7ab2df8515='1'\")";
  18.     dataForm.getBusinessRuleResult(rule2).then(function(res) {
  19.         if (!res.Success) return;
  20.     // 返回值必须经常两次JSON装换
  21.         var count = JSON.parse(JSON.parse(res.Result));
  22.         dataForm.setDataItemValue('f_3a72b3ba7a', count)
  23.     });
  25.   // 统计f_9c767352a2的合计
  26.     var rule3 = "ExecuteSql(\"select sum(f_9c767352a2) from i_" + subCode + " where ParentObjectID='" + formInfo.dataId + "'\")";
  27.     dataForm.getBusinessRuleResult(rule3).then(function(res) {
  28.         if (!res.Success) return;
  29.     // 返回值必须经常两次JSON装换
  30.         var count = JSON.parse(JSON.parse(res.Result));
  31.         dataForm.setDataItemValue('f_77f3b062f8', count)
  32.     })
  33. });

image.png

实例二：在特定节点监听选人控件赋值

  1. // 获取表单信息
  2. var formInfo = dataForm.getDataFormInfo();
  4. // 判断当前表单是审批节点且不是查看模式
  5. if (formInfo.formExtensionInfo.CurrentActivityName === '审批' && formInfo.formViewType !== 'view') {
  6.   // 回调
  7.   var callback = function callback() {
  8.     var rule = 'ExecuteSQLForObject("select name,code from t_user where ObjectID=\'{0}\'",{f_d48c24dac2_Id})';
  10.     // 获取业务规则结果
  11.     dataForm.getBusinessRuleResult(rule).then(function (res) {
  12.       if (!res.Success) return;
  14.       // 业务规则返回的是字符串，需要装换成自己需要的结构，比如字典或者数组
  15.       var obj = JSON.parse(res.Result);
  17.       // 设置表单字段的值
  18.       dataForm.setDataItemValue('f_aa4c70edad', obj.name);
  19.       dataForm.setDataItemValue('f_539d6ad0be', obj.code);
  20.     });
  21.   };
  23.   // 获取人员控件是否有值，如果有值手动调用回调
  24.   var value = dataForm.getDataItemValue('f_d48c24dac2');
  26.   if (typeof value === 'string' && value.length > 0) {
  27.     callback();
  28.   }
  30.   // 监听人员控件
  31.   dataForm.addFieldListening('f_d48c24dac2', callback);
  32. }

image.png

实例三：主表字段控制子表按钮

  1. // 获取子表组件
  2. var table1 = dataForm.getSubTable('8fb1958f70');
  3. var table2 = dataForm.getSubTable('6e22eaa41f');
  4. var table3 = dataForm.getSubTable('195e075ebc');
  6. // 添加主表字段监听
  7. dataForm.addFieldListening('f_2b0901480f', function (val) {
  8.   // 隐藏子表按钮
  9.   table1.isHiddenButton('新建', val === '1');
  10.   table2.isHiddenButton('新建', val === '1');
  11.   table2.isHiddenButton('插入', val === '1');
  12.   table3.isHiddenButton('新建', val === '1');
  13.   table1.isHiddenButton('百度', val === '2');
  14.   table2.isHiddenButton('谷歌', val === '2');
  15. });
  17. // 添加主表字段监听
  18. dataForm.addFieldListening('f_09607846f4', function (val) {
  19.   // 隐藏子表按钮
  20.   table1.isHiddenButton('查看', val === '1');
  21.   table3.isHiddenButton('查看', val === '1');
  22.   table1.isHiddenButton('编辑', val === '2');
  23.   table3.isHiddenButton('编辑', val === '2');
  24.   table1.isHiddenButton('删除', val === '3');
  25.   table2.isHiddenButton('删除', val === '3');
  26.   table3.isHiddenButton('删除', val === '3');
  27. });

实例四：表单提交效验字段是否填值

  1. // 添加保存按钮前置
  2. dataForm.addButtonBefore('保存', function (resolve) {
  3.   // 获取表单字段的值
  4.   var value = dataForm.getDataItemValue('f_e60d3a48cd');
  5.   // 判断值是否为空
  6.   if (typeof value !== 'string' || value.length <= 0) {
  7.     // 弹出提示 目前message的type只支持error,warning,info
  8.     dataForm.$message({
  9.       type: "error",
  10.       message: "字段a不能为空",
  11.     });
  12.   } else {
  13.     // 不为空，继续后面的处理
  14.     resolve();
  15.   }
  16. });

实例五：子表删除按钮的前置和后置处理

  1. var subTable1 = dataForm.getSubTable('83be1068e6');
  2. // 添加删除按钮前置处理，同步处理，必须手动调用resolve才能让删除继续
  3. subTable1.addButtonBefore('删除', function (data, resolve) {
  4.   // data为key-value的格式
  5.   console.log('subTable1 delete before: ', data['f_123afsb2']);
  6.   setTimeout(function () {
  7.     resolve();
  8.   }, 1000);
  9. });
  10. // 添加删除按钮后置处理，异步处理，不会等待回调处理
  11. subTable1.addButtonAfter('删除', function (data) {
  12.   // data为key-value的格式
  13.   console.log('subTable1 delete after: ', data['f_123afsb2']);
  14. });

实例六：隐藏表单字段和子表列

  1. // 添加字段监听
  2. dataForm.addFieldListening('f_57b8661128',
  3. function(val) {
  4.   // 当监听的字段的值为1和3时隐藏字段`f_33aa1a4410`
  5.     dataForm.hideComponentByCode('f_33aa1a4410', val === '1' || val === '3');
  6.   // 当监听的字段的值为2和3时隐藏字段`f_5968a4e8c7`
  7.     dataForm.hideComponentByCode('f_5968a4e8c7', val === '2' || val === '3');
  8.   // 当监听的字段的值为1和3时隐藏子表`9411739038`的`f_33aa1a4410`列
  9.     dataForm.hideComponentByCode('9411739038.f_28cbf99d7e', val === '1' || val === '3');
  10.   // 当监听的字段的值为2和3时隐藏子表`9411739038`的`f_5968a4e8c7`列
  11.     dataForm.hideComponentByCode('9411739038.f_8b4bb9ea39', val === '2' || val === '3')
  12. });

实例七：隐藏表单按钮

  1. var callback = function callback() {
  2.   // 获取字段 f_81f0821c4e 的值
  3.     var value = dataForm.getDataItemValue('f_81f0821c4e');
  4.   // 隐藏按钮
  5.     dataForm.isHiddenButton('保存', value === '1');
  6.     dataForm.isHiddenButton('百度', value === '2');
  7. };
  8. // 添加表单按钮加载完成的回调
  9. dataForm.addformBtnLoadedListening(callback);
  10. // 添加字段 f_81f0821c4e 的监听
  11. dataForm.addFieldListening('f_81f0821c4e', callback);

实例八：移动端在某个流程节点下只能查看不能审批或编辑

  1. // 获取表单信息
  2. var formInfo = dataForm.getDataFormInfo();
  3. // 获取表单状态，新增、查看、编辑
  4. var formViewType = formInfo.formViewType;
  5. // 获取当前流程节点
  6. var activityName = formInfo.formExtensionInfo.CurrentActivityName;
  7. // 判断是否是移动端，表单的流程节点是审批且不是查看模式
  8. if (dataForm.$isMobile && activityName == '审批' && formViewType !== 'view') {
  9.   // 提示
  10.   dataForm.$alert('此流程无法在移动端上处理，请使用PC端处理',{
  11.     callback:function callback(){
  12.       // 关闭表单
  13.       dataForm.closeView();
  14.     }
  15.   });
  16. }

实例九：根据某个字段的值设置数据范围的组是否显示

  1. // 设置阅读范围控件的属性的方法
  2. var setReadRangeGroup = function setReadRangeGroup(value) {
  3.     if (value === '是') {
  4.     // 设置数据范围的组显示
  5.         dataForm.setExtendAttributeByCode('ReadRange', 'isReadRangeGroup', true);
  6.     // 设置扩展的部门范围
  7.         dataForm.setExtendAttributeByCode('ReadRange', 'extendScopeUnitIds', ['68901fc4-eaeb-4d60-9944-2f5b2be6e690', '374f3843-e91c-4621-92ab-b915a0014907']);
  8.     // 设置扩展的组织类型
  9.         dataForm.setExtendAttributeByCode('ReadRange', 'extendCategories', ['bu', 'ke'])
  10.     } else if (value === '否') {
  11.     // 设置数据范围的组不显示
  12.         dataForm.setExtendAttributeByCode('ReadRange', 'isReadRangeGroup', false);
  13.     // 清空扩展的部门范围
  14.         dataForm.setExtendAttributeByCode('ReadRange', 'extendScopeUnitIds', null);
  15.     // 清空扩展的组织类型
  16.         dataForm.setExtendAttributeByCode('ReadRange', 'extendCategories', null)
  17.     }
  18. };
  19. // 获取字段的值
  20. var value = dataForm.getDataItemValue('f_0862164c8e');
  21. // 根据字段的值设置阅读范围的组
  22. setReadRangeGroup(value);
  23. // 监听字段的值
  24. dataForm.addFieldListening('f_0862164c8e', setReadRangeGroup);

实例十：主列表按钮前置验证及传值

  1. // 控制非完成状态的行数据无法启动
  3. /**
  4. * datas:列表选中的行数据
  5. * resolve:回调函数
  6. */
  7. dataTable.addButtonBefore('启动', function (datas,resolve) {
  8.   // 判断某值是否符合要求
  9.   if (datas[0]["f_f585b8afa7"]!=='已完成') {
  10.     // 弹出提示 目前message的type只支持error,warning,info
  11.     dataTable.$message({
  12.       type: "warning",
  13.       message: "非完成状态无法启动",
  14.     });
  15.   } else {
  16.     // 继续后面的处理
  17.     resolve();  
  18.   }
  19. });

实例十一：子表行编辑模式保存前置验证及传值

  1. // 验证机构代码是否可用
  3. var subTable1 = dataForm.getSubTable('68dc4a6640');
  4. //行编辑模式：保存前置
  5. subTable1.addButtonBefore('保存', function(data, resolve) {
  6.     // data为key-value的格式
  7.     const bh = data['f_b954f24e4c']
  8.     if (bh === '010') {
  9.         subTable1.$message({
  10.             type: "warning",
  11.             message: "该机构代码不可用!",
  12.         });
  13.         resolve(false); // 验证不通过，返回false
  14.     } else {
  15.         resolve(true); // 验证通过，返回true。或写：resolve()
  16.     }
  17. });

实例十二：获取字段权限

  1. var dataItem = dataForm.getDataItem('f_b954f24e4c');
  2. console.log('isView, isMust, isEdit: ', dataItem.isView, dataItem.isMust, dataItem.isEdit);

实例十三：字段赋值

  1. // 单行文本、多行文本赋值
  2. dataForm.setDataItemValue('f_xxx', 'xxx');
  4. // 选人、选部门、多选控件赋值
  5. dataForm.setDataItemValue('f_xxx', [{
  6.   Name: '张三',
  7.   ObjectID: 'xxxx-xxxx'
  8. }]);

实例十四：执行表单按钮动作（仅在铁四院质量分支可用）

  1. // 执行提交按钮的动作
  2. dataForm.executeFormButtonAction('提交').then(function(resolve) {
  3.     // 提交成功的回调
  4.     ...
  5.     // 直接调用会完成平台的后续操作
  6.     resolve();
  7. });

实例十五：效验表单数据（仅在铁四院质量分支可用）

  1. dataForm.validateData().then(function(result) {
  2.   // result为true时，表示效验通过
  3. });