Merge pull request #283 from BibMartin/issue259

RegularPolygonMarker and CircleMarker are instances of Marker

Author: ocefpaf

folium/features.py

@@ -9,10 +9,11 @@
 import json
 
 from .utilities import (color_brewer, _parse_size, legend_scaler,
-                        _locations_mirror, _locations_tolist, image_to_url)
+                        _locations_mirror, _locations_tolist, image_to_url,
+                        text_type, binary_type)
 
 from .element import Element, Figure, JavascriptLink, CssLink, MacroElement
-from .map import TileLayer, Icon
+from .map import TileLayer, Icon, Marker, Popup
 
 
 class WmsTileLayer(TileLayer):
@@ -48,7 +49,7 @@ def __init__(self, url, name=None,
         """)  # noqa
 
 
-class RegularPolygonMarker(MacroElement):
+class RegularPolygonMarker(Marker):
     def __init__(self, location, color='black', opacity=1, weight=2,
                  fill_color='blue', fill_opacity=1,
                  number_of_sides=4, rotation=0, radius=15, popup=None):
@@ -85,9 +86,8 @@ def __init__(self, location, color='black', opacity=1, weight=2,
 
         For more information, see https://humangeo.github.io/leaflet-dvf/
         """
-        super(RegularPolygonMarker, self).__init__()
+        super(RegularPolygonMarker, self).__init__(location, popup=popup)
         self._name = 'RegularPolygonMarker'
-        self.location = location
         self.color = color
         self.opacity = opacity
         self.weight = weight
@@ -96,8 +96,6 @@ def __init__(self, location, color='black', opacity=1, weight=2,
         self.number_of_sides = number_of_sides
         self.rotation = rotation
         self.radius = radius
-        if popup is not None:
-            self.add_children(popup)
 
         self._template = Template(u"""
             {% macro script(this, kwargs) %}
@@ -420,22 +418,19 @@ def __init__(self, html=None, icon_size=None, icon_anchor=None,
             """)  # noqa
 
 
-class CircleMarker(MacroElement):
+class CircleMarker(Marker):
     def __init__(self, location, radius=500, color='black',
                  fill_color='black', fill_opacity=0.6, popup=None):
         """
         TODO docstring here
 
         """
-        super(CircleMarker, self).__init__()
+        super(CircleMarker, self).__init__(location, popup=popup)
         self._name = 'CircleMarker'
-        self.location = location
         self.radius = radius
         self.color = color
         self.fill_color = fill_color
         self.fill_opacity = fill_opacity
-        if popup is not None:
-            self.add_children(popup)
 
         self._template = Template(u"""
             {% macro script(this, kwargs) %}
@@ -508,7 +503,7 @@ def __init__(self, popup=None):
 
 class PolyLine(MacroElement):
     def __init__(self, locations, color=None, weight=None,
-                 opacity=None, latlon=True):
+                 opacity=None, latlon=True, popup=None):
         """
         Creates a PolyLine object to append into a map with
         Map.add_children.
@@ -525,6 +520,8 @@ def __init__(self, locations, color=None, weight=None,
             or not ([[lon, lat]] if False).
             Note that the default GeoJson format is latlon=False,
             while Leaflet polyline's default is latlon=True.
+        popup: string or folium.Popup, default None
+            Input text or visualization for object.
         """
         super(PolyLine, self).__init__()
         self._name = 'PolyLine'
@@ -533,6 +530,10 @@ def __init__(self, locations, color=None, weight=None,
         self.color = color
         self.weight = weight
         self.opacity = opacity
+        if isinstance(popup, text_type) or isinstance(popup, binary_type):
+            self.add_children(Popup(popup))
+        elif popup is not None:
+            self.add_children(popup)
 
         self._template = Template(u"""
             {% macro script(this, kwargs) %}
@@ -550,7 +551,7 @@ def __init__(self, locations, color=None, weight=None,
 
 class MultiPolyLine(MacroElement):
     def __init__(self, locations, color=None, weight=None,
-                 opacity=None, latlon=True):
+                 opacity=None, latlon=True, popup=None):
         """
         Creates a MultiPolyLine object to append into a map with
         Map.add_children.
@@ -567,6 +568,8 @@ def __init__(self, locations, color=None, weight=None,
             or not ([[lon, lat]] if False).
             Note that the default GeoJson format is latlon=False,
             while Leaflet polyline's default is latlon=True.
+        popup: string or folium.Popup, default None
+            Input text or visualization for object.
         """
         super(MultiPolyLine, self).__init__()
         self._name = 'MultiPolyLine'
@@ -575,6 +578,10 @@ def __init__(self, locations, color=None, weight=None,
         self.color = color
         self.weight = weight
         self.opacity = opacity
+        if isinstance(popup, text_type) or isinstance(popup, binary_type):
+            self.add_children(Popup(popup))
+        elif popup is not None:
+            self.add_children(popup)
 
         self._template = Template(u"""
             {% macro script(this, kwargs) %}

folium/map.py

@@ -363,11 +363,8 @@ def __init__(self, location, popup=None, icon=None):
         ----------
         location: tuple or list, default None
             Latitude and Longitude of Marker (Northing, Easting)
-        popup: string or tuple, default 'Pop Text'
-            Input text or visualization for object. Can pass either text,
-            or a tuple of the form (Vincent object, 'vis_path.json')
-            It is possible to adjust the width of text/HTML popups
-            using the optional keywords `popup_width` (default is 300px).
+        popup: string or folium.Popup, default None
+            Input text or visualization for object.
         icon: Icon plugin
             the Icon plugin to use to render the marker.
 
@@ -377,16 +374,17 @@ def __init__(self, location, popup=None, icon=None):
 
         Example
         -------
-        >>>map.simple_marker(location=[45.5, -122.3], popup='Portland, OR')
-        >>>map.simple_marker(location=[45.5, -122.3], popup=(vis, 'vis.json'))
-
+        >>> Marker(location=[45.5, -122.3], popup='Portland, OR')
+        >>> Marker(location=[45.5, -122.3], popup=folium.Popup('Portland, OR'))
         """
         super(Marker, self).__init__()
         self._name = 'Marker'
         self.location = location
         if icon is not None:
             self.add_children(icon)
-        if popup is not None:
+        if isinstance(popup, text_type) or isinstance(popup, binary_type):
+            self.add_children(Popup(popup))
+        elif popup is not None:
             self.add_children(popup)
 
         self._template = Template(u"""

tests/test_features.py

@@ -6,7 +6,7 @@
 """
 
 import os
-from folium import Map
+from folium import Map, Popup
 from folium import features
 from folium.six import text_type
 from folium.element import Element
@@ -79,6 +79,23 @@ def test_figure_double_rendering():
     out2 = f.render()
     assert out == out2
 
+def test_marker_popups():
+    m = Map()
+    features.Marker([45,-180],popup='-180').add_to(m)
+    features.Marker([45,-120],popup=Popup('-120')).add_to(m)
+    features.RegularPolygonMarker([45,-60],popup='-60').add_to(m)
+    features.RegularPolygonMarker([45,0],popup=Popup('0')).add_to(m)
+    features.CircleMarker([45,60],popup='60').add_to(m)
+    features.CircleMarker([45,120],popup=Popup('120')).add_to(m)
+    m._repr_html_()
+
+def test_polyline_popups():
+    m = Map([43,-100], zoom_start=4)
+    features.PolyLine([[40,-80],[45,-80]], popup="PolyLine").add_to(m)
+    features.PolyLine([[40,-90],[45,-90]], popup=Popup("PolyLine")).add_to(m)
+    features.MultiPolyLine([[[40,-110],[45,-110]]], popup="MultiPolyLine").add_to(m)
+    features.MultiPolyLine([[[40,-120],[45,-120]]], popup=Popup("MultiPolyLine")).add_to(m)
+    m._repr_html_()
 
 # DivIcon.
 def test_divicon():