From 21ae3e2ad4036e932a806d1a125d49172e5e48e9 Mon Sep 17 00:00:00 2001 From: wanganxp Date: Mon, 19 Aug 2019 23:10:36 +0800 Subject: [PATCH] Update image.md --- docs/api/media/image.md | 156 ++++++++++++++++++++-------------------- 1 file changed, 80 insertions(+), 76 deletions(-) diff --git a/docs/api/media/image.md b/docs/api/media/image.md index f7fe4aebd..3f4f62747 100644 --- a/docs/api/media/image.md +++ b/docs/api/media/image.md @@ -1,5 +1,9 @@ ### uni.chooseImage(OBJECT) -从本地相册选择图片或使用相机拍照。另外选择和上传非图像、视频文件参考:[https://ask.dcloud.net.cn/article/35547](https://ask.dcloud.net.cn/article/35547)。 +从本地相册选择图片或使用相机拍照。 + +另外选择和上传非图像、视频文件参考:[https://ask.dcloud.net.cn/article/35547](https://ask.dcloud.net.cn/article/35547)。 + +App端如需要更丰富的相机拍照API(如直接调用前置摄像头),参考[plus.camera](https://www.html5plus.org/doc/zh_cn/camera.html) **OBJECT 参数说明** @@ -55,7 +59,7 @@ uni.chooseImage({ |current|String/Number|详见下方说明|详见下方说明|| |urls|Array<String>|是|需要预览的图片链接列表|| |indicator|String|否|图片指示器样式,可取值:"default" - 底部圆点指示器; "number" - 顶部数字指示器; "none" - 不显示指示器。|5+App| -|loop|Boolean|否|是否可循环预览,默认值为 false|5+App| +|loop|Boolean|否|是否可循环预览,默认值为 false|5+App| |longPressActions|Object|否|长按图片显示操作菜单,如不填默认为**保存相册**,1.9.5 起支持。|5+App| |success|Function|否|接口调用成功的回调函数|| |fail|Function|否|接口调用失败的回调函数|| @@ -78,47 +82,47 @@ current 为当前显示图片的链接/索引值,不填或填写的值无效 - 传 B2 的链接,预览的结果是 B1,前一张是 A,下一张是 C。 - 传 B2 的索引值 3,预览的结果是 B2,前一张是 C,下一张是 D。此时在微信/百度/头条小程序平台,最终传入的 urls 是 `[A, C, B2, D]`,过滤掉了与 B2 重复的 B1。 - -**longPressActions 参数说明** - -|参数|类型|必填|说明| -|:-|:-|:-|:-| -|itemList|Array<String>|是|按钮的文字数组| -|itemColor|String|否|按钮的文字颜色,字符串格式,默认为"#000000"| -|success|Function|否|接口调用成功的回调函数,详见返回参数说明| -|fail|Function|否|接口调用失败的回调函数| -|complete|Function|否|接口调用结束的回调函数(调用成功、失败都会执行)| - + +**longPressActions 参数说明** + +|参数|类型|必填|说明| +|:-|:-|:-|:-| +|itemList|Array<String>|是|按钮的文字数组| +|itemColor|String|否|按钮的文字颜色,字符串格式,默认为"#000000"| +|success|Function|否|接口调用成功的回调函数,详见返回参数说明| +|fail|Function|否|接口调用失败的回调函数| +|complete|Function|否|接口调用结束的回调函数(调用成功、失败都会执行)| + **success 返回参数说明** |参数|类型|说明| -|:-|:-|:-| +|:-|:-|:-| |index|Number|用户长按图片的索引值| -|tapIndex|Number|用户点击按钮列表的索引值| - +|tapIndex|Number|用户点击按钮列表的索引值| + **示例** ```javascript // 从相册选择6张图 -uni.chooseImage({ - count: 6, - sizeType: ['original', 'compressed'], - sourceType: ['album'], - success: function(res) { - // 预览图片 - uni.previewImage({ - urls: res.tempFilePaths, - longPressActions: { - itemList: ['发送给朋友', '保存图片', '收藏'], - success: function(data) { - console.log('选中了第' + (data.tapIndex + 1) + '个按钮,第' + (data.index + 1) + '张图片'); - }, - fail: function(err) { - console.log(err.errMsg); - } - } - }); - } +uni.chooseImage({ + count: 6, + sizeType: ['original', 'compressed'], + sourceType: ['album'], + success: function(res) { + // 预览图片 + uni.previewImage({ + urls: res.tempFilePaths, + longPressActions: { + itemList: ['发送给朋友', '保存图片', '收藏'], + success: function(data) { + console.log('选中了第' + (data.tapIndex + 1) + '个按钮,第' + (data.index + 1) + '张图片'); + }, + fail: function(err) { + console.log(err.errMsg); + } + } + }); + } }); ``` @@ -221,54 +225,54 @@ uni.chooseImage({ }); } }); -``` - -# uni.compressImage(OBJECT) - -压缩图片接口,可选压缩质量 - +``` + +# uni.compressImage(OBJECT) + +压缩图片接口,可选压缩质量 + **平台差异说明** |5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序 |:-:|:-:|:-:|:-:|:-:|:-:| -|1.9.7+ [自定义组件编译模式](https://ask.dcloud.net.cn/article/35843)|x|√|√|x|x| - -**OBJECT 参数说明** - -| 属性 | 类型 | 默认值 | 必填 | 说明 | -| :- | :- | :- | :- | :- | -| src | String | | 是 | 图片路径,图片的路径,可以是相对路径、临时文件路径、存储文件路径 | -| quality | Number | 80 | 否 | 压缩质量,范围0~100,数值越小,质量越低,压缩率越高(仅对jpg有效) | -| success | Function | | 否 | 接口调用成功的回调函数 | -| fail | Function | | 否 | 接口调用失败的回调函数 | -| complete | Function | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | - -**success 返回参数说明** - -| 属性 | 类型 | 说明 | -| :- | :- | :- | -| tempFilePath | String | 压缩后图片的临时文件路径 | - -**示例代码:** - -```js +|1.9.7+ [自定义组件编译模式](https://ask.dcloud.net.cn/article/35843)|x|√|√|x|x| + +**OBJECT 参数说明** + +| 属性 | 类型 | 默认值 | 必填 | 说明 | +| :- | :- | :- | :- | :- | +| src | String | | 是 | 图片路径,图片的路径,可以是相对路径、临时文件路径、存储文件路径 | +| quality | Number | 80 | 否 | 压缩质量,范围0~100,数值越小,质量越低,压缩率越高(仅对jpg有效) | +| success | Function | | 否 | 接口调用成功的回调函数 | +| fail | Function | | 否 | 接口调用失败的回调函数 | +| complete | Function | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | + +**success 返回参数说明** + +| 属性 | 类型 | 说明 | +| :- | :- | :- | +| tempFilePath | String | 压缩后图片的临时文件路径 | + +**示例代码:** + +```js uni.compressImage({ src: '/static/logo.jpg', quality: 80, success: res => { console.log(res.tempFilePath) } -}) -``` - - -# wx.chooseMessageFile(OBJECT) - -从客户端会话选择文件。 - -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|x|x| - +}) +``` + + +# wx.chooseMessageFile(OBJECT) + +从客户端会话选择文件。 + +**平台差异说明** + +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| +|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|x|x| + -- GitLab