UI 编辑器 API
共 14 个前端工具方法。
piAlert显示一个警告/提示框参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
msg | String | 否 | "" | 要显示的提示信息 |
调用
typescript
window.PiUtils.piAlert("操作成功完成！")
piClient执行客户端操作参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
action | String | 否 | — | 要执行的操作类型 |
ext | Object | 否 | — | 扩展参数对象 |
调用
typescript
window.PiUtils.piClient("environment.setWeather", {"weather": 2})
piGoto导航到指定页面参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
pageId | String | 否 | — | 目标页面的ID 可以从listV1接口查看 |
调用
typescript
window.PiUtils.piGoto("页面ID")
piLink打开指定URL链接参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
url | String | 否 | — | 要打开的URL地址 |
调用
typescript
window.PiUtils.piLink("https://www.example.com")
piOpenDialog打开关闭指定弹窗参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
id | String | 否 | — | 对话框的ID 可以从listV1接口查看 |
poiId | String | 否 | — | POIID 非必填 填写之后将根据poi点位移动 |
show | boolean | 否 | — | 不传默认为false, false为打开弹窗, true为关闭弹窗 |
width | number | 否 | — | 弹窗宽度 |
height | number | 否 | — | 弹窗高度 |
top | number | 否 | — | 弹窗距顶部位置；有值时优先于从 ext 解析出的 top |
left | number | 否 | — | 弹窗距左侧位置；有值时优先于从 ext 解析出的 left |
调用
typescript
// 打开弹窗
window.PiUtils.piOpenDialog("弹窗ID", "", false)
// 关闭弹窗
window.PiUtils.piOpenDialog("弹窗ID", "", true)
// 带 POI 点位移动打开弹窗
window.PiUtils.piOpenDialog("弹窗ID", "POIID", false)
// 指定宽高与位置打开弹窗
window.PiUtils.piOpenDialog("弹窗ID", "", false, 800, 600, 100, 200)
closeAllDialog关闭所有弹窗关闭当前所有已打开的弹窗，无需任何参数。
调用
typescript
window.PiUtils.closeAllDialog()
piToggle切换指定子页面的显示/隐藏状态参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
pageId | String | 否 | — | 要切换的子页面ID 可以从listV1接口查看 (children中) |
调用
typescript
window.PiUtils.piToggle("子页面ID")
piUpdateGlobalParam更新全局参数参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
param | Object | 否 | — | 包含要更新的参数键值对的对象 |
调用
typescript
window.PiUtils.piUpdateGlobalParam({"globalId": "1"})
toggleShow切换指定元素的显示状态参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
ids | String|Array | 否 | — | 要切换的元素ID或ID数组 |
type | String | 否 | — | 切换类型，默认为"toggle"（可选值："show", "hide", "toggle"） |
调用
typescript
window.PiUtils.toggleShow(["元素id1", "元素id2"], "show")
// or
window.PiUtils.toggleShow("元素id1", "show")
componentEvent触发指定组件的事件参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
trigger | string | 否 | — | 触发的事件类型 click dblclick mouseenter mouseleave |
id | string | 否 | — | 组件id |
调用
typescript
window.PiUtils.componentEvent({"trigger":"click","id":"组件id"})
buttonSelect设置单选多选组件的默认选中值参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
id | string | 否 | — | 组件 id |
value | string | array | 否 | — | 默认选中值。单选传空字符串、多选传空字符串或空数组即为清除选中；选中值对应列表配置项的 value |
调用
typescript
// 单选：选中值为 'a' 的项；清空
window.PiUtils.buttonSelect('组件id', 'a')
window.PiUtils.buttonSelect('组件id', '')
// 多选：选中多项；清空
window.PiUtils.buttonSelect('组件id', ['a', 'b'])
window.PiUtils.buttonSelect('组件id', [])
window.PiUtils.buttonSelect('组件id', '')
getVideoStream获取视频监控组件的流地址参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
componentId | String | 否 | — | 视频监控组件 ID |
调用
typescript
window.PiUtils.getVideoStream('1gitov')
setVideoStream设置视频监控组件的流地址参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
componentId | String | 否 | — | 视频监控组件 ID |
value | String | 否 | — | 流地址，或摄像头模式下的摄像头 id |
调用
typescript
window.PiUtils.setVideoStream('1gitov', 'xxx')
piGetGlobalParam获取全局参数参数说明
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
key | String | 否 | — | 要获取的全局参数键名；传 '' 返回全部 |
调用
typescript
// 获取全部全局参数
window.PiUtils.piGetGlobalParam('')
// 获取指定 key
window.PiUtils.piGetGlobalParam('globalId')