Jcrop 图像裁剪工具
一、 工具介绍
Jcrop 是一款用于前端上传图片时裁剪图片的优秀工具，目前微信公众平台的文章封面裁剪功能就是基于Jcrop实现的。
近期，在公司项目中，需要在图片上传时对图片进行裁剪等处理，因此找到了这款组件，实际使用中配合layui框架，也遇到一个坑在此记录一下
二、使用方法
1. 载入 CSS 文件
1 | <link rel="stylesheet" href="jquery.Jcrop.css"> |
2. 载入 JavaScript 文件
1 | <script src="jquery.js"></script> |
3. 给 IMG 标签加上 ID
1 | <img id="element_id" src="pic.jpg"> |
我遇到的坑就与这个有关，
img添加了样式width：100%img的父节点添加了layui的栅格样式，然后再框选的过程中，无法通过img.width获取到图像的真实显示大小，导致裁剪框的定位没有按照图片的缩放比例进行缩放
4. 调用 Jcrop
1 | $('#element_id').Jcrop(); |
三、参数说明
| 名称 | 默认值 | 说明 |
|---|---|---|
| allowSelect | true | 允许新选框 |
| allowMove | true | 允许选框移动 |
| allowResize | true | 允许选框缩放 |
| trackDocument | true | 拖动选框时，允许超出图像以外的地方时继续拖动。 |
| baseClass | ‘jcrop’ | 基础样式名前缀。说明：class="jcrop-holder"，更改的只是其中的 jcrop。 例：假设值为 “test”，那么样式名会更改为 “test-holder” |
| addClass | null | 添加样式。 例：假设值为 “test”，那么会添加样式到class="jcrop-holder test" |
| bgColor | ‘black’ | 背景颜色。颜色关键字、HEX、RGB 均可。 |
| bgOpacity | 0.6 | 背景透明度 |
| bgFade | false | 使用背景过渡效果 |
| borderOpacity | 0.4 | 选框边框透明度 |
| handleOpacity | 0.5 | 缩放按钮透明度 |
| handleSize | null | 缩放按钮大小 |
| aspectRatio | 0 | 选框宽高比。说明：width/height |
| keySupport | true | 支持键盘控制。按键列表：上下左右（移动选框）、Esc（取消选框） |
| createHandles | [‘n’,’s’,’e’,’w’,’nw’,’ne’,’se’,’sw’] | 设置边角控制器 |
| createDragbars | [‘n’,’s’,’e’,’w’] | 设置边框控制器 |
| createBorders | [‘n’,’s’,’e’,’w’] | 设置边框 |
| drawBorders | true | 绘制边框 |
| dragEdges | true | 允许拖动边框 |
| fixedSupport | true | 支持 fixed，例如：IE6、iOS4 |
| touchSupport | null | 支持触摸事件 |
| shade | null | 使用更好的遮罩 |
| boxWidth | 0 | 画布宽度 |
| boxHeight | 0 | 画布高度 |
| boundary | 2 | 边界。说明：可以从边界开始拖动鼠标选择裁剪区域 |
| fadeTime | 400 | 过度效果的时间 |
| animationDelay | 20 | 动画延迟 |
| swingSpeed | 3 | 过渡速度 |
| minSelect | [0, 0] | 选框最小选择尺寸。说明：若选框小于该尺寸，则自动取消选择 |
| maxSize | [0, 0] | 选框最大尺寸 |
| minSize | [0, 0] | 选框最小尺寸 |
| onChange | function() {} | 选框改变时的事件 |
| onSelect | function() {} | 选框选定时的事件 |
| onDblClick | function() {} | 在选框内双击时的事件 |
| onRelease | function() {} | 取消选框时的事件 |
三、API接口
1 | var jcropApi; |
| 名称 | 说明 |
|---|---|
| setImage(string, callback) | 设定（或改变）图像。例：jcropApi.setImage(‘newpic.jpg’) |
| setOptions(object) | 设定（或改变）参数，格式与初始化设置参数一样 |
| setSelect(array) | 创建选框，参数格式为：[x, y, x2, y2] |
| animateTo(array, callback) | 用动画效果创建选框，参数格式为：[x, y, x2, y2] |
| release() | 取消选框 |
| disable() | 禁用 Jcrop。说明：已有选框不会被清除。 |
| enable() | 启用 Jcrop |
| destroy() | 移除 Jcrop |
| tellSelect() | 获取选框的值（实际尺寸）。例：console.log(jcropApi.tellSelect()) |
| tellScaled() | 获取选框的值（界面尺寸）。例：console.log(jcropApi.tellScaled()) |
| getBounds() | 获取图片实际尺寸，格式为：[w, h] |
| getWidgetSize() | 获取图片显示尺寸，格式为：[w, h] |
| getScaleFactor() | 获取图片缩放的比例，格式为：[w, h] |