webToImage

来自于:APICloud立即使用

概述

本模块封装了把 webview 转换成 图片的功能。调用本模块的transImage 接口,可把当前 webview 显示的内容转换成一张图片。注意,本模块只能把当前的 webview 页面转换为 图片,如果当前页面上打开了一个带 UI 界面的模块,会被忽略掉。

transImage

把模块所依附的当前 webview 转换为图片

transImage({params}, callback(ret))

params

save:

  • 类型:JSON 对象
  • 描述:(可选项)转换的 图片的保存信息
  • 内部字段:
{
    path: '',       //(可选项)字符串类型;图片保存路径,要求本地路径(fs://),如:fs://camerWeibo;若不传则默认存放到缓存目录
    name: ''        //字符串类型;图片名
}

callback(ret)

ret:

  • 类型:JSON对象
  • 描述:返回值
{
    status: true,    // 布尔类型; 是否转换成功,true|false 
    path: ''         // 字符串类型;转换的图片在本地保存的路径(绝对路径)
}

示例代码

var webToImage = api.require('webToImage');
webToImage.transImage({
    save: {
       path: 'fs://webToImage',
       name: 'currentWebviewImage'
    }
}, function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS系统

可提供的1.0.0及更高版本

clearCache

当 webToImage 接口内 save 参数未传 path 值,则模块会将转换后的 图片保存在缓存目录。调用本接口,可清除本模块产生的所有图片。调用 api 对象下的 clearCache 接口会清除缓存目录下所有文件(不仅本模块产生的图片文件)。

clearCache()

示例代码

var webToImage = api.require('webToImage');
webToImage.clearCache();

可用性

iOS系统

可提供的1.0.0及更高版本