API 方法

优质

小牛编辑

125浏览

2023-12-01

这个插件也提供了几个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，此实例的按键将复位（即不可用）