数字人交互 API

共 9 个前端工具方法。

piAlert显示一个警告/提示框

参数说明

参数类型必填默认值说明
msgString否—要显示的提示信息

调用

javascript 
// eventName: actionEvent
// eventValue:
{
  "action": "piAlert",
  "value": ["操作成功完成!"]
}
piClient执行客户端操作

参数说明

参数类型必填默认值说明
actionString否—要执行的操作类型
extObject否—扩展参数对象

调用

javascript 
// eventName: actionEvent
// eventValue:
{
  "action": "piClient",
  "value": [
    "environment.setWeather",
    {
      "weather": 2
    }
  ]
}
piGoto导航到指定页面

参数说明

参数类型必填默认值说明
pageIdString否—目标页面的ID（可以从 `listV1` 接口查看）

调用

javascript 
// eventName: actionEvent
// eventValue:
{
  "action": "piGoto",
  "value": ["页面ID"]
}
piOpenDialog打开指定对话框

参数说明

参数类型必填默认值说明
idString否—对话框的ID（可以从 `listV1` 接口查看）
poiIdString否—POI ID，非必填。填写之后将根据POI点位移动

调用

javascript 
// eventName: actionEvent
// eventValue:
{
  "action": "piOpenDialog",
  "value": ["弹窗ID", "poi123"]
}
piToggle切换指定子页面的显示/隐藏状态

参数说明

参数类型必填默认值说明
pageIdString否—要切换的子页面ID（可以从 `listV1` 接口查看，位于 `children` 中）

调用

javascript 
// eventName: actionEvent
// eventValue:
{
  "action": "piToggle",
  "value": ["子页面ID"]
}
piUpdateGlobalParam更新全局参数

参数说明

参数类型必填默认值说明
paramObject否—包含要更新的参数键值对的对象

调用

javascript 
// eventName: actionEvent
// eventValue:
{
  "action": "piUpdateGlobalParam",
  "value": [
    {
      "globalId": "1"
    }
  ]
}
toggleShow切换指定元素的显示状态

参数说明

参数类型必填默认值说明
idsString` / `Array否—要切换的元素ID或ID数组
typeString否—切换类型，默认为 `"toggle"`。可选值：`"show"`、`"hide"`、`"toggle"

调用

javascript 
// eventName: actionEvent
// eventValue:
{
  "action": "toggleShow",
  "value": ["元素id1", "show"]
}
componentEvent触发指定组件的事件

参数说明

参数类型必填默认值说明
triggerString否—触发的事件类型。可选值：`click`、`dblclick`、`mouseenter`、`mouseleave
idString否—组件ID

调用

javascript 
// eventName: componentEvent
// eventValue:
{
  "action": "componentEvent",
  "value": {
    "trigger": "click",
    "id": "组件id"
  }
}