For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/media/previewImage.md.

previewImage

预览图片。

扫码预览

扫码预览 previewImage

使用限制

WARNING

Android、iOS:只按字符串形式与 urls 中的完整图片地址匹配,数字下标不能定位图片;传入数字下标时会从第一张图片开始预览。 Android、iOS:调用时忽略 referrerPolicy,预览请求不会应用该策略;调用方配置的 Referrer 策略不生效。

支持版本

前端库版本不低于 0.0.26。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片支持

接入准备

前置条件

  • urls 至少包含一个有效图片地址;需要指定首图时传入 urls 中的完整图片地址

调用方式

异步 API

previewImage(params: PreviewImageParams): Promise<object>

入参

名称类型必填默认值约束说明
currentstring | number否urls 中的第一张-当前显示图片的链接,或当前显示图片的下标。不填时显示 `urls` 中的第一张。Android、iOS:只按字符串形式与 urls 中的完整图片地址匹配,数字下标不能定位图片。
referrerPolicystring否--预览页使用的 Referrer 策略。Android、iOS:调用时忽略 referrerPolicy,预览请求不会应用该策略。
showmenuboolean否true-是否显示长按菜单,菜单支持保存图片至本地相册。
urlsstring[]是--需要预览的图片链接列表。

调用示例

import { previewImage } from '@doubao-dev/framework/api';

await previewImage({
  urls: ['https://example.com/a.png', 'https://example.com/b.png'],
  current: 'https://example.com/a.png'
});

成功返回

无返回字段。

返回示例

{}