jquery.Jcrop API详解

港控/mmm° 2022-07-15 21:10 287阅读 0赞

Jcrop是一个[jQuery][]图片裁剪插件，它能为你的WEB应用程序快速简单地提供图片裁剪的功能。特点如下：

*  对所有图片均unobtrusively（无侵入的，保持DOM简洁）
 *  支持宽高比例锁定
 *  支持 minSize/maxSize设置
 *  支持改变选区或移 动选区时的回调（Callback）
 *  支持用键盘微调选区
 *  通过API创建互动，比如动画效果
 *  支持CSS样式  
    官网：[http://jcrop.org/][http_jcrop.org]  
    可下载例子进行学习  
    基本使用方法如下：  
    一、在head部分(和之间)插入相关css和js文件。

二、在head部分插入回调函数等相关处理参数。

三、给相关图片加上id以便识别。

这样就能实现最简单的裁剪效果，至于如何结合php等动态语句处理图片，在置顶的文章里已经给出了示例。  
下表给出基本options参数设置：

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th align="center">默认值</th> 
   <th align="right">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>allowSelect</td> 
   <td align="center">true</td> 
   <td align="right">允许新选框</td> 
  </tr> 
  <tr> 
   <td>allowMove</td> 
   <td align="center">true</td> 
   <td align="right">允许选框移动</td> 
  </tr> 
  <tr> 
   <td>allowResize</td> 
   <td align="center">true</td> 
   <td align="right">允许选框缩放</td> 
  </tr> 
  <tr> 
   <td>trackDocument</td> 
   <td align="center">true</td> 
   <td align="right"></td> 
  </tr> 
  <tr> 
   <td>baseClass</td> 
   <td align="center">“jcrop”</td> 
   <td align="right">基础样式名前缀。说明：class=”jcrop-holder”，更改的只是其中的 jcrop。</td> 
  </tr> 
  <tr> 
   <td>addClass</td> 
   <td align="center">null</td> 
   <td align="right">添加样式会。例：假设值为 “test”，那么会添加样式到 class=”test jcrop-holder”</td> 
  </tr> 
  <tr> 
   <td>bgColor</td> 
   <td align="center">“black”</td> 
   <td align="right">背景颜色。颜色关键字、HEX、RGB 均可。</td> 
  </tr> 
  <tr> 
   <td>bgOpacity</td> 
   <td align="center">0.6</td> 
   <td align="right">背景透明度</td> 
  </tr> 
  <tr> 
   <td>bgFade</td> 
   <td align="center">false</td> 
   <td align="right">使用背景过渡效果</td> 
  </tr> 
  <tr> 
   <td>borderOpacity</td> 
   <td align="center">0.4</td> 
   <td align="right">选框边框透明度</td> 
  </tr> 
  <tr> 
   <td>handleOpacity</td> 
   <td align="center">0.5</td> 
   <td align="right">缩放按钮透明度</td> 
  </tr> 
  <tr> 
   <td>handleSize</td> 
   <td align="center">9</td> 
   <td align="right">缩放按钮大小</td> 
  </tr> 
  <tr> 
   <td>handleOffset</td> 
   <td align="center">5</td> 
   <td align="right">缩放按钮与边框的距离</td> 
  </tr> 
  <tr> 
   <td>aspectRatio</td> 
   <td align="center">0</td> 
   <td align="right">选框宽高比。说明：width/height</td> 
  </tr> 
  <tr> 
   <td>keySupport</td> 
   <td align="center">true</td> 
   <td align="right">支持键盘控制。按键列表：上下左右（移动）、Esc（取消）、Tab（跳出裁剪框，到下一个）</td> 
  </tr> 
  <tr> 
   <td>cornerHandles</td> 
   <td align="center">true</td> 
   <td align="right">允许边角缩放</td> 
  </tr> 
  <tr> 
   <td>sideHandles</td> 
   <td align="center">true</td> 
   <td align="right">允许四边缩放</td> 
  </tr> 
  <tr> 
   <td>drawBorders</td> 
   <td align="center">true</td> 
   <td align="right">绘制边框</td> 
  </tr> 
  <tr> 
   <td>dragEdges</td> 
   <td align="center">true</td> 
   <td align="right">允许拖动边框</td> 
  </tr> 
  <tr> 
   <td>fixedSupport</td> 
   <td align="center">true</td> 
   <td align="right"></td> 
  </tr> 
  <tr> 
   <td>touchSupport</td> 
   <td align="center">null</td> 
   <td align="right"></td> 
  </tr> 
  <tr> 
   <td>boxWidth</td> 
   <td align="center">0</td> 
   <td align="right">画布宽度</td> 
  </tr> 
  <tr> 
   <td>boxHeight</td> 
   <td align="center">0</td> 
   <td align="right">画布高度</td> 
  </tr> 
  <tr> 
   <td>boundary</td> 
   <td align="center">2</td> 
   <td align="right">边界。说明：可以从边界开始拖动鼠标选择裁剪区域</td> 
  </tr> 
  <tr> 
   <td>fadeTime</td> 
   <td align="center">400</td> 
   <td align="right">过度效果的时间</td> 
  </tr> 
  <tr> 
   <td>animationDelay</td> 
   <td align="center">20</td> 
   <td align="right">动画延迟</td> 
  </tr> 
  <tr> 
   <td>swingSpeed</td> 
   <td align="center">3</td> 
   <td align="right">过渡速度</td> 
  </tr> 
  <tr> 
   <td>minSelect</td> 
   <td align="center">[0,0]</td> 
   <td align="right">选框最小选择尺寸。说明：若选框小于该尺寸，则自动取消选择</td> 
  </tr> 
  <tr> 
   <td>maxSize</td> 
   <td align="center">[0,0]</td> 
   <td align="right">选框最大尺寸</td> 
  </tr> 
  <tr> 
   <td>minSize</td> 
   <td align="center">[0,0]</td> 
   <td align="right">选框最小尺寸</td> 
  </tr> 
  <tr> 
   <td>onChange</td> 
   <td align="center">function(){}</td> 
   <td align="right">选框改变时的事件</td> 
  </tr> 
  <tr> 
   <td>onSelect</td> 
   <td align="center">function(){}</td> 
   <td align="right">选框选定时的事件</td> 
  </tr> 
  <tr> 
   <td>onRelease</td> 
   <td align="center">function(){}</td> 
   <td align="right">取消选框时的事件</td> 
  </tr> 
 </tbody> 
</table>

下表是api方法

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th align="right">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>setImage(string)</td> 
   <td align="right">设定（或改变）图像。例：jcrop_api.setImage(“newpic.jpg”)</td> 
  </tr> 
  <tr> 
   <td>setOptions(object)</td> 
   <td align="right">设定（或改变）参数，格式与初始化设置参数一样</td> 
  </tr> 
  <tr> 
   <td>setSelect(array)</td> 
   <td align="right">创建选框，参数格式为：[x,y,x2,y2]</td> 
  </tr> 
  <tr> 
   <td>animateTo(array)</td> 
   <td align="right">用动画效果创建选框，参数格式为：[x,y,x2,y2]</td> 
  </tr> 
  <tr> 
   <td>release()</td> 
   <td align="right">取消选框</td> 
  </tr> 
  <tr> 
   <td>disable()</td> 
   <td align="right">禁用 Jcrop。说明：已有选框不会被清除。</td> 
  </tr> 
  <tr> 
   <td>enable()</td> 
   <td align="right">启用 Jcrop</td> 
  </tr> 
  <tr> 
   <td>destroy()</td> 
   <td align="right">移除 Jcrop</td> 
  </tr> 
  <tr> 
   <td>tellSelect()</td> 
   <td align="right">获取选框的值（实际尺寸）。例子：console.log(jcrop_api.tellSelect())</td> 
  </tr> 
  <tr> 
   <td>tellScaled()</td> 
   <td align="right">获取选框的值（界面尺寸）。例子：console.log(jcrop_api.tellScaled())</td> 
  </tr> 
  <tr> 
   <td>getBounds()</td> 
   <td align="right">获取图片实际尺寸，格式为：[w,h]</td> 
  </tr> 
  <tr> 
   <td>getWidgetSize()</td> 
   <td align="right">获取图片显示尺寸，格式为：[w,h]</td> 
  </tr> 
  <tr> 
   <td>getScaleFactor()</td> 
   <td align="right">获取图片缩放的比例，格式为：[w,h]</td> 
  </tr> 
 </tbody> 
</table>

[jQuery]: http://jquery.com/
[http_jcrop.org]: http://jcrop.org/