Merge pull request #447 from BibMartin/feature/circle_circle_marker

Separate Circle from CircleMarker

Author: ocefpaf

folium/features.py

@@ -634,6 +634,51 @@ def __init__(self, html=None, icon_size=None, icon_anchor=None,
             """)  # noqa
 
 
+class Circle(Marker):
+    """Creates a Circle object for plotting on a Map.
+
+    Parameters
+    ----------
+    location: tuple or list, default None
+        Latitude and Longitude of Marker (Northing, Easting)
+    radius: int
+        The radius of the circle in meters. For setting the radius in pixel,
+        use CircleMarker.
+    color: str, default 'black'
+        The color of the marker's edge in a HTML-compatible format.
+    fill_color: str, default 'black'
+        The fill color of the marker in a HTML-compatible format.
+    fill_opacity: float, default 0.6
+        The fill opacity of the marker, between 0. and 1.
+    popup: string or folium.Popup, default None
+        Input text or visualization for object.
+    """
+    def __init__(self, location, radius=500, color='black',
+                 fill_color='black', fill_opacity=0.6, popup=None):
+        super(Circle, self).__init__(location, popup=popup)
+        self._name = 'Circle'
+        self.radius = radius
+        self.color = color
+        self.fill_color = fill_color
+        self.fill_opacity = fill_opacity
+
+        self._template = Template(u"""
+            {% macro script(this, kwargs) %}
+
+            var {{this.get_name()}} = L.circle(
+                [{{this.location[0]}},{{this.location[1]}}],
+                {{ this.radius }},
+                {
+                    color: '{{ this.color }}',
+                    fillColor: '{{ this.fill_color }}',
+                    fillOpacity: {{ this.fill_opacity }}
+                    }
+                )
+                .addTo({{this._parent.get_name()}});
+            {% endmacro %}
+            """)
+
+
 class CircleMarker(Marker):
     """Creates a CircleMarker object for plotting on a Map.
 
@@ -642,12 +687,13 @@ class CircleMarker(Marker):
     location: tuple or list, default None
         Latitude and Longitude of Marker (Northing, Easting)
     radius: int
-        The radius of the circle in pixels.
+        The radius of the circle in pixels. For setting the radius in meter,
+        use Circle.
     color: str, default 'black'
         The color of the marker's edge in a HTML-compatible format.
     fill_color: str, default 'black'
         The fill color of the marker in a HTML-compatible format.
-    fill_opacity: float, default à.6
+    fill_opacity: float, default 0.6
         The fill opacity of the marker, between 0. and 1.
     popup: string or folium.Popup, default None
         Input text or visualization for object.
@@ -664,15 +710,15 @@ def __init__(self, location, radius=500, color='black',
         self._template = Template(u"""
             {% macro script(this, kwargs) %}
 
-            var {{this.get_name()}} = L.circle(
+            var {{this.get_name()}} = L.circleMarker(
                 [{{this.location[0]}},{{this.location[1]}}],
-                {{ this.radius }},
                 {
                     color: '{{ this.color }}',
                     fillColor: '{{ this.fill_color }}',
                     fillOpacity: {{ this.fill_opacity }}
                     }
                 )
+                .setRadius({{ this.radius }})
                 .addTo({{this._parent.get_name()}});
             {% endmacro %}
             """)

folium/templates/circle_marker.js

@@ -1,5 +1,5 @@
-var {{ circle }} = L.circle([{{ lat }}, {{ lon }}], {{ radius }}, {
+var {{ circle }} = L.circleMarker([{{ lat }}, {{ lon }}], {
                             color: '{{ line_color }}',
                             fillColor: '{{ fill_color }}',
                             fillOpacity: {{ fill_opacity }}
-                            });
+                            }).setRadius({{ radius }})

tests/test_folium.py

@@ -212,8 +212,8 @@ def test_circle_marker(self):
         circ_templ = self.env.get_template('circle_marker.js')
 
         # Single Circle marker.
-        self.map.circle_marker(location=[45.60, -122.8], popup='Hi')
-        marker = list(self.map._children.values())[-1]
+        marker = folium.features.CircleMarker([45.60, -122.8], popup='Hi')
+        self.map.add_child(marker)
         circle_1 = circ_templ.render({'circle': marker.get_name(),
                                       'lat': 45.60,
                                       'lon': -122.8, 'radius': 500,
@@ -224,8 +224,8 @@ def test_circle_marker(self):
                 ''.join(self.map.get_root().render().split()))
 
         # Second circle marker.
-        self.map.circle_marker(location=[45.70, -122.9], popup='Hi')
-        marker = list(self.map._children.values())[-1]
+        marker = folium.features.CircleMarker([45.70, -122.9], popup='Hi')
+        self.map.add_child(marker)
         circle_2 = circ_templ.render({'circle': marker.get_name(),
                                       'lat': 45.70,
                                       'lon': -122.9, 'radius': 500,