tt.previewImage
收藏我的收藏
基础库 1.0.0 开始支持本方法,这是一个异步方法。
预览一组图片。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 当前仅支持除了 heic 之外的常规格式。 |
| 注意事项 |
|
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.previewImage(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| current | string | urls[0] 的内容 | 否 | 当前显示图片的链接,不填则默认为 urls 中的第一张 | 1.0.0 |
| showmenu | boolean | false | 否 | 是否显示长按菜单, 菜单支持保存图片至本地相册 | 2.48.0 |
| urls | Array<string> | 是 | 需要预览的图片地址列表。当前仅支持除了 heic 之外的常规格式。 | 1.0.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.0.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "previewImage:ok" | 1.0.0 |
| invalidId | array | urls 中不合法的图片的索引 | 2.48.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "previewImage:fail" + 详细错误信息 | 1.0.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 111901 | previewImage:fail urls have no valid files | D | 图片路径无效文件 检查url入参是否为有效图片路径 | 1.0.0 |
| 111999 | previewImage:fail params urls is required | D | urls为空 请检查urls参数是否合法 | 1.0.0 |
| 111999 | previewImage:fail params urls should be array | D | urls参数类型需要是array 请检查urls参数是否合法 | 1.0.0 |
| 111991 | previewImage:fail Internal error: Failed to preview image. | F | 小程序框架内部错误,有需要请拉客服咨询 小程序框架异常,请创建工单反馈,会有专人协助您解决问题 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
