从相册选图

使用说明

import { MImagePicker } from "@yl/super-jssdk";
MImagePicker.openAlbum(optional);

参数说明

参数 类型 必填 作用
optional Object 非必选参数

optional

参数 类型 必填 作用
paths array 图片存储路径列表,paths 内容为存放图片的绝对路径(须含文件名)。
Tips:
1、系统相册仅支持图片单选,若 paths 中有多个内容,则取 paths[0];
2、自定义相册支持图片单选和多选,当 paths.length > 1 时启用多选功能;
maxSelectCount number 默认为 1,paths 参数不传时,该参数才生效,使用 maxSelectCount 参数代替 paths 参数去创建 maxSelectCount 个图片存储路径
options Object 可选参数
type string 调用插件类型,可选:image-pickerphoto,默认 image-picker

MImagePicker options 结构说明

字段名称 类型 说明
customMode boolean 是否启用自定义相册,为 true 时启用自定义相册,false 启用系统相册,不传或传其他值时默认 false
edit boolean 是否启用图片编辑功能,默认 false 不启用
editConfig json 编辑图片功能配置项 editConfig
editConfig 结构说明
字段名称 类型 说明
cropAspectRatio string 裁剪框宽高比,格式:整形数字:整形数字,如"1:1","4:3","16:9";格式不合法或不传该字段时用户可自由调整宽高比。1.2.5 版本开始生效
limits array 图片编辑功能配置项,仅在 edit=true 时生效。必须开启一个功能,否则忽略 limits 参数,开启所有功能可传入参数释义如下:limit 参数
autoSelected string 自动选中激活编辑功能 默认所有编辑功能都不主动激活 可传入参数释义如下:limit 参数

limit参数 1.3.4 版本开始生效

limit 说明
shape 图形,如果没有传入,隐藏此功能
doodle 涂鸦,如果没有传入,隐藏此功能
text 添加文字,如果没有传入,隐藏此功能
crop 裁剪,如果没有传入,隐藏此功能
mosaic 马赛克,如果没有传入,隐藏此功能

MPhoto options 结构说明

  • 单选时
字段名称 类型 说明
keepOriginSize boolean 是保存图片时保持图片原有尺寸,不做宽高处理,默认值false
  • 多选时
字段名称 类型 说明
navibarColor string 导航栏颜色,格式为16进制,推荐值(即默认值):#464646
titleColor string 导航栏标题颜色,格式为16进制,推荐值(即默认值):#FFFFFF.
selectedIconColor string 选中icon颜色,格式为16进制,推荐值(即默认值):#7fff00
unSelectedIconColor string 未选中icon颜色,格式为16进制,推荐值(即默认值):#808080.
backItemColor string 返回按钮颜色,格式为16进制,推荐值(即默认值):#FFFFFF.
selectedNumberColor string 图片选取个数文字颜色,格式为16进制,推荐值(即默认值):#F08478.
selectedNumberBgColor string 片选取个数背景颜色,格式为16进制,推荐值(即默认值):#FFFFFF.
destVideoPath string 剪辑视频的存放地址,为空时只能选择图片,不为空时可选择视频(图片&视频不能同时选择) 从2.3.1版本开始生效
videoRatio string 0~1,剪辑视频的压缩比例,默认0.5,从2.3.1版本开始生效,此接口仅支持安卓
vedioQualityType string 视频裁剪视频压缩类型,0:高清画质;1:中等画质;2:低画质,默认为0,从2.3.1版本开始生效,此接口仅支持iOS

返回说明

参数 类型 作用
resolve(result) Function 成功回调,result 为结果数组(result.length ≤ paths.length),result 内容
reject(err) Function 失败回调,err 为详细的错误信息,是一个 json 对象,例如:{"errCode": -1, "errMsg":"some explain of error."}

result 数据

[{"code":0, //code为0是图片选取成功,非0时均为失败;"result":"path", //图片存储路径,从前端传入paths遍历后得到"errMsg":"失败错误具体原因"
}]

代码示例

// 传路径
MYSDK.MImagePicker.openAlbum({
  paths: [
    cordova.file.externalDataDirectory + 'test1.jpg',
    cordova.file.externalDataDirectory + 'test2.jpg',
  ]
}).then(res => {
  console.log('res', res);
}).catch(err => {
  console.log('err', err);
})

//传参数 maxSelectCount,内部自动生成 maxSelectCount 个图片路径
MYSDK.MImagePicker.openAlbum({
  maxSelectCount: 3
}).then(res => {
  console.log('res', res);
}).catch(err => {
  console.log('err', err);
})

results matching ""

    No results matching ""