客户端 API

客户端 API 包含 Enhaner 官方和 jQuery 三方,可以在任意客户端执行脚本中使用。

Enhancer 全局对象

openPage(pageId[, data]) 打开页面,并传递参数

  • @param pageId {Number} [必须] 页面编号
  • @param data {Object} [可选] 传递给页面的参数键值对,目标页面可以通过变量 @9-[KEYNAME]@ 来取值。

resetCurrentPage() 重置当前页面

getFileUploadUrl() 获取文件上传 URL

  • @return url {String}

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

  • @param interfaceName {String} - [必须] 用户指定的后台接口名
  • @return url {String}

getEntityByNumber(no) 根据编号获取实体(帧,窗口)对象

  • @param no {Number} [必须] 窗口或帧编号
  • @return entity {Object} 实体对象

getStaticResourceUrl(name) 获取在工作台全局配置中上传的静态资源 Url

  • @param name {String} [必须] 资源名称
  • @return {String}

Enhancer.Util 对象

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

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

Enhancer.ZContext 对象

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

  • @param varname {String} [必须] 变量名
  • @return value

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

  • @param vars {Array} [必须] 变量名数组
  • @return value

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

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

Enhancer.ZUserData 对象

val(name) 获取用户变量值

  • @param name {String} [必须] 变量名,只能获取以 10 以下数字开头的变量。
  • @return {Object} 变量值

set(name, value) 设置用户变量,只能设置以 10 以下数字开头的变量,供全局使用,如 7-CURR_CHECK_ID。

  • @param name {String} [必须] 变量名,必须是以 0 - 9 开头的变量名。
  • @param value {Object} [必须] 值。

get(name) 获取 10 以下数字开头的变量值

  • @param name {String} [可选] 如果为空,则返回全部 10 以下开头的变量集合。
  • @return {Object} 变量或变量集合。

add(name, value) 添加用户变量,只能添加以 10 以下数字开头的变量,供全局使用,如 7-CURR_CHECK_ID。

  • @param name {String} [必须] 变量名,必须是以 0 - 9 开头的变量名,如果变量已存在,则覆盖旧值。
  • @param value {Object} [必须] 值。

Entity 实体对象,包括帧,窗口,一般由 Enhancer.getEntityByNumber 方法获得

getData(name) 获取实体当前变量数据

  • @param name {String} [必须] 变量名,不需带编号开头的变量名,比如 STUDENT_NO。
  • @return {Object} 变量值。

setData(name, value) 设置变量值,设置之后可以使用变量。

  • @param name {String} [必须] 变量名,不需带编号的变量名,比如 STUDENT_NO。
  • @return {Object} [必须] 变量值。
【例】
var win = Enhancer.getEntityByNumber(12);
win.setData('STUDENT_NO。', 201808283858); 
// 设置后,可以在合适的地方使用变量 @12-STUDENT_NO@,值为 201808283858。

getContainer() 获取窗口或者帧所在 DOM 容器。

  • return {jQuery Object}

getWidgetContainer() 获取组件所在 DOM 容器。

  • return {jQuery Object}

此外,jQuery 可直接使用,无需额外引入。

results matching ""

    No results matching ""