提示:
1.在灰色区域内拖动选择,也可以点击选择
2.主区域最好添加css 属性 user-select:none 取消文本选择,防止选择事件冲突
参数 | 类型 | 用法 |
selectables | DOM elements (nodes) | 可被选中的元素节点 |
selector | single DOM element (node) | 可手动添加一个拖动选择框(译者:可用于修改拖动选择框的样式,需要手动添加 css 的 position:absolute 样式) |
area | single DOM element (node) | 拖动生效的区域,如果未提供,它将是整个网页文档 |
customStyles | boolean | 如果设置为true,则默认情况下拖动选择框将不应用任何样式(绝对位置除外) |
multiSelectKeys | array | 允许切换到多选模式的按键,可选的值有有:ctrlKey,shiftKey,metaKey(Mac系统的专有键)和altKey,默认=['ctrlKey', 'shiftKey', 'metaKey']。如果要关闭功能,请提供一个空数组[] |
multiSelectMode | boolean | 每次选中新元素时不清空旧的选中元素,默认='false' |
autoScrollSpeed | integer | 选择时区域滚动的速度(如果有),单位是像素,设置为0以禁用自动滚动,默认值:1 |
selectedClass | string | 分配给选中项目的css类名称 |
hoverClass | string | 分配给鼠标悬停项目的css类名称(译者:并不是很理解这个的含义,估计用的不多) |
selectorClass | string | 拖动选择框的css类名称 |
selectableClass | string | 给区域内所有可选元素添加的css类名称 |
onDragStartBegin | function | 用户点击该区域时触发此回调,在DragSelect函数代码运行之前执行,用于设置事件侦听器 |
onDragStart | function | 用户点击该区域时触发此回调,在DragSelect函数代码运行之后执行,用于设置事件侦听器 |
onDragMove | function | 用户拖动该区域时触发此回调,在DragSelect函数代码运行之后执行,用于设置事件侦听器 |
onElementSelect | function | 每次选择元素时触发的回调函数 |
onElementUnselect | function | 每次取消选择元素时触发的回调函数 |
callback | function | 用户释放鼠标后触发,返回所有被选定的元素节点 |
method | properties | usage |
stop | / | 暂停功能 |
start | / | 暂停后重启功能 |
break | / | 在回调中使用以禁用即将执行的代码(译者:暂不知道有什么用) |
setSelection | DOM elements (nodes), Boolean (callback), Boolean (dontAddToSelectables) | 将选择内容设置为一个或多个元素。如果boolean设置为true:回调将在之后被调用。 默认情况下,它检查所有元素是否都在可选列表中,如果不存在则添加它们(可以通过将最后一个布尔值设置为true来关闭) |
clearSelection | DOM elements (nodes), Boolean (callback) | 从选择中删除所有元素。如果boolean设置为true:回调将在之后被调用。 |
addSelectables | DOM elements (nodes), Boolean (addToSelection) | 添加可以选择的元素。智能的算法可确保节点永远不会被添加两次。如果boolean设置为true:元素也将添加到当前选择中。 |
removeSelectables | DOM elements (nodes), Boolean (removeFromSelection) | 删除可以选择的元素。如果boolean设置为true:元素也将从当前选择中删除。 |
getSelectables | / | 返回所有选中元素节点数组。 |
setSelectables | DOM elements (nodes), Boolean (removeFromSelection), Boolean (addToSelection) | 设置所有可以选择的元素。删除所有当前的可选择项,添加新设置的选项到选项列表。如果应该从选择中删除旧元素,则第一个布尔值为true。如果要将新元素添加到选择中,第二个布尔值为true。 |