图片

最近更新时间:2023-10-20 15:19:18

我的收藏

chooseImage

该 API 使用方法为 wx.chooseImage(Object object)
功能说明:从本地相册选择图片或使用相机拍照。
参数及说明:Object object。
属性
类型
合法值及说明
默认值
必填
说明
count
number
-
9
多可以选择的图片张数
sizeType
Array.
original:原图
compressed:压缩图
['original', 'compressed']
所选的图片的尺寸
sourceType
Array.
album:从相册选图
camera:使用相机
['album', 'camera']
选择图片的来源
success
function
-
-
接口调用成功的回调函数
fail
function
-
-
接口调用失败的回调函数
complete
function
-
-
接口调用结束的回调函数(调用成功、失败都会执行)
object.success 回调函数参数:Object res。
属性
类型
说明
tempFilePaths
Array.
图片的本地临时文件路径列表 (本地路径)
tempFiles
Array.
图片的本地临时文件列表
res.tempFiles 的结构
属性
类型
说明
path
string
本地临时文件路径
size
number
本地临时文件大小,单位 B
示例代码
wx.chooseImage({
count: 1,
sizeType: ['original', 'compressed'],
sourceType: ['album', 'camera'],
success (res) {
// tempFilePath可以作为 img 标签的 src 属性显示图片
const tempFilePaths = res.tempFilePaths
}
})

compressImage

该 API 使用方法为 wx.compressImage(Object object)
功能说明:压缩图片接口,可选压缩质量。
参数及说明:Object object。
属性
类型
默认值
必填
说明
src
string
-
图片路径,图片的路径,支持本地路径、代码包路径
quality
number
80
压缩质量,范围0~100,数值越小,质量越低,压缩率越高(仅对 jpg 有效)
compressedWidth
number
-
压缩后图片的宽度,单位为px,若不填写则默认以 compressedHeight 为准等比缩放
compressedHeight
number
-
压缩后图片的高度,单位为px,若不填写则默认以compressedWidth为准等比缩放
success
function
-
接口调用成功的回调函数
fail
function
-
接口调用失败的回调函数
complete
function
-
接口调用结束的回调函数(调用成功、失败都会执行)
object.success 回调函数参数:Object res。
属性
类型
说明
tempFilePath
string
压缩后图片的临时文件路径 (本地路径)
示例代码
wx.compressImage({
src: '', // 图片路径
quality: 80 // 压缩质量
})

getImageInfo

该 API 使用方法为 wx.getImageInfo(Object object)
功能说明:获取图片信息。网络图片需先配置 download 域名才能生效。
参数及说明:Object object。
属性
类型
默认值
必填
说明
src
string
-
图片的路径,可以是相对路径、临时文件路径、存储文件路径、网络图片路径
success
function
-
接口调用成功的回调函数
fail
function
-
接口调用失败的回调函数
complete
function
-
接口调用结束的回调函数(调用成功、失败都会执行)
object.success 回调函数参数:Object res。
属性
类型
说明
width
number
图片原始宽度,单位 px。不考虑旋转
height
number
图片原始高度,单位 px。不考虑旋转
path
string
图片的本地路径
orientation
string
type
string
图片格式
res.orientation 的合法值
说明
up
默认方向(手机横持拍照),对应 Exif 中的 1,或无 orientation 信息
up-mirrored
同 up,但镜像翻转,对应 Exif 中的2
down
旋转180度,对应 Exif 中的3
down-mirrored
同 down,但镜像翻转,对应 Exif 中的4
left-mirrored
同 left,但镜像翻转,对应 Exif 中的5
right
顺时针旋转90度,对应 Exif 中的6
right-mirrored
同 right,但镜像翻转,对应 Exif 中的7
left
逆时针旋转90度,对应 Exif 中的8
示例代码:
wx.getImageInfo({
src: 'images/a.jpg',
success(res) {
console.log(res.width)
console.log(res.height)
},
})

wx.chooseImage({
success(res) {
wx.getImageInfo({
src: res.tempFilePaths[0],
success(res) {
console.log(res.width)
console.log(res.height)
},
})
},
})

previewImage

该 API 使用方法为 wx.previewImage(Object object)
功能说明:在新页面中全屏预览图片。预览的过程中用户可以进行保存图片、发送给朋友等操作。
参数及说明:Object object。
属性
类型
默认值
必填
说明
urls
Array.<string>
-
需要预览的图片链接列表。 支持云文件 ID
current
string
urls 的第一张
当前显示图片的链接
success
function
-
接口调用成功的回调函数
fail
function
-
接口调用失败的回调函数
complete
function
-
接口调用结束的回调函数(调用成功、失败都会执行)
示例代码:
wx.previewImage({
current: '', // 当前显示图片的http链接
urls: [], // 需要预览的图片http链接列表
})

previewMedia

该 API 使用方法为 wx.previewMedia(Object object)
功能说明:预览图片和视频。
参数及说明:Object object。
类型
默认值
必填
说明
Array.<Object>
-
需要预览的资源列表
number
0
当前显示的资源序号
boolean
true
是否显示长按菜单
string
no-referrer
origin:发送完整的 referrer
no-referrer:不发送
格式固定为 `https://servicewechat.com/{appid}/{version}/page-frame.html`,其中
{appid} 为小程序的 appid
{version} 为小程序的版本号,版本号为 0 表示为开发版、体验版以及审核版本,版本号为 devtools 表示为开发者工具,其余为正式版本
function
-
接口调用成功的回调函数
function
-
接口调用失败的回调函数
function
-
接口调用结束的回调函数(调用成功、失败都会执行)
支持长按识别的码
类型
说明
小程序码
-
宿主客户端微信个人码
不支持小游戏
宿主客户端企业微信个人码
不支持小游戏
普通群码
仅包含宿主客户端内微信用户的群,不支持小游戏
互通群码
指宿主客户端内既有微信用户也有企业微信用户的群,不支持小游戏
公众号二维码
不支持小游戏

saveImageToPhotosAlbum

该 API 使用方法为 wx.saveImageToPhotosAlbum(Object object)
说明:
调用前需要“用户授权” scope.writePhotosAlbum。
功能说明:保存图片到系统相册。
参数及说明:Object object。
属性
类型
默认值
必填
说明
filePath
string
-
图片文件路径,可以是临时文件路径或永久文件路径,不支持网络图片路径
success
function
-
接口调用成功的回调函数
fail
function
-
接口调用失败的回调函数
complete
function
-
接口调用结束的回调函数(调用成功、失败都会执行)
示例代码
wx.saveImageToPhotosAlbum({
success(res) {},
})

chooseMessageFile

该 API 使用方法为 wx.chooseMessageFile(Object object)
功能说明:从客户端会话选择文件。
参数及说明:Object object。
属性
类型
默认值
必填
说明
count
number
-
最多可以选择的文件个数,可以 0~100
type
string
all
所选的文件的类型,合法值为
all:从所有文件选择
video:只能选择视频文件
image:只能选择图片文件
file:可以选择除了图片和视频之外的其它的文件
extension
Array.<string>
-
根据文件拓展名过滤,仅 type==file 时有效。每一项都不能是空字符串。默认不过滤
success
function
-
接口调用成功的回调函数
fail
function
-
接口调用失败的回调函数
complete
function
-
接口调用结束的回调函数(调用成功、失败都会执行)
object.success 回调函数参数:Object res
属性
类型
说明
tempFile
Array.<string>
返回选择的文件的本地临时文件对象数组
tempFile 结构属性
结构属性
类型
说明
path
string
本地临时文件路径 (本地路径)
size
number
本地临时文件大小,单位 B
name
string
选择的文件名称
type
string
选择的文件类型,合法值
video:选择了视频文件
image:选择了图片文件
file:选择了除图片和视频的文件
time
number
选择的文件的会话发送时间,Unix 时间戳,工具暂不支持此属性