Widget SDK API

版本: 2.1.5

Widget 指调用 Enhancer.registerWidget 注册的对象。

block() 锁住组件,有异步等待时可调用。

unblock() 解锁组件。

trig(eventName[, data[, callback]) 触发事件。

  • @param eventName {String} [required] 事件名
  • @param data {Object} [optional] 在 Configurator.getSupportedVariables 方法中声明要支持的变量数据。也可以不用,传递此参数,而是在 Widget.getData 方法中,统一返回各种数据。
  • @param callback {Function} [optional] 事件触发后,相关前后台响应完毕后的回调函数。如果组件的前端操作需要因AJAX执行失败而撤销(比如删数据行),则需要指定此函数,做 UI 恢复。
    • result {Object} 由后台传递来的执行结果对象,格式为:{success: false, message: '操作失败'}。注意:仅仅当本事件触发后执行了用户设置的后台响应过程,才会有此回调结果参数。

getContainer() 获得组件所在的容器 div。

id() 获得组件所在容器 DIV 的唯一 id。

getSourceData(id[, criteria[, callback, errCallback]) 获取源数据

  • @param id [required] 数据源 ID,由 Widget Configurator 配置生成。
  • @param criteria [optional] 查询标准参数

    • countRecords {boolean} [optional] 是否要统计记录数,默认 false
    • paged {Boolean} [optional] 是否分页,默认 false
    • page {Number} [optional] 页号
    • rowNum {Number} [optional] 每页行数
    • sortBy {String} [optional] 排序字段
    • format {String} [optional] 数据返回格式: object | array 默认 object
    • params {Object}[optional] 指定参数,覆盖由系统自动捕获的参数上下文。
    • metaData {boolean} [optional] 是否要求结果集中包含描述数据特征的元数据,
    • filters 过滤器,例:
    {
    "groupOp": "OR",   // 条件运算: OR | AND
    "groups": [        // 条件组,相当于 SQL 条件加括号,可以递归地定义下去。
      {
        "groupOp": "OR", 
        "rules": [
          {
            "field": "birth_place",
            "op": "eq",
            "data": "浙江"
          }
        ],
        "groups": []
      }
    ],
    "rules": [    // 条件数组,每个元素是一个单独的条件
      {
        "field": "id",  // 字段
        "op": "eq",     // 操作,取值含义对照:
        // eq 等于, ne 不等于, lt 小于, le 小于等于, gt 大于, ge 大于等于, bw 以开头, bn 不以开头,
        // ew 以结尾, en 不以结尾, cn 包含, nc 不包含, nu 为空, nn 不为空, in 在集合中, nn 不在集合中
        "data": 1       //数据
      },
      {
        "field": "id",
        "op": "eq",
        "data": 2
      }
    ]
    }
    
  • @param callback {Function}
    • data
      {
      rows:[...], 
      paged: false, 
      page: 1,
      rowNum: 15,
      records: 1321,
      metaData: [
        {name:'id', dbType: 'CHAR', varType: 'string'},
        ...
      ]
      }
      
  • @param errCallback {Function} [optional]
    • result

getSourceDataParamsProvidedByThisWidget(sourceId) 获取数据源依赖的本组件参数变量名。

  • @return {Array}

getSourceDataParamNames(sourceId) 获取数据源参数列表。

  • @return {Array}

isSourceDataParamsChanged(sourceId) 判断数据源依赖的参数值相对于上一次数据请求后,是否发生了改变。此方法可用作减少 http 请求的优化。

  • @return {Boolean}

getWindowNo() 获得所属窗口编号

  • @return {Number}

getBaseUrl() 获得本组件基本地址,可以基于此地址访问其他需要动态加载的资源

  • @return {String}

parent() 获得所属窗口实体对象

  • @return {ZWindow}

isInTabContainer() 是否包含在选项卡容器中

  • @return {Boolean}

isInAccordionContainer() 是否包含在手风琴容器中

  • @return {Boolean}

Enhnacer

getFileUploadUrl() 获取文件上传 URL

  • @return {String}

访问文件上传 URL 后返回的数据格式如下:

  {
    "success": true,
    "data": {
      "files": [{
        "filedName": "上传时指定的字段名",
        "originalFilename": "上传时指定的文件名",
        "size": 1024,
        "url": "文件上传后生成的 url"
      }]
    }
  }

getStaticResourceUrl(name) 获取静态资源 URL

  • @param name {String} - 从工作台上传的静态资源名。
  • @return {String}

getCustomInterfaceUrl(interfaceName) 获取自定义接口 URL

  • @param interfaceName {String} 用户指定的后台接口名。
  • @return {String}

getWidgetBaseUrl(widgetName) 获取组件基本地址

  • @param widgetName {String} - 组件名,为空时返回整个组件仓库基本地址。
  • @return {String}

Enhancer.Util

testCondition(condition) 测试条件函数,将带变量的条件表达式做变量替换,然后计算布尔值。

  • @param condition {String} - 可以是带变量的 JS 条件表达式或类 SQL 语言表达式。比如: @11-name@ = '张三' AND @11-gender@ != '女'
  • @return {Boolean}

Enhancer.ZContext

value(vars) 从全局上下文中获取指定变量的值

  • @param vars {Array} - 变量名。
  • @return {Object}

values(vars) 从全局上下文中获取指定变量的值

  • @param vars {Array} - 变量名数组。
  • @return {Object}

parse(contextStr, replace) 解析带变量的文本,将文本中包含的变量替换成对应的值。

  • @param contextStr {String} [required] - 含变量的文本。
  • @param replace {Function} [optional] - 指定替换函数。
  • @return parsed {String} - 替换过的字符串。

ZContext 由框架产生,传递给组件各个接口函数的上下文对象。

val(vars) 从全局上下文中获取指定变量的值

  • @param vars {Array} - 变量名
  • @return {Object}

vals(vars) 从全局上下文中获取指定变量的值

  • @param vars {Array} - 变量名数组
  • @return {Object}

parse(contextStr, replace) 解析带变量的文本,将文本中包含的变量替换成对应的值。

  • @param contextStr {String} [required] - 含变量的文本
  • @param replace {Function} [optional] - 指定替换函数
  • @return parsed {String} - 替换过的字符串

getData() 获取当前上下文对象包含的全部数据。

  • @return data {Object} 变量键值对象。

其他可用 API

results matching ""

    No results matching ""