import { MImagePicker } from "@yl/super-jssdk";
MImagePicker.imageProcess(optional);
| 参数 | 类型 | 必填 | 作用 |
|---|---|---|---|
| optional | Object | 是 | 必选参数 |
optional
| 参数 | 类型 | 必填 | 作用 |
|---|---|---|---|
| path | string | 是 | 需要处理的图片绝对路径 |
| options | Object | 否 | 可选参数 |
| type | string | 否 | 调用插件类型,可选:image-picker、photo,默认 image-picker |
MImagePicker options 结构说明
| 字段名称 | 类型 | 说明 |
|---|---|---|
| saveToAlbum | boolean | 是否保存到相册,true: 存到相册;false:不存入相册;不传则默认为 false。 |
| ratio | float | 图片压缩比例(以减小清晰度的代价,有助于减小物理空间),范围 0 ~ 1,压缩程度与 ratio 成反比,默认 0.8 |
| width | int | 图片宽度,传入值宽高与图片真实宽高比率对比,取最大值对图片进行宽高等比压缩,最终值可能与传入值有偏差;</br>默认值:</br>iOS:屏幕宽*手机缩放比率,例如:iPhone 6plus 默认屏幕的3倍大小,iPhone5 默认屏幕的 2 倍大小;</br>Android:1080px |
| height | int | 图片高度,传入值宽高与图片真实宽高比率对比,取最大值对图片进行宽高等比压缩,最终值可能与传入值有偏差;</br>默认值:</br>iOS:屏幕宽*手机缩放比率,例如:iPhone 6plus 默认屏幕的 3 倍大小,iPhone5 默认屏幕的 2 倍大小;</br>Android:1920px |
| keepOrigin | boolean | 是否保持原图,为 true 时,不做缩放,默认 false |
| watermarkConfig | json | 图片水印,详细配置如下 |
注意:width 和 height 如果小于待压缩图片尺寸,那么图片宽高不做处理
watermarkConfig 参数字段说明
| 字段名称 | 类型 | 说明 |
|---|---|---|
| textBackground | string | 文字整行的背景颜色,格式为 16 进制,推荐值(即默认值):#40000000 |
| textAlignment | string | 标识文本在水平方向的对齐方式,竖直方向居中显示;</br>可取值:</br>left:文本靠左对齐;</br>center:文本居中对齐;</br>right:文本靠右对齐;</br>传错或不传则默认为 left。 |
| boardPosition | string | 标识整个水印背景框在竖直方向的位置;</br>可取值:</br>top:水印添加在屏幕顶部;</br>center:水印添加在屏幕中间;</br>bottom:水印添加在屏幕底部;</br>传错或不传则默认为 bottom。 |
| textColumns | array | 一个 json 下标对象显示一行,从上往下顺序显示.文本行数随内容变化,超出部分省略号显示,</br>示例:</br>[{"iconPath":"图标路径,只支持本地","text":"文本说明","textColor":"文本颜色,格式为16进制,默认值:#FFFFFF"},...] |
MPhoto options 结构说明
| 字段名称 | 类型 | 说明 |
|---|---|---|
| ratio | Number | 图片保存时的压缩比例(以减小清晰度的代价,有助于减小物理空间),范围:0-100, 100为不压缩。值越小,压缩程度越高。默认值80 |
| reqWidth | Number | 请求生成的图片宽度, 默认值640 (ios:6plus默认屏幕的3倍大小,其他机型默认屏幕的2倍大小); |
| reqHeight | Number | 请求生成的图片高度,默认值960 (ios:6plus默认屏幕的3倍大小,其他机型默认屏幕的2倍大小); |
| keepOriginSize | boolean | 保存图片时保持图片原有尺寸,不做宽高处理(比指定尺寸优先级高) |
| text | string | 添加到图片上的文本,文本长度不宜超出屏幕宽度。为兼容小屏手机,建议20个汉字以内(数字字母两个算一个汉字) |
| textBackground | string | 文字整行的背景颜色,格式为16进制,推荐值(即默认值):#40000000 |
| textColor | Numbestring值80 | 文字颜色,格式为16进制,推荐值(即默认值):#FFFFFF. |
| horizontalOrientation | Number | 文本框水平布局方向.可传值:1左, 2水平居中, 3右, 默认3右. 仅text不为空有效 |
| verticalOrientation | Number | 文本框垂直布局方向.可传值:1上, 2垂直居中, 3下, 默认3下. 仅text不为空有效 |
| 参数 | 类型 | 作用 |
|---|---|---|
| resolve(path) | Function | 成功回调。path为处理后的图片路径 |
| reject(err) | Function | 失败回调,err 为详细的错误信息,是一个 json 对象,例如:{"errCode": -1, "errMsg":"some explain of error."} |
MYSDK.MImagePicker.imageProcess({
// cordova.file.externalDataDirectory仅适用于Android,iOS本地路径参数请查阅本文档注意事项部分说明
path: cordova.file.externalDataDirectory + 'test.jpg',
})
.then(res => {
console.log('res', res);
}).catch(err =
console.log('err', err);
})