Merge pull request #242 from BibMartin/feature_group

Create and test FeatureGroup

Author: ocefpaf

folium/map.py

@@ -217,6 +217,34 @@ def __init__(self, tiles='OpenStreetMap', name=None,
         {% endmacro %}
         """)
 
+class FeatureGroup(TileLayer):
+    def __init__(self, name=None, overlay=True):
+        """Create a FeatureGroup layer ; you can put things in it and handle them as a
+        single layer. For example, you can add a LayerControl to tick/untick the whole group.
+
+        Parameters
+        ----------
+        name : str, default None
+            The name of the featureGroup layer. It will be displayed in the LayerControl.
+            If None, get_name() will be called to get the object's technical (ugly) name.
+        overlay : bool, default True
+            Whether your layer will be an overlay (ticked with a checkbox in LayerControls)
+            or a base layer (ticked with a radio button).
+        """
+        super(TileLayer, self).__init__()
+        self._name = 'FeatureGroup'
+
+        self.tile_name = name if name is not None else self.get_name()
+
+        self.overlay = overlay
+
+        self._template = Template(u"""
+        {% macro script(this, kwargs) %}
+            var {{this.get_name()}} = L.featureGroup(
+                ).addTo({{this._parent.get_name()}});
+        {% endmacro %}
+        """)
+
 class LayerControl(MacroElement):
     """Adds a layer control to the map."""
     def __init__(self):

tests/test_folium.py

@@ -22,7 +22,7 @@
 from folium.six import PY3
 from folium.plugins import ScrollZoomToggler, MarkerCluster
 from folium.element import Html
-from folium.map import Popup, Marker, Icon, FitBounds
+from folium.map import Popup, Marker, Icon, FitBounds, FeatureGroup
 from folium.features import (DivIcon, CircleMarker, LatLngPopup, GeoJson,
                              GeoJsonStyle, ColorScale, TopoJson, PolyLine,
                              MultiPolyLine, ImageOverlay)
@@ -157,6 +157,18 @@ def test_wms_layer(self):
         assert (''.join(wms.split())[:-1] in
                 ''.join(map.get_root().render().split()))
 
+    def test_feature_group(self):
+        """Test FeatureGroup."""
+
+        map = folium.Map()
+        feature_group = FeatureGroup()
+        feature_group.add_children(Marker([45,-30],popup=Popup('-30')))
+        feature_group.add_children(Marker([45, 30],popup=Popup('30')))
+        map.add_children(feature_group)
+        map.add_children(folium.map.LayerControl())
+
+        map._repr_html_()
+
     def test_simple_marker(self):
         """Test simple marker addition."""