AppCan插件API功能扩展之uexImage.docx
- 文档编号:24041417
- 上传时间:2023-05-23
- 格式:DOCX
- 页数:16
- 大小:22.92KB
AppCan插件API功能扩展之uexImage.docx
《AppCan插件API功能扩展之uexImage.docx》由会员分享,可在线阅读,更多相关《AppCan插件API功能扩展之uexImage.docx(16页珍藏版)》请在冰豆网上搜索。
AppCan插件API功能扩展之uexImage
uexImage
∙1、简介
∙1.1、说明
∙1.2、开源源码
2、API预览
∙2.1、方法
∙openPicker打开照片选择器
∙openBrowser打开图片浏览器
∙openCropper打开图片裁剪器
∙saveToPhotoAlbum储存到相册
∙clearOutputImages清除由本插件导出的所有图片文件
∙setIpadPopEnable设置iPad是否启用pop窗口
∙cbClearOutputImages清除由本插件导出的所有图片文件的回调方法
∙2.2、回调方法
∙cbSaveToPhotoAlbum储存到相册的回调方法
∙2.3、监听方法
∙onPickerClosed照片选择器被关闭的监听方法
∙onBrowserClosed图片浏览器被关闭的监听方法
∙onCropperClosed图片裁剪器被关闭的监听方法
3、更新历史
∙iOS
∙Android
1、简介
图片插件
1.1、说明
封装了图片的相关功能:
您可以使用该插件进行选择。
导出、裁剪、浏览、存入系统相册等一系列针对图片的操作。
1.2、开源源码
点击至插件详情页(插件测试用例与插件包已经提供)
2、API预览
2.1、方法
openPicker打开照片选择器
uexImage.openPicker(param);
说明
∙打开一个可以选择本地相册图片的选择器,导出所选图片,并返回图片路径
∙默认导出图片的格式为jpg
∙相关 onPickerClosed照片选择器被关闭的监听方法
参数
param为json字符串,包含的参数如下
参数名称
参数类型
是否必选
说明
默认值
min
Number
否
最小选择数量,传0表示无限制
1
max
Number
否
最大选择数量,传0表示无限制
0
quality
Number
否
JPG压缩质量取值范围0-1越大表示质量越好
0.5
usePng
Boolean
否
用png格式导出图片,此参数为true时,quality参数无效
false
detailedInfo
Boolean
否
此参数为true时,回调中会包含图片的额外信息
false
∙png无损且支持透明色,但文件体积比jpg大得多。
∙用户应按需求自行选择图片文件格式
平台支持
Android2.2+
iOS7.0+
版本支持
Android3.0.0+
iOS3.0.0+
示例
1.vardata={
2.min:
2,
3.max:
3,
4.quality:
0.8,
5.detailedInfo:
true
6.}
7.varjson=JSON.stringify(data);
8.uexImage.openPicker(json)
openBrowser打开图片浏览器
uexImage.openBrowser(param);
说明
∙打开一个可以浏览图片的浏览器
∙图片路径支持wgt:
//wgts:
//res:
//file:
//http:
//https:
//
∙相关 onBrowserClosed图片浏览器被关闭的监听方法
参数
param为json字符串,包含的参数如下
参数名称
参数类型
是否必选
说明
默认值
displayActionButton
Boolean
否
显示分享按钮
false
displayNavArrows
Boolean
否
显示切换箭头(仅iOS支持此参数)
false
enableGrid
Boolean
否
允许九宫格视图
true
startOnGrid
Boolean
否
以九宫格视图起始
false
startIndex
Number
否
非负整数起始图片位置
0
data
Array
是
图片资源构成的数组
无
∙即使只浏览一张图片data也必须是数组
∙data内的元素可以是字符串或者是字典格式
∙传字符串时,此字符串应为图片资源路径
∙传字典时,结构如下
1.{
2.src:
//(String,必选)图片资源路径,支持wgt:
//wgts:
//res:
//file:
//http:
//https:
//
3.thumb:
//(String,可选)图片缩略图路径
4.desc:
//(String,可选)为图片添加一段文字描述
5.}
平台支持
Android2.2+
iOS7.0+
版本支持
Android3.0.0+
iOS3.0.0+
示例
1.vardata={
2.displayActionButton:
true,
3.displayNavArrows:
true,
4.enableGrid:
true,
5.//startOnGrid:
true,
6.startIndex:
2,
7.data:
["res:
//photo1.jpg",
8.{
9.src:
"res:
//photo2.jpg",
10.thumb:
"res:
//photo2t.jpg",
11.},
12.{
13.src:
"res:
//photo3.jpg",
14.thumb:
"res:
//photo3t.jpg",
15.desc:
"22222222222222"
16.},
17.{
18.src:
"http:
//it-
19.thumb:
"res:
//photo4t.jpg",
20.desc:
"22222222222222"
21.}]
22.}
23.varjson=JSON.stringify(data);
24.uexImage.openBrowser(json);
openCropper打开图片裁剪器
uexImage.openCropper(param);
说明
∙打开一个图片裁剪器,导出裁剪后的图片,并返回图片路径
∙本API只有裁剪功能,裁剪后的图片大小即为所裁剪部分在原图中的大小
∙相关 onCropperClosed图片裁剪器被关闭的监听方法
参数
param为json字符串,包含的参数如下
参数名称
参数类型
是否必选
说明
默认值
src
String
否
图片路径支持wgt:
//wgts:
//file:
//res:
//
无
quality
Number
否
JPG压缩质量取值范围0-1越大表示质量越好
0.5
usePng
Boolean
否
用png格式导出图片,此参数为true时,quality参数无效
false
mode
Number
否
1-正方型裁剪2-圆形裁剪(仅iOS支持圆形裁剪)
1
平台支持
Android2.2+
iOS7.0+
版本支持
Android3.0.0+
iOS3.0.0+
示例
1.vardata={
2.src:
"res:
//photo5.jpg",
3.mode:
2
4.}
5.varjson=JSON.stringify(data);
6.uexImage.openCropper(json);
saveToPhotoAlbum储存到相册
uexImage.saveToPhotoAlbum(param);
说明
∙将本地图片储存到系统相册
∙相关 cbSaveToPhotoAlbum储存到相册的回调方法
参数
param为json字符串,包含的参数如下
参数名称
参数类型
是否必选
说明
localPath
String
是
图片路径支持res:
//wgt:
//wgts:
//file:
//
extraInfo
String
否
任意字符串,设置后会随cbSaveToPhotoAlbum传出
∙extraInfo可作唯一标识符用
平台支持
Android2.2+
iOS7.0+
版本支持
Android3.0.0+
iOS3.0.0+
示例
1.vardata={
2.localPath:
"res:
//photo4.jpg",
3.extraInfo:
"aaaaa"
4.}
5.varjson=JSON.stringify(data);
6.uexImage.saveToPhotoAlbum(json);
clearOutputImages清除由本插件导出的所有图片文件
uexImage.clearOutputImages();
说明
∙清除由本插件的openPicker、openCropper接口所生成的图片文件
∙若您的APP有多个widget,则只会清除由当前widget所生成的图片文件
∙相关 cbClearOutputImages清除由本插件导出的所有图片文件的回调方法
参数
无
平台支持
Android2.2+
iOS7.0+
版本支持
Android3.0.0+
iOS3.0.0+
示例
1.uexImage.clearOutputImages();
setIpadPopEnable设置iPad是否启用pop窗口
uexImage.setIpadPopEnable(flag);
说明
∙插件在iPad上默认用pop窗口展示插件页面,
∙通过调用此接口,可以选择是否禁用pop窗口,改用全屏展示插件页面。
参数
参数名称
参数类型
是否必选
说明
flag
Number
是
为0时表示禁用pop窗口,非0时表示启用pop窗口
平台支持
iOS7.0+
版本支持
iOS3.0.4+
示例
1.uexImage.setIpadPopEnable(0);
cbClearOutputImages清除由本插件导出的所有图片文件的回调方法
uexImage.cbClearOutputImages(param);
说明
∙清除由本插件导出的所有图片文件后会调用此方法
参数
param为json字符串,包含的参数如下
参数名称
参数类型
是否必选
说明
status
String
是
成功返回”ok”
平台支持
Android2.2+
iOS7.0+
版本支持
Android3.0.0+
iOS3.0.0+
示例
1.window.uexOnload=function(type){
2.uexImage.cbClearOutputImages=function(info){
3.alert(info);
4.}
5.}
2.2、回调方法
cbSaveToPhotoAlbum储存到相册的回调方法
uexImage.cbSaveToPhotoAlbum(param);
说明
∙存储图片到相册后会调用此方法
参数
param为json字符串,包含的参数如下
参数名称
参数类型
是否必选
说明
isSuccess
Boolean
是
是否储存成功true/false
extraInfo
String
否
仅在saveToPhotoAlbum中设置后才会有此参数
errorStr
String
否
仅isSuccess为false时有此参数,储存失败的错误原因
平台支持
Android2.2+
iOS7.0+
版本支持
Android3.0.0+
iOS3.0.0+
示例
1.window.uexOnload=function(type){
2.uexImage.cbSaveToPhotoAlbum=function(info){
3.alert(info);
4.}
5.}
2.3、监听方法
onPickerClosed照片选择器被关闭的监听方法
uexImage.onPickerClosed(param);
说明
∙照片选择器被关闭时,会回调此监听方法
参数
param为json字符串,包含的参数如下
参数名称
参数类型
是否必选
说明
isCancelled
Boolean
是
选择器是否是由于点击取消而关闭
detailedImageInfo
Array
否,仅isCancelled为false且openPicker有设置detailedInfo为true时才有此参数
导出的图片的信息uexImageInfo结构构成的数组
data
Array
否,仅isCancelled为false时有此参数
导出的图片地址构成的数组
∙即使只选择一张图片detailedImageInfo和imageInfo也是数组
∙uexImageInfo结构如下定义
1.varuexImageInfo={
2.localPath:
//String,必选,图片地址
3.timestamp:
//Number,可选,图片创建时间的10位时间戳(此参数读取自图片的EXIF数据,如无法获取或不存在,则无此参数)
4.longitude:
//Number,可选,图片拍摄地点的经度(此参数读取自图片的EXIF数据,如无法获取或不存在,则无此参数)
5.latitude:
//Number,可选,图片拍摄地点的纬度(此参数读取自图片的EXIF数据,如无法获取或不存在,则无此参数)
6.altitude:
//Number,可选,图片拍摄地点的海拔(此参数读取自图片的EXIF数据,如无法获取或不存在,则无此参数)
7.}
示例
1.window.uexOnload=function(type){
2.uexImage.onPickerClosed=function(info){
3.alert(info);
4.}
5.}
onBrowserClosed图片浏览器被关闭的监听方法
uexImage.onBrowserClosed();
说明
∙当图片浏览器被关闭时,会回调此监听方法
参数
无
平台支持
Android2.2+
iOS7.0+
版本支持
Android3.0.0+
iOS3.0.0+
示例
1.window.uexOnload=function(type){
2.uexImage.onBrowserClosed=function(){
3.alert("图片浏览器被关闭");
4.}
5.}
onCropperClosed图片裁剪器被关闭的监听方法
uexImage.onCropperClosed(param);
说明
∙照片选择器被关闭时,会回调此监听方法
参数
param为json字符串,包含的参数如下
参数名称
参数类型
是否必选
说明
isCancelled
Boolean
是
选择器是否是由于点击取消而关闭
data
String
否,仅isCancelled为false时有此参数
裁剪后的图片地址
平台支持
Android2.2+
iOS7.0+
版本支持
Android3.0.0+
iOS3.0.0+
示例
1.window.uexOnload=function(type){
2.uexImage.onCropperClosed=function(info){
3.alert(info);
4.}
5.}
3、更新历史
iOS
API版本:
uexImage-3.0.5
最近更新时间:
2015-12-26
历史发布版本
更新内容
3.0.5
添加IDE支持
3.0.4
新增接口setIpadPopEnable
3.0.3
删去资源包中多余的info.plist
3.0.2
修复armv7环境会编译失败的bug
3.0.1
修复openCropper没有国际化的问题
3.0.0
uexImage发布
Android
API版本:
uexImage-3.0.3
最近更新时间:
2015-12-26
历史发布版本
更新内容
3.0.3
修复在某些机型上图片裁剪失败的问题
3.0.2
修复图片压缩质量错误问题
3.0.1
去掉插件中的ActivityGroup,配合引擎升级
3.0.0
uexImage发布
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- AppCan 插件 API 功能 扩展 uexImage
![提示](https://static.bdocx.com/images/bang_tan.gif)