Leaflet API - Event objects 事件对象 中文文档
发布时间: 2022-10-21
所属分类: Leaflet中文API手册(V1.9)
本文介绍下 Leaflet 中 Event objects 事件对象 API的详细使用说明。
Event objects 事件对象 API 调用方法
每当从
Evented
继承的类触发事件时,都会使用事件参数调用侦听器函数,该参数是包含有关事件信息的普通对象。
例如:
map.on('click', function(ev) {
alert(ev.latlng); // ev is an event object (MouseEvent in this case)
});
可用信息取决于事件类型:
Event 事件
基本事件对象。 所有其他事件对象也包含这些属性。
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型 (例如, 'click' )。 |
target
|
Object |
触发该事件的对象。对于传播的事件,在传播链中的最后一个对象 触发事件的传播链中的最后一个对象。 |
sourceTarget
|
Object |
最初触发事件的对象。 对于非传播事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,最后一个将事件传播到其 事件的父对象。 |
layer
|
Object |
废弃的。 与
propagatedFrom 相同。
|
KeyboardEvent 键盘事件
属性 | 类型 | 说明 |
---|---|---|
originalEvent
|
DOMEvent |
触发此 Leaflet 事件的原始
DOM KeyboardEvent
。
|
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
layer
|
Object |
已弃用。 与
propagatedFrom 相同。
|
MouseEvent 鼠标事件
属性 | 类型 | 说明 |
---|---|---|
latlng
|
LatLng
|
鼠标事件发生的地理坐标。 |
layerPoint
|
Point
|
鼠标事件发生点相对于地图图层的像素坐标。 |
containerPoint
|
Point
|
鼠标事件发生的点相对于地图容器的像素坐标。 |
originalEvent
|
DOMEvent |
触发此 Leaflet 事件的原始
DOM MouseEvent
或
DOM TouchEvent
。
|
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
layer
|
Object |
已弃用。 与
propagatedFrom 相同。
|
LocationEvent 位置事件
属性 | 类型 | 说明 |
---|---|---|
latlng
|
LatLng
|
检测到用户的地理位置。 |
bounds
|
LatLngBounds
|
用户所在区域的地理边界(相对于位置的准确性)。 |
accuracy
|
Number |
以米为单位的位置精度。 |
altitude
|
Number |
位置高于 WGS84 椭圆体的高度,以米为单位。 |
altitudeAccuracy
|
Number |
以米为单位的高度精度。 |
heading
|
Number |
以度为单位的行进方向,从真北顺时针计数。 |
speed
|
Number |
当前速度(以米/秒为单位)。 |
timestamp
|
Number |
获得位置的时间。 |
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
layer
|
Object |
已弃用。 与
propagatedFrom 相同。
|
ErrorEvent 错误事件
属性 | 类型 | 说明 |
---|---|---|
message
|
String |
错误信息。 |
code
|
Number |
错误代码(如果适用)。 |
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
layer
|
Object |
已弃用。 与
propagatedFrom 相同。
|
LayerEvent 图层事件
属性 | 类型 | 说明 |
---|---|---|
layer
|
Layer
|
添加或删除的图层。 |
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
LayersControlEvent 图层控制事件
属性 | 类型 | 说明 |
---|---|---|
layer
|
Layer
|
添加或删除的图层。 |
name
|
String |
添加或删除的图层的名称。 |
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
TileEvent 瓦片事件
属性 | 类型 | 说明 |
---|---|---|
tile
|
HTMLElement |
瓦片元素(图像)。 |
coords
|
Point
|
具有瓦片的 x 、 y 、 和
z (缩放级别) 坐标的点对象。
|
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
layer
|
Object |
已弃用。 与
propagatedFrom 相同。
|
TileErrorEvent 瓦片错误事件
属性 | 类型 | 说明 |
---|---|---|
tile
|
HTMLElement |
瓦片元素(图像)。 |
coords
|
Point
|
具有瓦片的 x 、 y 、 和
z (缩放级别) 坐标的点对象。
|
error
|
* |
传递给瓦片的 done() 回调的错误信息。 |
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
layer
|
Object |
已弃用。 与
propagatedFrom 相同。
|
ResizeEvent 调整尺寸事件
属性 | 类型 | 说明 |
---|---|---|
oldSize
|
Point
|
resize 事件之前的旧尺寸。 |
newSize
|
Point
|
resize 事件后的新尺寸。 |
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
layer
|
Object |
已弃用。 与
propagatedFrom 相同。
|
GeoJSONEvent GeoJSON事件
属性 | 类型 | 说明 |
---|---|---|
layer
|
Layer
|
要添加到地图的 GeoJSON 要素的图层。 |
properties
|
Object |
要素的 GeoJSON 属性。 |
geometryType
|
String |
要素的 GeoJSON 几何类型。 |
id
|
String |
要素的 GeoJSON ID(如果存在)。 |
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
PopupEvent 弹窗事件
属性 | 类型 | 说明 |
---|---|---|
popup
|
Popup
|
打开或关闭 Popup。 |
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
layer
|
Object |
已弃用。 与
propagatedFrom 相同。
|
TooltipEvent 工具提示事件
属性 | 类型 | 说明 |
---|---|---|
tooltip
|
Tooltip
|
打开或关闭 Tooltip。 |
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
layer
|
Object |
已弃用。 与
propagatedFrom 相同。
|
DragEndEvent 拖动结束事件
属性 | 类型 | 说明 |
---|---|---|
distance
|
Number |
可拖动元素移动的距离(以像素为单位)。 |
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
layer
|
Object |
已弃用。 与
propagatedFrom 相同。
|
ZoomAnimEvent 缩放动画事件
属性 | 类型 | 说明 |
---|---|---|
center
|
LatLng
|
当前地图的中心 |
zoom
|
Number |
地图的当前缩放级别 |
noUpdate
|
Boolean |
由于此事件,图层是否应更新其内容 |
属性 | 类型 | 说明 |
---|---|---|
type
|
String |
事件类型(例如,'click' )。 |
target
|
Object |
触发事件的对象。对于传播事件,传播链中触发事件的最后一个对象。 |
sourceTarget
|
Object |
最初触发该事件的对象。对于非传播的事件,这将与
target 相同。
|
propagatedFrom
|
Object |
对于传播的事件,将事件传播到其事件父级的最后一个对象。 |
layer
|
Object |
已弃用。 与
propagatedFrom 相同。
|
其他API
Leaflet中文API文档手机(v.19版本)参考:《Leaflet中文API文档手机(v.19版本)》
相关阅读
声明
1.本文所分享的所有需要用户下载使用的内容(包括但不限于软件、数据、图片)来自于网络或者麻辣GIS粉丝自行分享,版权归该下载资源的合法拥有者所有,如有侵权请第一时间联系本站删除。
2.下载内容仅限个人学习使用,请切勿用作商用等其他用途,否则后果自负。
手机阅读
公众号关注
知识星球
手机阅读
最新GIS干货
私享圈子