Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

监听事件

公共事件列表:

事件名说明
fileOpen文档打开
error错误事件
fileStatus文件保存状态
fullscreenchange进入或退出全屏事件

fileOpen

文档打开成功或者失败时的事件回调

注意:该事件需要在 jssdk.ready() 之前进行注册

javascript
instance.ApiEvent.AddApiEventListener("fileOpen", (data) => {
  console.log("fileOpen: ", data);
});

成功响应:

javascript
{
  duration: 812,
  fileInfo: {
    createTime: 1606461829,
    id: "94749723688",
    modifyTime: 1606461829,
    name: "example.doc",
    officeType: "s",
  },
  stageTime: 1614,
  success: true,
  time: 1614,
  ts: 1607858260164,
}

失败响应:

javascript
{
  msg: "Fail",
  result: "Fail"
}

error

错误发生时的事件回调

例如将 doc 文件改成 xls 文件等操作,会引发报错

javascript
instance.ApiEvent.AddApiEventListener("error", (data) => {
  console.log("error: ", data);
});

返回参数:

javascript
{
  reason: "Fail";
}

fileStatus

文件保存的事件回调

javascript
instance.ApiEvent.AddApiEventListener("fileStatus", (data) => {
  console.log("fileStatus: ", data);
});

返回参数:

javascript
{
  status: 0, // 文档无更新
  status: 1, // 版本保存成功, 触发场景:手动保存、定时保存、关闭网页
  status: 2, // 暂不支持保存空文件, 触发场景:内核保存完后文件为空
  status: 3, // 空间已满
  status: 4, // 保存中请勿频繁操作,触发场景:服务端处理保存队列已满,正在排队
  status: 5, // 保存失败
  status: 6, // 文件更新保存中,触发场景:修改文档内容触发的保存
  status: 7, // 保存成功,触发场景:文档内容修改保存成功
}

fullscreenchange

进入或者退出全屏时会执行回调

如果在 commonOptions 下配置了 isBrowserViewFullscreen 或者 isIframeViewFullscreen,此项监听会无效。

javascript
instance.ApiEvent.AddApiEventListener("fullscreenchange", (data) => {
  console.log("fullscreenchange: ", data);
});

返回参数:

javascript
{
  status: 0, // 退出全屏
  status: 1, // 进入全屏
}

WPS多维表格事件列表:

事件名说明
ViewTypeChanged监听视图变化
ViewDataUpdate监听数据更新
SelectionChange监听选区变化
ActiveDetailRecordChange详情页卡片记录变化

使用方法如下:

javascript
instance.Application.Sub.ViewTypeChange = (data) => {
  console.log('ViewTypeChange: ', data)
}
回到旧版