Add popup option for PolyLine and MultiPolyLine

Author: Martin Journois

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, Marker
+from .map import TileLayer, Icon, Marker, Popup
 
 
 class WmsTileLayer(TileLayer):
@@ -502,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.
@@ -519,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'
@@ -527,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) %}
@@ -544,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.
@@ -561,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'
@@ -569,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

@@ -374,8 +374,8 @@ 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=folium.Popup('Portland, OR'))
+        >>> 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'

tests/test_features.py

@@ -89,6 +89,14 @@ def test_marker_popups():
     features.CircleMarker([45,120],popup=Popup('120')).add_to(m)
     m._repr_html_()
 
+def test_polyline_popups():
+    m = folium.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():
     html = """<svg height="100" width="100">