Skip to content

previewImage

描述

用于预览图片。

网页应用需要完成鉴权后调用该接口。

支持说明

客户端平台WPS协作版本要求
iOS>=2.0.0
Android>=2.0.0
PC>=2.0.0

输入

名称数据类型是否必填描述
paramsobject
∟ currentIndexnumber当前预览图片的索引值
默认值:0
∟ shouldShowCopyOptionboolean是否显示复制按钮
注意:仅 PC 客户端支持
∟ shouldShowForwardOptionboolean是否显示转发按钮
注意:仅 PC 客户端支持
∟ shouldShowSaveOptionboolean是否显示下载按钮
true:显示
false:不显示
默认值:true
∟ urlstring需要预览的图片路径
注意:仅 PC 客户端支持,pc端为必填
∟ urlsarray<string>需要预览的图片 url 或者本地路径
注意:仅移动端支持
移动端为必填
当url为本地路径时,该url来源于其他jsapi返回的路径,如chooseImage的返回:"ksoxz://temp/e1f7c67d89ef4da69337ce35e66e2e04"
onSuccessFunction
onErrorFunction

输出

  • 无返回值

示例代码

ts
const params = {
  urls: [
    'https://qn.cache.wpscdn.cn/koa/static/avatar_v2/schedule_avatar.png',
    'https://qn.cache.wpscdn.cn/koa/static/avatar/workbench_avatar.png',
    'https://qn.cache.wpscdn.cn/koa/static/avatar_v2/meeting_avatar.png',
    'https://qn.cache.wpscdn.cn/koa/static/avatar_v2/docs_avatar.png',
    'https://qn.cache.wpscdn.cn/koa/static/avatar/oms_avatar.png',
  ],
  currentIndex: '2'
};
window.ksoxz_sdk.previewImage({params,onSuccess,onError});

错误码

参考:公共错误码