Leaflet API - Draggable 拖拽中文文档

发布时间: 2022-10-18 所属分类: 文章标签:

当前位置：

麻辣GIS » GIS手册 » Leaflet中文API手册（V1.9） » Leaflet API - Draggable 拖拽中文文档

本文介绍下 Leaflet 中 Draggable 拖拽 API的详细使用说明。

Draggable 拖拽 API 调用方法

一个用于使 DOM 元素可拖动的类（包括触摸支持）。内部用于地图和标记的拖动。只对用 L.DomUtil.setPosition 定位的元素起作用。

使用示例

var draggable = new L.Draggable(elementToDrag);
draggable.enable();

Constructor

Constructor	说明
`L.Draggable(<HTMLElement> el, <HTMLElement> dragHandle?, <Boolean> preventOutline?, <Draggable options> options?)`	当你开始拖动 `dragHandle` 元素 (默认等于 `el` 本身)，创建一个 `Draggable` 对象用于移动 `el` 。

Options 选项

选项	类型	默认值	说明
`clickTolerance`	`Number`	`3`	用户在单击期间被认为是有效的点击（而不是鼠标拖动）的鼠标指针可以移动的最大像素数。

Events 事件

事件	数据	说明
`down`	`Event`	当一个拖动即将开始时触发。
`dragstart`	`Event`	当拖动开始时被触发
`predrag`	`Event`	在拖动过程中，在元素位置的每次相应更新之前连续触发。
`drag`	`Event`	在拖动过程中连续触发。
`dragend`	`DragEndEvent`	当拖动结束时被触发。

Methods 方法

方法	返回值	说明
`enable()`		启用拖拽功能
`disable()`		禁用拖拽功能

继承自 Evented 的方法

方法	返回值	说明
`on(<String> type, <Function> fn, <Object> context?)`	`this`	为对象的特定事件类型添加一个监听函数（`fn`）。你可以选择性地指定监听器的上下文（这个关键字将指向的对象）。你也可以传递几个空格分隔的类型（例如，`'click dblclick'`）。
`on(<Object> eventMap)`	`this`	添加一组 type/listener，例如 `{click: onClick, mousemove: onMouseMove}`。
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	移除一个先前添加的监听器函数。如果没有指定函数，它将从对象中删除该特定事件的所有监听器。请注意，如果您向 `on` 传递了一个自定义的上下文，您必须向 `off` 传递相同的上下文，以便删除监听器。
`off(<Object> eventMap)`	`this`	删除一组 type/listener
`off()`	`this`	移除该对象上所有事件的所有监听器。这包括隐含的附加事件。
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供一个数据对象——侦听器函数的第一个参数将包含其属性，事件可以选择性地传播到事件父级。
`listens(<String> type, <Boolean> propagate?)`	`Boolean`	如果一个特定的事件类型有任何监听器连接到它，则返回 `true`。验证可以选择性地被传播，如果父级有监听器连接到它，它将返回`true`。
`once(…)`	`this`	与`on(...)`的行为一样，不过监听器只会被触发一次后然后被删除。
`addEventParent(<Evented> obj)`	`this`	向父级 `Evented` 添加事件
`removeEventParent(<Evented> obj)`	`this`	删除之前向父级 `Evented` 添加的事件
`addEventListener(…)`	`this`	同 `on(…)`
`removeEventListener(…)`	`this`	同 `off(…)`
`clearAllEventListeners(…)`	`this`	同 `off()`
`addOneTimeEventListener(…)`	`this`	同 `once(…)`
`fireEvent(…)`	`this`	同 `fire(…)`
`hasEventListeners(…)`	`Boolean`	同 `listens(…)`