Leaflet API - FeatureGroup 要素组 中文文档
本文介绍下 Leaflet 中 FeatureGroup 要素组 API的详细使用说明。
FeatureGroup 要素组 API 调用方法
扩展了
LayerGroup
,使它更容易对其所有成员图层做同样的事情:
-
bindPopup
一次将一个弹出窗口绑定到所有的图层上 (与bindTooltip
类似) -
事件被传递到
FeatureGroup
,所以如果该组有一个事件处理程序,它将处理来自任何图层的事件。这包括鼠标事件和自定义事件。 -
具有
layeradd
和layerremove
的事件
使用示例
L.featureGroup([marker1, marker2, polyline])
.bindPopup('Hello world!')
.on('click', function() { alert('Clicked on a member of the group!'); })
.addTo(map);
Creation
构造函数 | 说明 |
---|---|
L.featureGroup(
|
创建一个 feature group,可选择给定一组初始图层和一个
options 对象。
|
Options 选项
选项 | 类型 | 默认值 | 说明 |
---|---|---|---|
interactive
|
Boolean |
true |
如果是 false ,
该图层将不会发出鼠标事件,而是作为底层地图的一部分。
|
bubblingMouseEvents
|
Boolean |
true |
当为
true
时,此标记上的鼠标事件将触发地图上的相同事件(除非使用
L.DomEvent.stopPropagation )。
|
选项 | 类型 | 默认值 | 说明 |
---|---|---|---|
pane
|
String |
'overlayPane' |
默认情况下,该图层将被添加到地图的 overlay pane(覆盖窗格)中。 覆盖该选项将导致该图层被默认放置在另一个窗格中。 |
attribution
|
String |
null |
归属控制中要显示的字符串,例如 "© OpenStreetMap 贡献者"。 它描述了图层数据,通常是对版权所有者和瓦片提供者的法律义务。 |
Events 事件
事件 | 数据 | 说明 |
---|---|---|
layeradd
|
LayerEvent
|
当一个图层被添加到该
FeatureGroup
时触发。
|
layerremove
|
LayerEvent
|
当一个图层被从该
FeatureGroup 中移除时触发。
|
事件 | 数据 | 说明 |
---|---|---|
click
|
MouseEvent
|
当用户 click 或 tap 该图层时触发。 |
dblclick
|
MouseEvent
|
当用户 double-click 或 double-tap 该图层时触发。 |
mousedown
|
MouseEvent
|
当用户在该图层上按下鼠标按钮时触发。 |
mouseup
|
MouseEvent
|
当用户在该图层上释放按下的鼠标按钮时触发。 |
mouseover
|
MouseEvent
|
鼠标进入该图层时触发。 |
mouseout
|
MouseEvent
|
当鼠标离开该图层时触发。 |
contextmenu
|
MouseEvent
|
当用户在图层上点击右键时触发,如果该事件有监听者,可以防止显示默认的浏览器上下文菜单。在手机上,当用户保持单次触摸一秒钟(也叫长按)时也会触发。 |
事件 | 数据 | 说明 |
---|---|---|
popupopen
|
PopupEvent
|
当绑定到该层的 popup 打开时触发 |
popupclose
|
PopupEvent
|
当绑定到该层的 popup 关闭时触发 |
事件 | 数据 | 说明 |
---|---|---|
tooltipopen
|
TooltipEvent
|
当绑定到该层的 tooltip 打开时触发。 |
tooltipclose
|
TooltipEvent
|
当绑定到该层的 tooltip 关闭时触发。 |
Methods 方法
方法 | 返回值 | 说明 |
---|---|---|
setStyle(
|
this |
为组中有
|
bringToFront()
|
this |
将图层组置于所有其他图层的顶部。 |
bringToBack()
|
this |
将图层组置于所有其他图层的底部。 |
getBounds()
|
LatLngBounds
|
返回要素组的 LatLngBounds(由其子节点的边界和坐标创建)。 |
方法 | 返回值 | 说明 |
---|---|---|
toGeoJSON(
|
Object |
坐标值使用具有指定 |
addLayer(
|
this |
将给定的图层添加到组中。 |
removeLayer(
|
this |
将给定的图层从组中移除。 |
removeLayer(
|
this |
将具有给定内部ID的图层从组中移除。 |
hasLayer(
|
Boolean |
如果给定的图层当前被添加到组中,则返回
|
hasLayer(
|
Boolean |
如果给定的内部 ID 当前被添加到组中,则返回
|
clearLayers()
|
this |
移除组中的所有图层。 |
invoke(
|
this |
对该组中包含的每个图层调用
|
eachLayer(
|
this |
遍历该组的各图层,可以选择指定迭代器函数的上下文。
|
getLayer(
|
Layer
|
返回具有给定内部 ID 的图层。 |
getLayers()
|
Layer[] |
返回所有添加到组中的图层的数组。 |
setZIndex(
|
this |
对包含在该组中的每个图层调用
|
getLayerId(
|
Number |
返回一个图层的内部 ID |
方法 | 返回值 | 说明 |
---|---|---|
addTo(
|
this |
将图层添加到指定的地图或图层组(LayerGroup)。 |
remove()
|
this |
从当前处于活动状态的地图中删除图层。 |
removeFrom(
|
this |
从指定的地图中删除图层 |
removeFrom(
|
this |
从指定的
|
getPane(
|
HTMLElement |
返回代表地图上指定窗格的
|
getAttribution()
|
String |
由 |
方法 | 返回值 | 说明 |
---|---|---|
bindPopup(
|
this |
将一个弹出式窗口与传入的
|
unbindPopup()
|
this |
移除之前用 |
openPopup(
|
this |
在指定的
|
closePopup()
|
this |
如果与当前图层绑定的弹窗(popup)时打开的,则关闭当前弹窗。 |
togglePopup()
|
this |
根据当前状态,打开或关闭与该层绑定的弹出窗口。 |
isPopupOpen()
|
boolean |
如果与该层绑定的弹出窗口当前已打开,则返回
|
setPopupContent(
|
this |
设置绑定到该图层的弹出窗口的内容。 |
getPopup()
|
Popup
|
返回绑定到该图层的弹出窗口。 |
方法 | 返回值 | 说明 |
---|---|---|
bindTooltip(
|
this |
将工具提示(tooltip)绑定到传入的图层
|
unbindTooltip()
|
this |
移除之前用
|
openTooltip(
|
this |
在指定的
|
closeTooltip()
|
this |
如果该图层处于打开状态,则关闭绑定到该图层的工具提示。 |
toggleTooltip()
|
this |
根据当前状态打开或关闭绑定到该图层的工具提示。 |
isTooltipOpen()
|
boolean |
如果该层绑定的工具提示当前已打开,则返回
|
setTooltipContent(
|
this |
设置绑定到该层的工具提示的内容。 |
getTooltip()
|
Tooltip
|
返回绑定到该层的工具提示。 |
方法 | 返回值 | 说明 |
---|---|---|
on(
|
this |
为对象的特定事件类型添加一个监听函数( |
on(
|
this |
添加一组 type/listener,例如
|
off(
|
this |
移除一个先前添加的监听器函数。如果没有指定函数,它将从对象中删除该特定事件的所有监听器。请注意,如果您向
|
off(
|
this |
删除一组 type/listener |
off()
|
this |
移除该对象上所有事件的所有监听器。这包括隐含的附加事件。 |
fire(
|
this |
触发指定类型的事件。您可以选择提供一个数据对象——侦听器函数的第一个参数将包含其属性,事件可以选择性地传播到事件父级。 |
listens(
|
Boolean |
如果一个特定的事件类型有任何监听器连接到它,则返回
|
once(…)
|
this |
与 |
addEventParent(
|
this |
向父级
|
removeEventParent(
|
this |
删除之前向父级
|
addEventListener(…)
|
this |
同 |
removeEventListener(…)
|
this |
同 |
clearAllEventListeners(…)
|
this |
同 |
addOneTimeEventListener(…)
|
this |
同
|
fireEvent(…)
|
this |
同
|
hasEventListeners(…)
|
Boolean |
其他API
Leaflet中文API文档手机(v.19版本)参考:《Leaflet中文API文档手机(v.19版本)》
相关阅读
声明
1.本文所分享的所有需要用户下载使用的内容(包括但不限于软件、数据、图片)来自于网络或者麻辣GIS粉丝自行分享,版权归该下载资源的合法拥有者所有,如有侵权请第一时间联系本站删除。
2.下载内容仅限个人学习使用,请切勿用作商用等其他用途,否则后果自负。