jQuery Jcrop API参数说明,中文版

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

  • 对所有图片均unobtrusively(无侵入的,保持DOM简洁)
  • 支持宽高比例锁定
  • 支持 minSize/maxSize设置
  • 支持改变选区或移 动选区时的回调(Callback)
  • 支持用键盘微调选区
  • 通过API创建互动,比如动画效果
  • 支持CSS样式

版本及Demo

options 参数说明(可选)

名称默认值说明
allowSelecttrue允许新选框
allowMovetrue允许选框移动
allowResizetrue允许选框缩放
trackDocumenttrue拖动选框时,允许超出图像以外的地方时继续拖动。
baseClass'jcrop'基础样式名前缀。说明:class="jcrop-holder",更改的只是其中的 jcrop。

例:假设值为 "test",那么样式名会更改为 "test-holder"

addClassnull添加样式。

例:假设值为 "test",那么会添加样式到class="jcrop-holder test"

bgColor'black'背景颜色。颜色关键字、HEX、RGB 均可。
bgOpacity0.6背景透明度
bgFadefalse使用背景过渡效果
borderOpacity0.4选框边框透明度
handleOpacity0.5缩放按钮透明度
handleSize9缩放按钮大小
aspectRatio0选框宽高比。说明:width/height
keySupporttrue支持键盘控制。按键列表:上下左右(移动选框)、Esc(取消选框)
createHandles['n','s','e','w','nw','ne','se','sw']设置边角控制器
createDragbars['n','s','e','w']设置边框控制器
createBorders['n','s','e','w']设置边框
drawBorderstrue绘制边框
dragEdgestrue允许拖动边框
fixedSupporttrue支持 fixed,例如:IE6、iOS4
touchSupportnull支持触摸事件
shadenull使用更好的遮罩
boxWidth0画布宽度
boxHeight0画布高度
boundary2边界。说明:可以从边界开始拖动鼠标选择裁剪区域
fadeTime400过度效果的时间
animationDelay20动画延迟
swingSpeed3过渡速度
minSelect[0,0]选框最小选择尺寸。说明:若选框小于该尺寸,则自动取消选择
maxSize[0,0]选框最大尺寸
minSize[0,0]选框最小尺寸
onChangefunction(){}选框改变时的事件
onSelectfunction(){}选框选定时的事件
onDblClickfunction(){}在选框内双击时的事件
onReleasefunction(){}取消选框时的事件

使用方法

载入CSS文件

<link rel="stylesheet" href="css/jquery.Jcrop.css">  

载入JavaScript文件

<script src="js/jquery.js"></script>    
<script src="js/jquery.Jcrop.js"></script>   

给图像标签加上ID

<img  src="pic.jpg">  

调用Jcrop

$("#element_id").Jcrop();  

API方法说明

方法方法的使用说明
setImage(string)设定(或改变)图像。例:jcrop_api.setImage("newpic.jpg")
setOptions(object)设定(或改变)参数,格式与初始化设置参数一样
setSelect(array)创建选框,参数格式为:[x,y,x2,y2]
animateTo(array)用动画效果创建选框,参数格式为:[x,y,x2,y2]
release()取消选框
disable()禁用 Jcrop。说明:已有选框不会被清除。
enable()启用 Jcrop
destroy()移除 Jcrop
tellSelect()获取选框的值(实际尺寸)。例子:console.log(jcrop_api.tellSelect())
tellScaled()获取选框的值(界面尺寸)。例子:console.log(jcrop_api.tellScaled())
getBounds()获取图片实际尺寸,格式为:[w,h]
getWidgetSize()获取图片显示尺寸,格式为:[w,h]
getScaleFactor()获取图片缩放的比例,格式为:[w,h]

原文地址:http://blog.csdn.net/xht555/article/details/43407141