抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • 基础
  • 渲染
  • 媒体
  • 图片
  • tt.chooseImage
  • tt.saveImageToPhotosAlbum
  • tt.previewImage
  • tt.getImageInfo
  • tt.compressImage
  • 音频
  • Canvas 录制
  • 数据缓存
  • TTML
  • 数据分析
  • 页面导航
  • 设备
  • 画布
  • 界面
  • 直播开放能力
  • tt.previewImage
    收藏
    我的收藏

    基础库 3.41.0 开始支持本方法,这是一个异步方法。
    预览一组图片。
    前提条件
    无
    业务背景
    无
    使用限制
    当前仅支持除了 heic 之外的常规格式
    注意事项
      •当 urls 中存在多个相同的图片地址,预览时会选择 current 地址对应的第一张图片进行展示,可通过给图片地址增加 query 或 hash 值避免地址重复;
    ​
    支持沙盒
    否
    相关教程
    无
    ​

    语法

    tt.previewImage(options)

    参数说明

    options 为 object 类型,属性如下:
    属性名
    类型
    默认值
    必填
    说明
    最低支持版本
    current
    string
    urls[0] 的内容
    否
    当前显示图片的链接,不填则默认为 urls 中的第一张
    3.41.0
    showmenu
    boolean
    false
    否
    是否显示长按菜单, 菜单支持保存图片至本地相册
    3.41.0
    urls
    array
    ​
    是
    需要预览的图片地址列表
    3.41.0
    success
    function
    ​
    否
    接口调用成功的回调函数
    3.41.0
    fail
    function
    ​
    否
    接口调用失败的回调函数
    3.41.0
    complete
    function
    ​
    否
    接口调用结束的回调函数(调用成功、失败都会执行)
    3.41.0
    ​

    回调成功

    object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    errMsg
    string
    "previewImage:ok"
    3.41.0
    invalidId
    array
    urls 中不合法的图片的索引
    3.41.0
    ​

    回调失败

    object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    errMsg
    string
    "previewImage:fail" + 详细错误信息
    3.41.0
    ​

    扫码体验

    代码示例

    Bug & Tip

      •Tip:当 urls 中存在多个相同的图片地址,预览时会选择 current 地址对应的第一张图片进行展示,可通过给图片地址增加 query 或 hash 值避免地址重复;
      •Tip:当前仅支持除了 heic 之外的常规格式。
    ​