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 字符串 包含的参数如下 参数名称参数类型 是 否 必 选 说明默认值 minNumber 否 最小选择数量 传 0 表 示无限制 1 maxNumber 否 最大选择数量 传 0 表 示无限制 0 qualityNumber 否 JPG 压缩质量 取值范 围 0 1 越大表示质量 越好 0 5 usePngBoolean 否 用 png 格式导出图片 此参数为 true 时 quality 参数无效 false detailedInfoBoolean 否 此参数为 true 时 回调 中会包含图片的额外信 息 false png 无损且支持透明色 但文件体积比 jpg 大得多 用户应按需求自行选择图片文件格式 平台支持 Android 2 2 iOS 7 0 版本支持 Android 3 0 0 iOS 3 0 0 示例 1 var data 2 min 2 3 max 3 4 quality 0 8 5 detailedInfo true 6 7 var json JSON stringify data 8 uexImage openPicker json openBrowser 打开图片浏览器 uexImage openBrowser param 说明 打开一个可以浏览图片的浏览器 图片路径支持 wgt wgts res file http https 相关 onBrowserClosed 图片浏览器被关闭的监听方法 参数 param 为 json 字符串 包含的参数如下 参数名称 参数类 型 是否必选说明默认值 displayActionButtonBoolean 否显示分享按钮 false displayNavArrowsBoolean 否 显示切换箭头 仅 iOS 支持此参数 false enableGridBoolean 否允许九宫格视图 true startOnGridBoolean 否以九宫格视图起始 false startIndexNumber 否 非负整数 起始图 片位置 0 dataArray 是 图片资源构成的数 组 无 即使只浏览一张图片 data 也必须是数组 data 内的元素可以是 字符串 或者是 字典 格式 传字符串时 此字符串应为图片资源路径 传字典时 结构如下 1 2 src String 必选 图片资源路径 支持 wgt wgts res file http https 3 thumb String 可选 图片缩略图路径 4 desc String 可选 为图片添加一段文字描述 5 平台支持 Android 2 2 iOS 7 0 版本支持 Android 3 0 0 iOS 3 0 0 示例 1 var data 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 var json JSON stringify data 24 uexImage openBrowser json openCropper 打开图片裁剪器 uexImage openCropper param 说明 打开一个图片裁剪器 导出裁剪后的图片 并返回图片路径 本 API 只有裁剪功能 裁剪后的图片大小即为所裁剪部分在原图中的大小 相关 onCropperClosed 图片裁剪器被关闭的监听方法 参数 param 为 json 字符串 包含的参数如下 参数名称参数类型 是否 必选 说明默认值 srcString 否 图片路径 支持 wgt wgts file res 无 qualityNumber 否 JPG 压缩质量 取值范围 0 1 越大表示质量越好 0 5 usePngBoolean 否 用 png 格式导出图片 此 参数为 true 时 quality 参 数无效 false modeNumber 否 1 正方型裁剪 2 圆形裁 剪 仅 iOS 支持圆形裁剪 1 平台支持 Android 2 2 iOS 7 0 版本支持 Android 3 0 0 iOS 3 0 0 示例 1 var data 2 src res photo5 jpg 3 mode 2 4 5 var json JSON stringify data 6 uexImage openCropper json saveToPhotoAlbum 储存到相册 uexImage saveToPhotoAlbum param 说明 将本地图片储存到系统相册 相关 cbSaveToPhotoAlbum 储存到相册的回调方法 参数 param 为 json 字符串 包含的参数如下 参数名称参数类型是否必选说明 localPathString 是 图片路径 支持 res wgt wgts file extraInfoString 否 任意字符串 设置后会随 cbSaveToPhotoAlbum 传 出 extraInfo 可作唯一标识符用 平台支持 Android 2 2 iOS 7 0 版本支持 Android 3 0 0 iOS 3 0 0 示例 1 var data 2 localPath res photo4 jpg 3 extraInfo aaaaa 4 5 var json JSON stringify data 6 uexImage saveToPhotoAlbum json clearOutputImages 清除由本插件导出的所有图片文件 uexImage clearOutputImages 说明 清除由本插件的 openPicker openCropper 接口所生成的图片文件 若您的 APP 有多个 widget 则只会清除由当前 widget 所生成的图片文件 相关 cbClearOutputImages 清除由本插件导出的所有图片文件的回调方法 参数 无 平台支持 Android 2 2 iOS 7 0 版本支持 Android 3 0 0 iOS 3 0 0 示例 1 uexImage clearOutputImages setIpadPopEnable 设置 iPad 是否启用 pop 窗口 uexImage setIpadPopEnable flag 说明 插件在 iPad 上默认用 pop 窗口展示插件页面 通过调用此接口 可以选择是否禁用 pop 窗口 改用全屏展示插件页面 参数 参数名称参数类型 是否必 选 说明 flagNumber 是 为 0 时表示禁用 pop 窗口 非 0 时表示启用 pop 窗口 平台支持 iOS 7 0 版本支持 iOS 3 0 4 示例 1 uexImage setIpadPopEnable 0 cbClearOutputImages 清除由本插件导出的所有图片文件的回调方法 uexImage cbClearOutputImages param 说明 清除由本插件导出的所有图片文件后会调用此方法 参数 param 为 json 字符串 包含的参数如下 参数名称参数类型是否必选说明 statusString 是成功返回 ok 平台支持 Android 2 2 iOS 7 0 版本支持 Android 3 0 0 iOS 3 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 字符串 包含的参数如下 参数名称参数类型是否必选说明 isSuccessBoolean 是是否储存成功 true false extraInfoString 否 仅在 saveToPhotoAlbum 中 设置后才会有此参数 errorStrString 否 仅 isSuccess 为 false 时有此 参数 储存失败的错误原因 平台支持 Android 2 2 iOS 7 0 版本支持 Android 3 0 0 iOS 3 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 字符串 包含的参数如下 参数名称 参数类 型 是否必选说明 isCancelledBoolean 是 选择器是否是由于点击 取消而关闭 detailedImageInfoArray 否 仅 isCancelled 为 导出的图片的信息 参数名称 参数类 型 是否必选说明 false 且 openPicker 有设 置 detailedInfo 为 true 时 才有此参数 uexImageInfo 结构构 成的数组 dataArray 否 仅 isCancelled 为 false 时有此参数 导出的图片地址构成的 数组 即使只选择一张图片 detailedImageInfo 和 imageInfo 也是数组 uexImageInfo 结构如下定义 1 var uexImageInfo 2 localPath String 必选 图片地址 3 timestamp Number 可选 图片创建时间的 10 位时间戳 此参数读取自图片的 EXI F 数据 如无法获取或不存在 则无此参数 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 说明 当图片浏览器被关闭时 会回调此监听方法 参数 无 平台支持 Android 2 2 iOS 7 0 版本支持 Android 3 0 0 iOS 3 0 0 示例 1 window uexOnload function type 2 uexImage onBrowserClosed function 3 alert 图片浏览器被关闭 4 5 onCropperClosed 图片裁剪器被关闭的监听方法 uexImage onCropperClosed param 说明 照片选择器被关闭时 会回调此监听方法 参数 param 为 json