imgAreaSelect 中文文档
来源:广州中睿信息技术有限公司官网
发布时间:2012/10/21 23:25:16 编辑:editor 阅读 308
一、技术文档1、介绍ImgAreaSelect是一jQuery插件,它支持用户通过鼠标拖曳选择图片的一部分,非常的fashion。另外,可以在这个选择图像区域的基础上应用网站的其他一些技术,比如图片

一、技术文档

1、介绍

ImgAreaSelect是一jQuery插件,它支持用户通过鼠标拖曳选择图片的一部分,非常的fashion。另外,可以在这个选择图像区域的基础上应用网站的其他一些技术,比如图片拖曳、图片编辑等。

2、基本用法

这个插件基于jQuery上通过imgAreaSelect()方法来调用,它操作的对象是HTML中<img>元素内的图像。

如果在jQuery对象里有不止有一个img元素,那么这个插件会对里面的元素逐个应用此方法。其实这个方法不仅仅应用于img元素,它支持任何块级元素(比如有图像背景的div元素)。

与其它jQuery插件相似,这个插件可以在$(document).ready() 或者 $(window).load()句柄中初始化。

3、选项

用户在这个插件的很多方面都可以进行定制,用户通过插件选项来达到这个目的(这些选项会在插件初始化的时候起效)。这些选项包括:

选项

描述

aspectRatio

长宽比,以后在选择时候就会维持不变。

e.g. "4:3"

autoHide

如果设为true,那么在选择完后区域会消失。

Default:false

classPrefix

预先给插件元素的前缀(详见下面:5、元素与类)

Default:imgareaselect

disable

如果设置成true,这个插件将不起作用(但是图像还是可见的)

enable

如果设置成true,这个插件又将重新起作用

fadeSpeed

若设置成大于零的某个数,将"渐隐/渐现"这个插件

Default:true

handles

若设置成true,在改变大小的时候显示改变框(就是角点有些小"矩形")

Default:false

hide

若设置成true,则隐藏选择框

imageHeight

图像的真实高度(因为有可能被CSS缩放过了)

imageWidth

图像的真实宽度(因为有可能被CSS绽放过了)

instance

若设为true,imgAreaSelect()函数会返回一个对选择区域图像的一个引用,以便能够进一步使用API。(详见8、API方法)

keys

启用/关闭键盘支持(详见7、键盘支持)

Default:false

maxHeight

限制选择框(以像素为单位),设置最大、最小的高度、宽度。

maxWidth

minHeight

minWidth

movable

设置是否支持选择框移动

Default:true

parent

指定此插件默认所附加到的父元素

Default:body

persistent

若设置成true,点击选择区域外将开始一个新的选项(换言之,是否让用户只能移动/缩放选择区域)

Default:false

remove

若设置成true,则该插件将完全移除

resizable

决定选择区域是否可以改变大小

Default:true

resizeMargin

当选择区域宽度超过多少像素时将启用"可改变大小"模式

show

如果设置成true,选择区域将可见

x1

y1

初始化时选择框左上角的坐标

x2

y2

初始化时选择框右下角的坐标

zIndex

设置此插件所作用元素的z-index的值,一般情况下,imgAreaSelect 总是可以自动计算出它的值,但是极少数情况下还是有必要设置的。

onInit

当插件初始化时所调用的函数(详见6、回调函数)

onSelectStart

当开始选择时所调用的函数(详见6、回调函数)

onSelectChange

当改变选择区域时所调用的函数(详见6、回调函数)

onSelectEnd

当选择结束时所调用的函数(详见6、回调函数)

 

4、样式表

随着插件发放的还有三个样式表:

  • imgareaselect-default.css – 这是默认的样式表,
  • imgareaselect-animated.css – 这个样式与默认的样式表基本是一样的,只是它能够让选择区域边框变化
  • imgareaselect-deprecated.css – 只有你想使用不赞同的选项时才用这个样式表。

你只需要在html头部将其中的一个样式表添加进来就可以。这css文件夹中还包含4张gif图片,它们是用来显示边框的。

5、元素与类

此插件通过创建几个div元素来表示选择区域,包括边框、可调整手柄以及未选择的区域。这些元素已经指定了特定的类名了,所以你可以通过CSS或者jQuery选择器来获得并操作它们。

类名

指定给的对象

imgareaselect-selection

选择的区域

imgareaselect-border1 imgareaselect-border2 imgareaselect-border3 imgareaselect-border4

选择区域的四个边框,由四个div组成的

imgareaselect-handle

可改变大小的调整手柄(四个或者八个divs,如果没有使能的话,则不显示)

imgareaselect-outer

未选择区域,由四个divs组成

下面的对象示意图展示了这插件的这些元素如何布置的:

其中的前缀"imgareaselect"是默认的前缀,可以通过"classPrefix"选项来修改。这在当有许多选择框需要分别操作(比如修改样式)的时候特别有用。

6、回调函数

回调函数(当设置onInit, onSelectStart, onSelectChange或 onSelectEnd选项)接收两个参数,第一个选项是这个插件所应用图像的引用,另外一个则是呈现当前选择的对象,这个对象有六个性质。

性质

描述

x1

y1

选择区域左上角的坐标

x2

y2

选择区域右下角的坐标

width

选择区域的宽度

height

选择区域的高度

为了便于理解,下面给出当选择完后执行的回调函数的例子:

7、键盘支持

如果选项"keys"设置为true,那么我们能够通过键盘上的按键进来选择框的移动。下面的键可以使用,默认的功能如下:

按键

动作

方向键

每次以10像素为单位移动选区

Shift+方向键

每次以1像素为单位移动选区

Ctrl+方向键

每次以10像素为单位扩缩选区

Ctrl+Shift+方向键

每次以1像素为单位扩缩选区

当然你也可以自己通过设置"keys"这个选项来覆盖默认键设置,对象有下面的属性:

联系我们CONTACT 扫一扫
愿景:成为最专业的软件研发服务领航者
中睿信息技术有限公司 广州•深圳 Tel:020-38931912 务实 Pragmatic
广州:广州市天河区翰景路1号金星大厦18层中睿信息 Fax:020-38931912 专业 Professional
深圳:深圳市福田区车公庙有色金属大厦509~510 Tel:0755-25855012 诚信 Integrity
所有权声明:PMI, PMP, Project Management Professional, PMI-ACP, PMI-PBA和PMBOK是项目管理协会(Project Management Institute, Inc.)的注册标志。
版权所有:广州中睿信息技术有限公司 粤ICP备13082838号-2