weaver-e10-builder 1.6.13 → 1.6.14

package/skill-docs/references/ebuilder-designer/page-source/sdk-form.md

@@ -0,0 +1,255 @@
+# 表单相关
+
+这里操作的是页面内的表单/中间表组件。targetComId/comId 是页面组件 ID，不是表单 JSSDK field 标识。表单相关示例使用 formLoad_<中间表组件ID>。多选赋值调用 setFormFieldVal，读取调用 getFormFieldVal。getFormFieldAttr/setFormFieldAttr 的码表仅用于本接口：1 只读、2 可编辑、3 必填、4 隐藏，不套用其他字段入口码表。getFormDataDetail 的返回结构未提供定义，不据此构造字段解析或保存报文。
+
+查询本类接口：`e10-cli designer source sdk --query <方法名>`。
+
+## 接口目录
+
+- `pageSdk.getFormFieldVal();`：使用此接口可以取表单组件值
+- `pageSdk.setFormFieldVal();`：使用此接口可以给表单组件赋值
+- `pageSdk.computedFormFields();`：使用此接口可以针对表单字段进行动态计算赋值
+- `pageSdk.getFormDataDetail();`：使用此接口可以取中间表数据
+- `pageSdk.getFormFieldAttr();`：获取表单字段读写属性
+- `pageSdk.setFormFieldAttr();`：设置表单字段读写属性
+
+## pageSdk.getFormFieldVal();
+
+使用此接口可以取表单组件值
+
+### 参数说明
+| 参数     | 类型     | 必需 | 说明                                                                   |
+| -------- | -------- | ---- | ---------------------------------------------------------------------- |
+| targetComId     | string   | `是` | 进行取值的目标组件id                                                             |
+### 返回值
+无
+### 示例
+```javascript
+  /* 表单字段取值，组件ID_1为中间表组件的id */
+  pageSdk.on("formLoad_组件ID_1", () => {
+  /**
+   * 单行文本、多行文本取值
+   * 组件ID_2为单行文本、多行文本字段组件id
+   * 返回值示例：'表单字段内容'
+   */
+  pageSdk.getFormFieldVal("组件ID_3");
+  /**
+   * 单选框、下拉单选框取值
+   * 组件ID_4为单选框、下拉单选框字段组件id
+   * optionId：选项id，content: 选项名称
+   * 返回值示例：{ dataOptions: [{ optionId: "资源ID_5"，content: "SME" }] }
+   */
+  pageSdk.getFormFieldVal("组件ID_4");
+  /**
+   * 复选框、下拉复选框取值
+   * 组件ID_6为复选框、下拉复选框字段组件id
+   * optionId：选项id，content: 选项名称
+   * 返回值示例：{ dataOptions: [{ optionId: "资源ID_7"，content: "等待确认" }, { optionId: "资源ID_8", content: "客户方先盖章" }] }
+   */
+  pageSdk.getFormFieldVal("组件ID_6");
+
+    /**
+   * 级联取值
+   * 组件ID_9
+   * optionId：选项id（一级下拉选项id,二级下拉选项id），content: 选项名称
+   * 返回值示例：{ dataOptions: [{ optionId: "资源ID_10,资源ID_11", content: "春天/春天-1" }] }
+   */
+  pageSdk.getFormFieldVal("组件ID_9");
+  /**
+   * 浏览框取值
+   * 组件ID_12为浏览框字段组件id
+   * optionId: 浏览框选项id，content: 选择浏览框内容名称，optionObj：浏览框选项信息
+   * 返回值示例：{ dataOptions: [{ optionId: "资源ID_13", content: "小乔1", optionObj: {} }] }
+   */
+  pageSdk.getFormFieldVal("组件ID_12");
+  /**
+   * 地理位置取值
+   * 组件ID_14为地理位置字段组件id
+   * latitude: 经度，longitude：维度， content：地理位置名称
+   * 返回值示例：{ latitude: 31.088258497675437, longitude: 121.52702555658827, content: "泛微软件园" }
+   */
+  pageSdk.getFormFieldVal("组件ID_14");
+  /**
+   * 图片附件、附件取值
+   * 组件ID_15为图片附件、附件字段组件id
+   * optionId: 图片附件文件id，type: 附件类型，content: 附件名称，optionObj：附件信息
+   * 返回值示例：{ dataOptions: [{ optionId: "资源ID_16", type: "image", content: "图片名称", optionObj: { fileid: "资源ID_16", name: '图片名称', size: 399675, type: "image/png", loadlink: '' } }]}
+   */
+  pageSdk.getFormFieldVal("组件ID_15");
+});
+```
+
+## pageSdk.setFormFieldVal();
+
+使用此接口可以给表单组件赋值
+
+### 参数说明
+| 参数     | 类型     | 必需 | 说明                                                                   |
+| -------- | -------- | ---- | ---------------------------------------------------------------------- |
+| targetComId     | string   | `是` | 进行赋值的目标组件id                                                             |
+| value | any | `是` | 进行赋值的值 |
+### 返回值
+无
+### 示例
+```javascript
+  /* 组件ID_1为中间表组件的id */
+/* 表单字段赋值，组件ID_1为中间表组件的id */
+  pageSdk.on("formLoad_组件ID_1", () => {
+  /**
+   * 单行文本、多行文本赋值
+   * 组件ID_2为单行文本、多行文本字段组件id
+   * 单行文本：单行文本、多行文本字段内容
+   */
+  pageSdk.setFormFieldVal("组件ID_3", "单行文本内容");
+  /**
+   * 单选框、下拉单选框赋值
+   * 组件ID_4为单选框、下拉单选框字段组件id
+   * optionId：选项id
+   * 赋值参数：{ dataOptions: [{ optionId: "资源ID_5" }] }
+   */
+  pageSdk.setFormFieldVal("组件ID_4", {
+    dataOptions: [{ optionId: "资源ID_5" }],
+  });
+  /**
+   * 复选框、下拉复选框赋值
+   * 组件ID_6为复选框、下拉复选框字段组件id
+   * optionId：选项id
+   * 赋值参数：{ dataOptions: [{ optionId: "资源ID_7" }, { optionId: "资源ID_8" }] }
+   */
+  pageSdk.setFormFieldVal("组件ID_6", {
+    dataOptions: [
+      { optionId: "资源ID_7" },
+      { optionId: "资源ID_8" },
+    ],
+  });
+
+    /**
+   * 级联赋值
+   * 组件ID_9
+   * optionId：选项id（一级下拉选项id,二级下拉选项id），content: 选项名称
+   * 赋值参数：{ dataOptions: [{ optionId: "资源ID_10,资源ID_11", content: "春天/春天-1" }] }
+   */
+  pageSdk.setFormFieldVal("组件ID_9", { dataOptions: [{ optionId: "资源ID_10,资源ID_11"}] });
+  /**
+   * 浏览框赋值
+   * 组件ID_12为浏览框字段组件id
+   * optionId: 浏览框选项id，content: 选择浏览框内容名称
+   * 赋值参数：{ dataOptions: [{ optionId: "资源ID_13", content: '小乔1' }] }
+   */
+  pageSdk.setFormFieldVal("组件ID_12", {
+    dataOptions: [{ optionId: "资源ID_13", content: "小乔1" }],
+  });
+  /**
+   * 地理位置取值
+   * 组件ID_14为地理位置字段组件id
+   * latitude: 维度，longitude：经度， content：地理位置名称
+   * 赋值参数：{ latitude: 31.088258497675437, longitude: 121.52702555658827, content: "泛微软件园" }
+   */
+  pageSdk.setFormFieldVal("组件ID_14", {
+    latitude: 31.088258497675437,
+    longitude: 121.52702555658827,
+  });
+});
+```
+
+## pageSdk.computedFormFields();
+
+使用此接口可以针对表单字段进行动态计算赋值
+
+### 参数说明
+
+| 参数     | 类型     | 必需 | 说明                                                                   |
+| -------- | -------- | ---- | ---------------------------------------------------------------------- |
+| targetComId     | string   | `是` | 进行赋值的目标组件id                                                             |
+| expression | string | `是` | 进行动态取值赋值的表达式 |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+/* 组件ID_1为中间表组件的id */
+pageSdk.on("formLoad_组件ID_1", () => {
+  /* 字段计算 */
+ pageSdk.computedFormFields("组件ID_17", "{组件ID_18} + {组件ID_19}");
+ /* 日期函数 */
+ pageSdk.computedFormFields("组件ID_20", "dateDiff({组件ID_21}, {组件ID_22})")
+ /* 明细表计算子组件合计值 */
+ pageSdk.computedFormFields("组件ID_23", "calculateColSum({组件ID_24})");
+});
+```
+
+
+## pageSdk.getFormDataDetail();
+
+使用此接口可以取中间表数据
+
+### 参数说明
+
+| 参数     | 类型     | 必需 | 说明                                                                   |
+| -------- | -------- | ---- | ---------------------------------------------------------------------- |
+| formId     | string   | `是` | 中间表组件id                                                             |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+/* 组件ID_1为中间表组件的id */
+pageSdk.on('formLoad_组件ID_1', () => {
+  /* 取中间表数据 */
+  pageSdk.getFormDataDetail('组件ID_1');
+});
+```
+
+## pageSdk.getFormFieldAttr();
+
+获取表单字段读写属性
+
+### 参数说明
+
+| 参数    | 类型   | 必需 | 说明         |
+| ------- | ------ | ---- | ------------ |
+| comId | string | `是` |  `表单组件id` |
+ ##### 返回值
+
+字段读写属性值，1：只读，2：可编辑，3：必填，4: 隐藏
+
+### 示例
+
+```javascript
+ /* 获取表单字段读写属性，组件ID_1为中间表组件的id */
+pageSdk.on("formLoad_组件ID_1", () => {
+  /** 获取表单字段读写属性 **/
+  pageSdk.getFormFieldAttr('组件ID_25');
+ });
+```
+
+## pageSdk.setFormFieldAttr();
+
+设置表单字段读写属性
+
+### 参数说明
+
+| 参数    | 类型   | 必需 | 说明         |
+| ------- | ------ | ---- | ------------ |
+| comId | string | `是` |  `表单组件id` |
+ | viewAttr | number | `是` |  `字段读写属性值，1：只读，2：可编辑，3：必填，4: 隐藏` |
+
+ ##### 返回值
+
+无
+
+### 示例
+
+```javascript
+ /* 设置表单字段读写属性，组件ID_1为中间表组件的id */
+pageSdk.on("formLoad_组件ID_1", () => {
+  /** 设置表单字段读写属性 **/
+  pageSdk.setFormFieldAttr('组件ID_25', 1);
+ });
+```

package/skill-docs/references/ebuilder-designer/page-source/sdk-foundations.md

@@ -0,0 +1,401 @@
+# 基础
+
+源码执行时提供 ebSdk、pageSdk，不需要在同一作用域重复声明。SDK 获取示例用于说明独立脚本或指定页面的获取方式。pageLoad 在页面及组件异步渲染完成后触发；compLoad 包含组件内部异步数据查询完成。getDataSet 使用回调，不能当同步取值。asyncFn 仅用于事件动作 JavaScript。getExports 用于访问源码 export 导出的成员。本文未定义 off/unsubscribe/销毁事件，不根据方法名猜测清理接口。
+
+查询本类接口：`e10-cli designer source sdk --query <方法名>`。
+
+## 接口目录
+
+- `ebSdk.request();`：使用此接口可以发送ajax请求
+- `ebSdk、pageSdk`：获取当前页面sdk
+- `pageSdk.getPageId();`：使用此接口可以获取当前页面id
+- `pageSdk.getBelongAppId();`：使用此接口可以获取当前页面所属应用id
+- `ebSdk.getCurrUser();`：使用此接口可以获取当前用户信息
+- `pageSdk.getAllParameter();`：使用此接口可以获取当前页面所有参数对象
+- `pageSdk.getParameter();`：使用此接口可以获取页面参数
+- `pageSdk.getVariable();`：使用此接口可以通过变量标识获取变量中存放的数据信息
+- `pageSdk.setVariable();`：使用此接口可以通过变量标识更新变量中的数据信息
+- `pageSdk.getDataSet();`：使用此接口可以通过数据集名称获取数据集中存放的数据信息
+- `pageSdk.on();`：使用此接口可以在页面或指定组件上绑定事件, 并在触发该事件时执行回调函数
+- `pageSdk.getCompInstance();`：使用此接口可以获取页面上指定组件的实例
+- `compInstance.show/hide/toggle();`：使用此接口可以显示/隐藏对应的组件
+- `pageSdk.getExports();`：使用此接口可以获取页面源码中导出的内容(多用于组件配置时调用源码中的方法)
+- `asyncFn();`：异步执行函数
+
+## ebSdk.request();
+
+使用此接口可以发送ajax请求
+
+### 参数说明
+
+| 参数    | 类型   | 必需 | 说明         |
+| ------- | ------ | ---- | ------------ |
+| options | object | `是` | 请求参数对象 |
+
+### 返回值
+
+返回可使用 then/catch 的请求结果，具体业务数据结构由目标接口定义。
+
+### 示例
+
+```javascript
+ebSdk.request({
+  method: 'post',
+  url: '/user/12345',
+  data: {
+    firstName: 'Fred',
+    lastName: 'Flintstone',
+  },
+}).then((data) => {
+  // 请求成功回调，data：接口请求成功返回的结果
+  console.log(data)
+}).catch((error) => {
+  // 请求失败回调，error: 接口请求失败返回的信息
+})
+```
+
+## ebSdk、pageSdk
+
+获取当前页面sdk
+
+### 参数说明
+无
+
+### 返回值
+
+当前页面SDK
+
+### 示例
+```javascript
+const ebSdk = window.ebuilderSDK;  //全局SDK
+const pageSdk = ebSdk.getPageSDK();  //当前页面SDK
+const targetPageSdk = ebSdk.getPageSDK(pageId);  //当浏览器页面存在多个eb页面时，需要获取特定页面SDK，需要传 pageId 参数
+```
+
+
+## pageSdk.getPageId();
+
+使用此接口可以获取当前页面id
+
+### 参数说明
+
+无
+
+### 返回值
+
+当前页面id
+
+### 示例
+
+```javascript
+const pageId = pageSdk.getPageId(); //获取当前页面id
+console.log(pageId);
+```
+
+
+## pageSdk.getBelongAppId();
+
+使用此接口可以获取当前页面所属应用id
+
+### 参数说明
+
+无
+
+### 返回值
+
+当前页面所属应用id
+
+### 示例
+
+```javascript
+const appId = pageSdk.getBelongAppId(); //获取当前页面所属应用id
+console.log(appId);
+```
+
+
+## ebSdk.getCurrUser();
+
+使用此接口可以获取当前用户信息
+
+### 参数说明
+
+无
+
+### 返回值
+
+当前用户的对象信息
+
+### 示例
+
+```javascript
+var user = ebSdk.getCurrUser(); //获取当前用户对象
+user.id; //用户id
+user.username; //用户姓名
+//......
+```
+
+
+## pageSdk.getAllParameter();
+
+使用此接口可以获取当前页面所有参数对象
+
+### 参数说明
+
+无
+
+### 返回值
+
+当前页面所有参数对象
+
+### 示例
+
+```javascript
+const params = pageSdk.getAllParameter(); //获取当前页面所有参数对象
+console.log(params);
+```
+
+
+## pageSdk.getParameter();
+
+使用此接口可以获取页面参数
+
+### 参数说明
+
+| 参数 | 类型   | 必需 | 说明     |
+| ---- | ------ | ---- | -------- |
+| name | string | `是` | 参数名称 |
+
+### 返回值
+
+参数值，如果根据参数名称未获取到参数值则会返回空字符串
+
+### 示例
+
+```javascript
+/* 例如跳转到当前页面时有传递名称为projectId的参数，假设值为资源ID_1 */
+var projectId = pageSdk.getParameter('projectId');
+console.log(projectId); //资源ID_1
+```
+
+
+## pageSdk.getVariable();
+
+使用此接口可以通过变量标识获取变量中存放的数据信息
+
+### 参数说明
+
+| 参数     | 类型     | 必需 | 说明                                                                   |
+| -------- | -------- | ---- | ---------------------------------------------------------------------- |
+| varKey     | string   | ``是`` | 变量标识                                                             |
+
+### 返回值
+
+变量的默认值
+
+### 示例
+
+```javascript
+/* 假定页面中有标识为pageVar_mobile的变量 */
+const variableVal = pageSdk.getVariable('pageVar_mobile');
+console.log(variableVal); // '15188888888'
+```
+
+## pageSdk.setVariable();
+
+使用此接口可以通过变量标识更新变量中的数据信息
+
+### 参数说明
+
+| 参数     | 类型     | 必需 | 说明                                                                   |
+| -------- | -------- | ---- | ---------------------------------------------------------------------- |
+| varKey     | string   | ``是`` | 变量标识                                                             |
+| varInfo | object | ``是`` | 变量信息 |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+/* 假定页面中有标识为pageVar_mobile的变量 */
+pageSdk.setVariable('pageVar_mobile', { varType: 'Number', varDesc: '当前用户电话号码', defVal: 15188888888 });
+```
+
+## pageSdk.getDataSet();
+
+使用此接口可以通过数据集名称获取数据集中存放的数据信息
+
+### 参数说明
+
+| 参数     | 类型     | 必需 | 说明                                                                   |
+| -------- | -------- | ---- | ---------------------------------------------------------------------- |
+| name     | string   | `是` | 数据集名称                                                             |
+| callback | function | `是` | 回调函数，因为数据集信息为页面运行时异步加载所以需要通过回调函数来获取 |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+/*假定页面中有定义名称为prjData的数据集*/
+pageSdk.getDataSet('prjData', function (data) {
+  data.id; /*使用 data.字段名称 去获取字段值*/
+  data.name;
+  data['资源ID_2'];/*获取字段id为资源ID_2的数据*/
+});
+```
+
+
+## pageSdk.on();
+
+使用此接口可以在页面或指定组件上绑定事件, 并在触发该事件时执行回调函数
+
+### 参数说明
+
+| 参数      | 类型     | 必需 | 说明                                     |
+| --------- | -------- | ---- | ---------------------------------------- |
+| eventName | string   | `是` | 事件名称，具体支持的事件名称请见下方表格 |
+| compId    | string   | `否` | 组件 id                                  |
+| callback  | function | `是` | 触发该事件时执行的回调函数               |
+
+---
+
+| 事件名称 | 说明                                                 |
+| -------- | ---------------------------------------------------- |
+| pageLoad | 页面加载完成(含所有组件异步渲染完成)                 |
+| compBeforeMount | 组件加载前(组件异步渲染之前的回调) |
+| compLoad | 组件加载完成(含组件内异步查询数据完成，比如列表组件) |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+/*绑定页面加载事件*/
+pageSdk.on('pageLoad', function () {
+  console.log('页面加载完成');
+});
+
+/*绑定组件加载前的事件*/
+pageSdk.on("compBeforeMount", "组件ID_3", function(comp) {
+    console.log("指定的组件加载前回调，组件实例为：" + comp);
+});
+
+/*绑定组件加载事件*/
+pageSdk.on("compLoad", "组件ID_3", function(comp) {
+    console.log("指定的组件加载完成后回调，组件实例为：" + comp);
+});
+```
+
+## pageSdk.getCompInstance();
+
+使用此接口可以获取页面上指定组件的实例
+
+### 参数说明
+
+| 参数      | 类型     | 必需 | 说明                                     |
+| --------- | -------- | ---- | ---------------------------------------- |
+| compId | string   | `是` | 组件 id |
+
+### 返回值
+
+组件实例
+
+### 示例
+
+```javascript
+/*获取id为组件ID_3的组件的实例对象*/
+var comp = pageSdk.getCompInstance("组件ID_3");
+```
+
+## compInstance.show/hide/toggle();
+
+使用此接口可以显示/隐藏对应的组件
+
+### 参数说明
+
+无
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+/* 获取id为组件ID_3的组件的实例对象 */
+var compInstance = pageSdk.getCompInstance("组件ID_3");
+/* 显示组件 */
+compInstance.show();
+/* 获取id为组件ID_3的组件的实例对象 */
+var compInstance = pageSdk.getCompInstance("组件ID_3");
+/* 隐藏组件 */
+compInstance.hide();
+
+/* 获取id为组件ID_3的组件的实例对象 */
+var compInstance = pageSdk.getCompInstance("组件ID_3");
+/* 切换显示/隐藏组件 */
+compInstance.toggle();
+```
+
+## pageSdk.getExports();
+
+使用此接口可以获取页面源码中导出的内容(多用于组件配置时调用源码中的方法)
+
+### 参数说明
+
+无
+
+### 返回值
+
+源码中导出的对象
+
+### 示例
+
+```javascript
+/*源码中的方法定义如下：*/
+export function test(){ //注意方法前的export关键字
+  console.log("1");
+}
+
+/*组件中的脚本调用上面源码中的test方法示例如下：*/
+var exportsObj = pageSdk.getExports();
+exportsObj.test();
+```
+
+
+## asyncFn();
+
+异步执行函数
+
+### 参数说明
+
+| 参数 | 类型   | 必需 | 说明     |
+| ---- | ------ | ---- | -------- |
+| callback | params | `是` | 回调函数 |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+// 只能用在事件动作JavaScript中
+asyncFn((resolve, reject) => {
+    weappUtils.request({ url: 'xxx', method: 'GET' }).then(res => {
+        if (res) {
+            resolve();// 成功，通知下一个动作执行
+        } else {
+            reject();// 失败或取消，中断后续动作，通知状态清除
+        }
+    }).catch(() => {
+        reject();// 异常，中断后续动作，通知状态清除
+    });
+});
+```

package/skill-docs/references/ebuilder-designer/page-source/sdk-index.md

@@ -0,0 +1,34 @@
+# 页面 SDK 接口索引
+
+本目录用于普通页面设计器源码，可直接按分类查阅接口用途、调用参数、返回值、代码示例和使用限制。示例中的组件ID、资源ID需要替换为目标页面的真实标识；字符串占位符不能作为真实资源使用。
+
+## 查询当前环境的接口说明
+
+```bash
+e10-cli designer source sdk --query getCompInstance
+e10-cli designer source sdk --query 刷新
+e10-cli designer source sdk --id <接口ID>
+e10-cli designer source sdk --out page-sdk.json
+```
+
+`--query` 按方法名或用途筛选，`--id` 使用查询结果中的接口 ID，`--out` 保存完整 JSON。日常编写先阅读本目录；需要检查当前环境的方法及参数差异时使用查询命令。
+
+## 分类
+
+| 分类 | 接口条目数 | 参考 |
+|---|---:|---|
+| 基础 | 15 | [基础](sdk-foundations.md) |
+| 弹框 | 7 | [弹框](sdk-dialogs.md) |
+| 页面跳转 | 4 | [页面跳转](sdk-navigation.md) |
+| 日期 | 2 | [日期](sdk-date.md) |
+| 刷新相关 | 3 | [刷新相关](sdk-refresh.md) |
+| 原生相关 | 6 | [原生相关](sdk-native.md) |
+| sql相关 | 1 | [sql相关](sdk-sql.md) |
+| 表单相关 | 6 | [表单相关](sdk-form.md) |
+| 列表组件相关 | 10 | [列表组件相关](sdk-list.md) |
+| 图表组件相关 | 1 | [图表组件相关](sdk-chart.md) |
+| 其他 | 6 | [其他](sdk-other.md) |
+
+共 11 个分类、61 条接口条目。show/hide/toggle 在目录中为一个组合条目。
+
+完整调用应同时遵循 [页面源码指南](page-source-guide.md) 的执行上下文、编译和终端范围说明。