archive-gh-me/Leaflet
1
0
Fork 0
mirror of https://github.com/Leaflet/Leaflet.git synced 2026-02-01 17:27:23 +00:00
Code Issues Projects Releases Wiki Activity

docstrings: Expanded FeatureGroup docs. (#4862)

Browse Source
This commit is contained in:
Iván Sánchez Ortega 2016-08-31 16:57:03 +02:00 committed by Vladimir Agafonkin
parent 46de93e643
commit 2ced69db12
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/layer/FeatureGroup.js
View File

@ -3,14 +3,19 @@
* @aka L.FeatureGroup
* @inherits LayerGroup
*
* Extended `LayerGroup` that also has mouse events (propagated from members of the group) and a shared bindPopup method.
* Extended `LayerGroup` that makes it easier to do the same thing to all its member layers:
* * [`bindPopup`](#layer-bindpopup) binds a popup to all of the layers at once (likewise with [`bindTooltip`](#layer-bindtooltip))
* * Events are propagated to the `FeatureGroup`, so if the group has an event
* handler, it will handle events from any of the layers. This includes mouse events
* and custom events.
* * Has `layeradd` and `layerremove` events
*
* @example
*
* ```js
* L.featureGroup([marker1, marker2, polyline])
* .bindPopup('Hello world!')
* .on('click', function() { alert('Clicked on a group!'); })
* .on('click', function() { alert('Clicked on a member of the group!'); })
* .addTo(map);
* ```
*/
@ -26,6 +31,8 @@ L.FeatureGroup = L.LayerGroup.extend({
L.LayerGroup.prototype.addLayer.call(this, layer);
// @event layeradd: LayerEvent
// Fired when a layer is added to this `FeatureGroup`
return this.fire('layeradd', {layer: layer});
},
@ -41,6 +48,8 @@ L.FeatureGroup = L.LayerGroup.extend({
L.LayerGroup.prototype.removeLayer.call(this, layer);
// @event layerremove: LayerEvent
// Fired when a layer is removed from this `FeatureGroup`
return this.fire('layerremove', {layer: layer});
},