图片
选择本地图片
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
const params = {
count:'9',
sourceType:['album','camera']
}
window.ksoxz_sdk.chooseImage({params, onSuccess, onError});参数说明
| 参数 | 类型 | 描述 | 是否必须 | 备注 |
|---|---|---|---|---|
| count | number | 选择图片的数量 | 否,默认 9 | / |
| sourceType | string[] | 图片来源 | 否,默认全部来源 | / |
| enableWatermark | boolean | 是否启用水印功能 | 否 | 默认为"false" |
| watermarkConfig | object | 水印配置 | 是 | 水印属性及背景水印配置 |
| sizeType | string[] | 选择原图,或进行压缩 | 否,默认值["original","compressed"] | ["original"]:选择原图。 ["compressed"]:强制对图片质量进行压缩。 ["original","compressed"]: 默认开启压缩,但可手动选择原图。 |
sourceType 类型
| 类型 | 描述 |
|---|---|
album | 相册 |
| camera | 相机 |
水印配置说明
| 参数 | 类型 | 描述 | 是否必须 | 备注 |
|---|---|---|---|---|
| watermarkText | array | 水印内容 | 是 | 最多支持传入5组数据 |
| ∟ text | string | 水印文本内容 | 是 | 文本 |
| ∟ icon | string | 水印对应图标 | 否 | 如果不需要图标,可为空 |
| position | string | 水印位置 | 否 | 'top', 'bottom',默认为'bottom',处于图片底部位置 |
| fontSize | string | 水印字体大小 | 否 | 默认为14,单位px |
| color | string | 水印字体颜色 | 否 | 格式为CSS颜色值,如'#000000'(黑色),默认为'#FFFFFF'(白色) |
| backgroundStyleColor | string | 水印背景颜色 | 否 | 格式为CSS颜色值,如'#000000'(黑色),默认为'#000000'(黑色) |
| backgroundStyleOpacity | string | 水印背景透明度 | 否 | 0-1,默认值0.5.最大值为1表示不透明 |
返回结果
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| imageInfos | object | 文件信息数组 | imageInfo |
imageInfo
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| imageSize | number | 图片大小 | / |
| imagePath | string | 图片路径 | Android、WIN 支持直接在 img 标签中显示 iOS 和 MAC 需要通过 getImageBase64 接口得到图片的 base64 数据才支持在 img 标签中显示 |
| imageName | string | 图片名称 | / |
| localID | string | 本地资源ID | Android、WIN 支持直接在 img 标签中显示 iOS 和 MAC 需要通过 getImageBase64 接口得到图片的 base64 数据才支持在 img 标签中显示 |
预览图片
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | 支持 |
const params = {
urls: [
'https://qn.cache.wpscdn.cn/koa/static/avatar_v2/schedule_avatar.png',
'https://qn.cache.wpscdn.cn/koa/static/avatar/workbench_avatar.png',
'https://qn.cache.wpscdn.cn/koa/static/avatar_v2/meeting_avatar.png',
'https://qn.cache.wpscdn.cn/koa/static/avatar_v2/docs_avatar.png',
'https://qn.cache.wpscdn.cn/koa/static/avatar/oms_avatar.png',
],
currentIndex: '2'
};
window.ksoxz_sdk.previewImage({params});参数说明
| 参数 | 类型 | 描述 | 是否必须 | 备注 |
|---|---|---|---|---|
| url | string | 图片路径 | 否 | 单张图片预览,仅 PC 客户端支持 |
| urls | string[] | 需要预览的图片 url 或者本地路径 | 否 | 仅移动端支持 |
| currentIndex | number | 当前预览图片的索引值 | 否,默认为0,第一张图 | / |
获取图片 base64
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | / | 支持 | / |
const params = {
filePath: ''
};
window.ksoxz_sdk.getImageBase64({params, onSuccess, onError});参数说明
| 参数 | 类型 | 描述 | 是否必须 | 备注 |
|---|---|---|---|---|
| filePath | string | 图片文件路径 | 是 | / |
返回结果
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| imageBase64 | string | 图片 base64 | / |
保存图片到相册
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
const params = {
url:"https://qn.cache.wpscdn.cn/koa/static/avatar_v2/docs_avatar.png"
};
window.ksoxz_sdk.saveImageToAlbum({param, onSuccess, onError});参数说明
| 参数 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| url | string | 是 | 图片 url | / |