使用该图片剪裁插件首先要引入必要的js和css文件
<script src="/path/to/jquery.js"></script> <link href="/path/to/cropper.css" rel="stylesheet"> <script src="/path/to/cropper.js"></script>
HTML结构
<div class="container"> <img src="picture.jpg"> </div>
调用插件
可以使用$.fn.cropper方法来初始化该图片剪裁插件
$('.container > img').cropper({ aspectRatio: 16 / 9, crop: function(data) { // Output the result data for cropping image. } });
注意:剪裁区域的尺寸继承自图片的父容器(包裹容器),所以要确保包裹图片的是一个可见的块级元素。输出的剪裁数据基于原始的图片尺寸,你可以使用这些数据直接剪裁图片。如果你要使用跨源图片来作为剪裁图片,请确保你的浏览器支持HTML5 CORS settings attributes,并且你的图片服务器支持Access-Control-Allow-Origin属性。
配置参数
你可以通过$().cropper(options)方法来设置参数。如果你想改变全局默认参数,可以使用$.fn.cropper.setDefaults(options)方法。
aspectRatio:类型:Number,默认值NaN。设置剪裁容器的比例。
crop:类型:Function,默认值null。当改变剪裁容器或图片时的事件函数。
preview:类型:String(jQuery选择器),默认值”。添加额外的元素(容器)的预览。
注意:
1.最大宽度是剪裁容器的初始化宽度
最大高度是剪裁容器的初始化高度
如果你设置了aspectRatio参数,确保预览容器具有相同的比例
名称 | 类型及默认值 | 说明 |
---|---|---|
strict: | 类型:Boolean,默认值true。 | 在strict模式中,canvas不能小于容器,剪裁容器不能再canvas之外。 |
responsive: | 类型:Boolean,默认值true。 | 是否在窗口尺寸改变的时候重置cropper。 |
checkImageOrigin: | 类型:Boolean,默认值true。 | 默认情况下,插件会检测图片的源,如果是跨域图片,图片元素会被添加crossOrigin class,并会为图片的url添加一个时间戳来使getCroppedCanvas变为可用。添加时间戳会使图片重新加载,以使跨域图片能够使用getCroppedCanvas。在图片上添加crossOrigin class会阻止在图片url上添加时间戳,及图片的重新加载。 |
background: | 类型:Boolean,默认值true。 | 是否在容器上显示网格背景。 |
modal: | 类型:Boolean,默认值true。 | 是否在剪裁框上显示黑色的模态窗口。 |
guides: | 类型:Boolean,默认值true。 | 是否在剪裁框上显示虚线。 |
highlight: | 类型:Boolean,默认值true。 | 是否在剪裁框上显示白色的模态窗口。 |
autoCrop: | 类型:Boolean,默认值true。 | 是否在初始化时允许自动剪裁图片。 |
autoCropArea: | 类型:Number,默认值0.8(图片的80%)。 | 0-1之间的数值,定义自动剪裁区域的大小。 |
dragCrop: | 类型:Boolean,默认值true。 | 是否允许移除当前的剪裁框,并通过拖动来新建一个剪裁框区域。 |
movable: | 类型:Boolean,默认值true。 | 是否允许移动剪裁框。 |
resizable: | 类型:Boolean,默认值true。 | 是否允许改变剪裁框的大小。 |
zoomable: | 类型:Boolean,默认值true。 | 是否允许放大缩小图片。 |
mouseWheelZoom: | 类型:Boolean,默认值true。 | 是否允许通过鼠标滚轮来缩放图片。 |
touchDragZoom: | 类型:Boolean,默认值true。 | 是否允许通过触摸移动来缩放图片。 |
rotatable: | 类型:Boolean,默认值true。 | 是否允许旋转图片。 |
minContainerWidth: | 类型:Number,默认值200。 | 容器的最小宽度。 |
minContainerHeight: | 类型:Number,默认值100。 | 容器的最小高度。 |
minCanvasWidth: | 类型:Number,默认值0。 | canvas 的最小宽度(image wrapper)。 |
minCanvasHeight: | 类型:Number,默认值0。 | canvas 的最小高度(image wrapper)。 |
build: | 类型:Function,默认值null。 | build.cropper事件的简写方式。 |
built: | 类型:Function,默认值null。 | built.cropper事件的简写方式。 |
dragstart: | 类型:Function,默认值null。 | dragstart.cropper事件的简写方式。 |
dragmove: | 类型:Function,默认值null。 | dragmove.cropper事件的简写方式。 |
dragend: | 类型:Function,默认值null。 | dragend.cropper事件的简写方式。 |
zoomin: | 类型:Function,默认值null。 | zoomin.cropper事件的简写方式。 |
zoomout: | 类型:Function,默认值null。 | zoomout.cropper事件的简写方式。 |
初始化插件及相关参数
var image = document.getElementById("image"); var cropper = new Cropper(image,{ //裁剪框的比例1/1 aspectRatio:NaN, //视图模式 viewMode:1,//0,1-,2-,3让图片填满画布 //开启预览效果 preview:'.small', //拖拽模式 // dragMode:'crop',//参数:move-可以移动图片和框,crop-拖拽新建框 dragMode:'move',//参数:move-可以移动图片和框,crop-拖拽新建框 //在调整窗口大小时,会重新渲染cropper responsive:true, //在调整窗口大小时,恢复裁剪区 restore:true, //检查图片是否为跨域图片 checkCrossOrigin:true, //是否开启遮罩,将未选中的地方暗色处理 modal:true, //是否显示裁剪的虚线 guides:true, //将选中的区域亮色处理 highlight:true,//默认 //是否显示网格背景 background:true, //裁剪框是否在图片的中心 center:true, //当初始化的时候(是否自动显示裁剪框). autoCrop:true, //当初始化时,裁剪框的大小与原图的比例 autoCropArea:0.8,//0.8是默认,1是1比1 //是否允许移动图片 movable:true,//默认为true //是否允许旋转图片(函数调用时)() rotatable:true, //是否允许翻转图片(问题) scalable:true, //是否可以缩放图片 zoomable:true,//false为不能放大缩小 //是否可以通过触摸的形式来放大图片(手机端) zoomOnTouch:true, //是否允许用鼠标来放大货缩小图片 zoomOnWheel:true, //设置鼠标控制缩放的比例 wheelZoomRatio:0.2, //是否可以移动裁剪框 cropBoxMovable:true,//裁剪框不动,图片动。当movable:true //是否可以调整裁剪框的大小,默认true cropBoxResizable:true, //设置dragMode 是否可以相互切换(条件:双击鼠标可以切换) toggleDragModeOnDblclick:true, //设置Container的w和h minContainerWidth:0, minContainerHeight:200, //设置canvas的w和h // canvas太大Container装不下 minCanvasWidth:0, minCanvasHeight:0, //设置裁剪层 minCropBoxWidth:0, minCropBoxHeight:100, //一.crop开始-过程-结束的函数 //1.当插件准备完成时,执行此函数 ready:function(e){ // alert("ready"); }, //2.当裁剪框开始移动的时候会执行的函数 cropstart:function(e){ // console.log("start"); }, //3.裁剪框移动的时候会执行的函数(每一帧都会调用) cropmove:function(e){ // console.log("move"); }, //3.裁剪框移动结束的时候会执行的函数 cropend:function(e){ // console.log("end"); }, //二、重置与清除函数 //1.在裁剪框发生变化的时候会调用的函数 crop:function(e){ // console.log("cropChange"); } }) //将图像以及裁剪重置为初始状态 cropper.reset(); //清除裁剪框 cropper.clear(); //替换图片,参数1:替换的图片,参数二,boolean是否保持原来的比例 cropper.replace("../images/picture.jpg",false); //解锁 cropper.enable(); //锁定 cropper.disable(); //销毁cropper,并在图像中将整个cropper销毁(将插件销毁) cropper.destroy(); //移动x轴坐标,移动图片.相对自己的位置 cropper.move(1,0); //移动y轴坐标 cropper.move(0,1); //移动到x,有一个具体的坐标 cropper.moveTo(2,0); //移动到y cropper.moveTo(0,2); //放大 cropper.zoom(0.1); //缩小 cropper.zoom(-0.1); //放大到,原来的两倍 cropper.zoomTo(2); //缩小到 cropper.zoomTo(0.2); //逆时针旋转,度数 cropper.rotate(-45); //顺时针旋转(正数) cropper.rotate(45); //逆时针旋转到(正数) cropper.rotate(-45); //顺时针旋转(正数) cropper.rotate(45); //沿y轴翻转,当前轴不变,另一轴为-1 cropper.scale(-1,1); //沿x轴翻转 cropper.scale(1,-1); //缩放图片x坐标 cropper.scale(-1); //缩放图片X坐标 cropper.scaleX(0.5); //缩放图片Y坐标 cropper.scaleY(2); //获取数据信息(裁剪框的数据) console.log(cropper.getData()); //获取数据信息(裁剪框的数据) cropper.setData({width:200,height:100}); //获取Container的数据信息,没有setContainerData函数console.log(cropper.getContainerData()); //获取image的数据信息,就是图片大小 console.log(cropper.getImageData()); //获取Canvas的数据信息 console.log(cropper.getCanvasData()); //设置Canvas的数据信息 console.log(cropper.setCanvasData({left:0,top:0,width:200,height:200})); //获得裁剪框的详细数据 console.log(cropper.getCropBoxData()); //获得裁剪框的详细数据 console.log(cropper.setCropBoxData({left:0,top:100,width:00,height:200})); //获得裁剪后的图片,裁剪后的base64编码 **********重要*********** $("#message").append(cropper.getCroppedCanvas()); //修改裁剪框的长宽比 cropper.setAspectRatio(1/1); //设置拖拽模式,none,crop,move cropper.setDragMode("crop"); //获取canvas绘制的剪裁图像。 在这之后,你可以直接将canvas作为图片显示,或使用canvas.toDataURL方法获取图像的数据链接,或者使用canvas.toBlob方法获取一个blob,并通过FormData方法将它更新到服务器上(如果浏览器支持这些API) cropper.getCroppedCanvas()