Skip to content

sud.previewImage ​

预览指定图片列表,并可指定首先显示的图片。

javascript
sud.previewImage(object)

参数 ​

Object object ​

属性类型必填说明
currentstring否首先显示的图片地址,应为 urls 中的一项;建议显式指定
urlsArray<string>是需要预览的图片地址列表,不能为空
successfunction否预览请求成功回调
failfunction否预览请求失败回调
completefunction否调用结束回调,成功或失败均执行

返回值 ​

异步接口,通过回调取得调用结果。

回调参数 ​

success ​

预览请求被接受时调用,没有约定的业务返回字段。此回调不表示列表中的图片均已加载完成,也不表示用户已经关闭预览。

fail ​

属性类型说明
errCodenumber错误码
errMsgstring错误信息

complete ​

在 success 或 fail 之后调用,不携带参数;不用于监听预览页面关闭。

使用说明 ​

  • 调用前确保 urls 非空,并将 current 设置为其中一项,避免依赖缺省值或无效地址的处理方式。
  • 图片地址可以是当前运行环境支持的本地文件路径或网络 URL。具体支持的地址格式以当前运行环境为准;本地文件需要可读取,网络图片需要可以访问。
  • 图片加载失败可能在预览界面中呈现,不一定触发本次调用的 fail。
  • 本接口不提供预览页面关闭回调,也不返回用户最终查看的图片。

示例代码 ​

将已有图片地址列表传给 previewImages,例如 sud.chooseImage 返回的 res.tempFilePaths。

javascript
function previewImages(urls) {
    if (!urls || urls.length === 0) {
        return;
    }
    sud.previewImage({
        current: urls[0],
        urls,
        success: () => {
            console.log('预览请求已接受');
        },
        fail: (err) => {
            console.error('预览请求失败', err.errCode, err.errMsg);
        },
        complete: () => {
            console.log('预览调用结束');
        },
    });
}