pictureWatermark

来自于:开发者

概述

pictureWatermark 是一个给图片添加水印的模块。支持给任意位置添加水印。可以满足开发者比如给自己的照片加版权,打水印等功能。

getPictureSize

获取原图的大小

getPictureSize({params}, callback(ret))

params

path:

  • 类型:字符串
  • 描述:需要添加水印的图片路径,要求本地路径( fs://、 widget://)

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   w:100,            //数字类型;图片的宽度
   h:100             //数字类型;图片的高度
}

示例代码

var pictureWatermark = api.require('pictureWatermark');
pictureWatermark.getPictureSize({

    path:'widget//:a.png'

}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

mark

添加水印

mark({params}, callback(ret))

params

watermark:

  • 类型:JSON 对象
  • 描述:水印配置
  • 默认值:见内部字段
  • 内部字段:
 {
    rect: {                   //(可选项)JSON对象;水印的大小
         x: 0,                //(可选项)数字类型;水印左上角的 x 坐标(相对于所属的原始图片的位置);默认:0
         y: 0,                //(可选项)数字类型;水印左上角的 y 坐标(相对于所属的原始图片的位置);默认:0
         w:50,                //(可选项)数字类型;水印图片的宽度;默认:50
         h:30                 //(可选项)数字类型;水印图片的高度;默认:30
    },
    image: 'widget://b.png',  //(可选项)字符串类型;水印图标路径(本地路径,支持fs://、widget://);
 }

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   status: true          //布尔类型;是否成功添加水印,true|false
   path:''               //字符串类型;添加水印成功后的图片的绝对路径; 仅当 status 为 true 时有效。
}

示例代码

var pictureWatermark = api.require('pictureWatermark');
            pictureWatermark.mark({
                watermark : {
                    rect : {
                        x : 200,
                        y : 200,
                        w : 50,
                        h : 30
                    },
                    image : 'widget://image/2.png'
                },
            }, function(ret, err) {
                if (ret) {
                    alert(JSON.stringify(ret));
                }
            });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

clearCache

清除本地缓存的水印图片,本接口只清除本模块缓存的数据,若要清除本 app 缓存的所有数据则调用 api.clearCache

clearCache()

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本