imgAreaSelect 中文文檔
http://www.cnblogs.com/boychenney/archive/2011/10/08/2201996.html
一、技術文檔
1、介紹
ImgAreaSelect是一jQuery插件,它支持用戶通過鼠標拖曳選擇圖片的一部分,非常的fashion。另外,可以在這個選擇圖像區域的基礎上應用網站的其他一些技術,比如圖片拖曳、圖片編輯等。
2、基本用法
這個插件基於jquery上通過imgAreaSelect()方法來調用,它操作的對象是HTML中<img>元素內的圖像。
<script type="text/JavaScript">
$(document).ready(function () {
$(‘img#photo‘).imgAreaSelect({
handles: true,
onSelectEnd: someFunction
});
});
</script>
如果在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 |
選擇區域的四個邊框,由四個div組成的 |
imgareaselect-handle |
可改變大小的調整手柄(四個或者八個divs,如果沒有使能的話,則不顯示) |
imgareaselect-outer |
未選擇區域,由四個divs組成 |
下面的對象示意圖展示了這插件的這些元素如何布置的:
其中的前綴"imgareaselect"是默認的前綴,可以通過"classPrefix"選項來修改。這在當有許多選擇框需要分別操作(比如修改樣式)的時候特別有用。
6、回調函數
回調函數(當設置onInit, onSelectStart, onSelectChange或 onSelectEnd選項)接收兩個參數,第一個選項是這個插件所應用圖像的引用,另外一個則是呈現當前選擇的對象,這個對象有六個性質。
性質 |
描述 |
x1 y1 |
選擇區域左上角的坐標 |
x2 y2 |
選擇區域右下角的坐標 |
width |
選擇區域的寬度 |
height |
選擇區域的高度 |
為了便於理解,下面給出當選擇完後執行的回調函數的例子:
$(‘img#photo‘).imgAreaSelect({
onSelectEnd: function (img, selection) {
alert(‘width: ‘ + selection.width + ‘; height: ‘ + selection.height);
}
});
7、鍵盤支持
如果選項"keys"設置為true,那麽我們能夠通過鍵盤上的按鍵進來選擇框的移動。下面的鍵可以使用,默認的功能如下:
按鍵 |
動作 |
方向鍵 |
每次以10像素為單位移動選區 |
Shift+方向鍵 |
每次以1像素為單位移動選區 |
Ctrl+方向鍵 |
每次以10像素為單位擴縮選區 |
Ctrl+Shift+方向鍵 |
每次以1像素為單位擴縮選區 |
當然你也可以自己通過設置"keys"這個選項來覆蓋默認鍵設置,對象有下面的屬性:
屬性 |
描述 |
方向鍵 |
設置方向鍵的功能 |
Shift |
設置Shift鍵的功能 |
Ctrl |
設置Ctrl鍵的功能 |
Alt |
設置Alt鍵的功能 |
每個屬性通過設置數值(以像素為單位,數值要不小於1),表明當按下此鍵時移動/改變大小多少像素,或者指定其值為"string"來指定它是"resize"模式。例如:
$(‘img#example‘).imgAreaSelect({
keys: { arrows: 15, ctrl: 5, shift: ‘resize‘ }
});
這個例子裏設置成"方向鍵會移動選區15像素,按住Ctrl鍵會移動5像素,而按住Shift鍵時則切換到resize模式"。
如果不止一個圖像,且自己修改了按鍵設置,那麽只對一個圖像會應用這個自定義設置。一般來說,當"激活"(用鼠標點擊)某個圖像時,這個圖像就會使用自定義的按鍵設置。
8、API方法
這個插件也提供了幾個API方法擴展它的應用,並能夠通過這些API方法跟其他web應用聯合起來。
為了使用這些方法,首先需要一個插件對象,可以調用imgAreaSelect()函數並讓其選項"instance"設置為true來實現:
var ias = $(‘#photo‘).imgAreaSelect({ instance: true });
現在就可以使用此對象來調用公共的方法了。例如,設置一個默認預定義的範圍:
ias.setSelection(50, 50, 150, 200, true);
ias.setOptions({ show: true });
ias.update();
只要當初始化完成,就可以使用這些API方法了。下面列出這些API方法:
方法 |
描述 |
getOptions |
getOptions() --返回當前選項的配置 Returns: 一個包含當前選項配置的對象(一般是JSON對象) |
setOptions |
setOptions(newOptions) --設置插件選項 參數: newOptions – 選項配置對象(一般是JSON對象) |
getSelection |
getSelection([noScale]) --獲取當前的選區
參數: noScale (可選) – 如果設置為真,那麽對於返回的選區不進行縮放操作。
返回: 選擇區域裏的對象 |
setSelection |
setSelection(x1, y1, x2, y2, [noScale]) --設置當前選擇區域
參數: x1 – 選擇區域左上角X坐標 y1 – 選擇區域左上角Y坐標 x2 – 選擇區域右下角X坐標 y2 – 選擇區域右下角Y坐標 noScale (可選) –若設為真,則不會對圖像進行縮放
註意:此方法只在插件內設置選擇區域,並不會馬上觀察到選區的變化,如果需要立馬顯示更改後的區域,必須在使用setSelect()函數後就調用update()函數,且讓show選項為true. |
cancelSelection |
cancelSelection() --取消當前的選擇
註意:這個方法會隱藏"選擇/未選擇"區域,所以不必調用update()函數。 |
update |
update([resetKeyPress]) --更新插件配置
參數: resetKeyPress (可選) – 如果設成false,此實例的按鍵將復位(即不可用) |
二、簡單實例
1、寬度或者高度限制
minWidth、minHeight、maxWidth以及maxHeight選項允許你設置選區的範圍。在這個例子中,圖像的最大範圍將限制為200x150px。
$(document).ready(function () {
$(‘#ladybug_ant‘).imgAreaSelect({ maxWidth: 200, maxHeight: 150, handles: true });
});
2、固定高寬比
配置aspectRatio選項就可以了,這裏將其設置成"4:3":
$(document).ready(function () {
$(‘#bee‘).imgAreaSelect({ aspectRatio: ‘4:3‘, handles: true });
});
3、設置初始選項區域
配置x1, y1, x2與 y2選項就可以了:
$(document).ready(function () {
$(‘#duck‘).imgAreaSelect({ x1: 120, y1: 90, x2: 280, y2: 210 });
});
三、回調函數示例
1、選區預覽
在下面的代碼小片斷裏,onSelectChange()回調函數實現了選擇區域預覽的效果。
官方源代碼:http://odyniec.NET/projects/imgareaselect/examples-callback.html
function preview(img, selection) {
var scaleX = 100 / (selection.width || 1);
var scaleY = 100 / (selection.height || 1);
$(‘#ferret + div > img‘).css({
width: Math.round(scaleX * 400) + ‘px‘,
height: Math.round(scaleY * 300) + ‘px‘,
marginLeft: ‘-‘ + Math.round(scaleX * selection.x1) + ‘px‘,
marginTop: ‘-‘ + Math.round(scaleY * selection.y1) + ‘px‘
});
}
//這裏通過jQuery語法在原來圖片後插入同樣的圖片
$(document).ready(function () {
$(‘<div><img src="ferret.jpg" style="position: relative;" /><div>‘)
.css({
float: ‘left‘,
position: ‘relative‘,
overflow: ‘hidden‘,
width: ‘100px‘,
height: ‘100px‘
})
.insertAfter($(‘#ferret‘));
$(‘#ferret‘).imgAreaSelect({ aspectRatio: ‘1:1‘, onSelectChange: preview });
});
由於預覽窗口是100x100px的,因此當截圖窗口小於100px時,預覽圖會放大;當截圖窗口大於100px時,預覽圖會縮小。這兩種效果圖如下:
截圖 1 當截圖窗口大於100px時
截圖 2 當截圖窗口小於100px時
需要說明的是,這裏制作這種效果使用了一種技巧。最關鍵的一個是等比率縮放.它需要兩個圖片,第一圖是原圖,第二個圖是選擇區域後顯示的圖,用第一個圖上的選擇坐標+css控制產生第二個圖,實際上兩個圖是一樣的,只不過通過css控制了第二張圖的顯示區域與縮放比率。證據如下:
【證據一】在$(document).ready()函數中通過insertAfter插入"src"也是"ferret.jpg"的圖片。再註意一下,這一段裏的"overflow: ‘hidden‘,"這一行代碼就是讓超過100px高寬的圖片額外內容隱藏掉。
【證據二】在preview()函數中,首先就定義了scaleX與scaleY,它們的內容就是100/selection.width(或height) ,也就是當selection.width小於100時,這個因子起放大作用,反之起縮小作用。
值得註意的是:
回調函數中實際圖的寬高(這裏的300,400是實際圖的高,要根據實際情況調整!),回調函數中新圖的寬高這些參數必須設置正確、否則會出現 選擇偏差
2、提交選區的坐標
如果需要實現真正截圖功能必須使用服務器端支持,例如PHP asp aspx jsp。也就是意味著,在客戶端選擇只是第一步,如果需進一步的處理,必須要將這選區的坐標提交給服務器。那麽如何實現呢?
創建一個表彰,裏面有四個隱藏域:
<form action="crop.php" method="post">
<input type="hidden" name="x1" value="" />
<input type="hidden" name="y1" value="" />
<input type="hidden" name="x2" value="" />
<input type="hidden" name="y2" value="" />
<input type="submit" name="submit" value="Submit" />
</form>
然後在初始化imgAreaSelect時,使用onSelectEnd()回調函數將選擇後的數據賦給這些隱藏域,正如下面代碼那樣:
$(document).ready(function () {
$(‘#ladybug‘).imgAreaSelect({
onSelectEnd: function (img, selection) {
$(‘input[name="x1"]‘).val(selection.x1);
$(‘input[name="y1"]‘).val(selection.y1);
$(‘input[name="x2"]‘).val(selection.x2);
$(‘input[name="y2"]‘).val(selection.y2);
}
});
});
這樣當點擊"submit按鈕"時,頁面將上載到服務器,如果使用PHP的話,使用$_POST[‘x1‘]等就得到相應的坐標數據了。
imgAreaSelect 中文文檔