Fix test_line

Author: Martin Journois

folium/features.py

@@ -463,3 +463,49 @@ def __init__(self, popup=None):
                 {{this._parent.get_name()}}.on('click', newMarker);
             {% endmacro %}
             """)
+
+class PolyLine(MacroElement):
+    def __init__(self, locations, color=None, weight=None, opacity=None, latlon=True):
+        """Creates a PolyLine object to append into a map with Map.add_children.
+
+        Parameters
+        ----------
+            locations: list of points (latitude, longitude)
+                Latitude and Longitude of line (Northing, Easting)
+            color: string, default Leaflet's default ('#03f')
+            weight: float, default Leaflet's default (5)
+            opacity: float, default Leaflet's default (0.5)
+            latlon: bool, default True
+                Whether locations are given in the form [[lat,lon]] or not ([[lon,lat]] if False).
+                Note that the default GeoJson format is latlon=False,
+                while Leaflet polyline's default is latlon=True.
+
+                examples :
+                    # providing file
+                    GeoJson(open('foo.json'))
+
+                    # providing dict
+                    GeoJson(json.load(open('foo.json')))
+
+                    # providing string
+                    GeoJson(open('foo.json').read())
+        """
+        super(PolyLine, self).__init__()
+        self._name = 'PolyLine'
+        self.data = [[x[1],x[0]] for x in locations] if not latlon else locations
+        self.color = color
+        self.weight = weight
+        self.opacity = opacity
+
+        self._template = Template(u"""
+            {% macro script(this, kwargs) %}
+                var {{this.get_name()}} = L.polyline(
+                    {{this.data}},
+                    {
+                        {% if this.color != None %}color: '{{ this.color }}',{% endif %}
+                        {% if this.weight != None %}weight: {{ this.weight }},{% endif %}
+                        {% if this.opacity != None %}opacity: {{ this.opacity }},{% endif %}
+                        });
+                {{this._parent.get_name()}}.addLayer({{this.get_name()}});
+            {% endmacro %}
+            """)

folium/folium.py

@@ -26,7 +26,7 @@
 from .element import Element, Figure, JavascriptLink, CssLink, Div, MacroElement
 from .map import Map, TileLayer, Icon, Marker, Popup
 from .features import WmsTileLayer, RegularPolygonMarker, Vega, GeoJson, GeoJsonStyle, MarkerCluster, DivIcon,\
-    CircleMarker, LatLngPopup, ClickForMarker, ColorScale, TopoJson
+    CircleMarker, LatLngPopup, ClickForMarker, ColorScale, TopoJson, PolyLine
 from .utilities import color_brewer
 #import sys
 #import base64
@@ -378,55 +378,51 @@ def div_markers(self, locations=None, popups=None,
                             popup = Popup(popup),
                             icon = DivIcon(width=marker_size, height=marker_size))
             self.add_children(marker)
-#
-#    @iter_obj('line')
-#    def line(self, locations,
-#             line_color=None, line_opacity=None, line_weight=None,
-#             popup=None, popup_width=300):
-#        """Add a line to the map with optional styles.
-#
-#        Parameters
-#        ----------
-#        locations: list of points (latitude, longitude)
-#            Latitude and Longitude of line (Northing, Easting)
-#        line_color: string, default Leaflet's default ('#03f')
-#        line_opacity: float, default Leaflet's default (0.5)
-#        line_weight: float, default Leaflet's default (5)
-#        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).
-#
-#        Note: If the optional styles are omitted, they will not be included
-#        in the HTML output and will obtain the Leaflet defaults listed above.
-#
-#        Example
-#        -------
-#        >>>map.line(locations=[(45.5, -122.3), (42.3, -71.0)])
-#        >>>map.line(locations=[(45.5, -122.3), (42.3, -71.0)],
-#                    line_color='red', line_opacity=1.0)
-#
-#        """
-#        count = self.mark_cnt['line']
-#
-#        line_temp = self.env.get_template('polyline.js')
-#
-#        polyline_opts = {'color': line_color, 'weight': line_weight,
-#                         'opacity': line_opacity}
-#
-#        varname = 'line_{}'.format(count)
-#        line_rendered = line_temp.render({'line': varname,
-#                                          'locations': locations,
-#                                          'options': polyline_opts})
-#
-#        popup_out = self._popup_render(popup=popup, mk_name='line_',
-#                                       count=count, width=popup_width)
-#
-#        add_line = 'map.addLayer({});'.format(varname)
-#        append = (line_rendered, popup_out, add_line)
-#        self.template_vars.setdefault('lines', []).append((append))
-#
+
+    def line(self, locations,
+             line_color=None, line_opacity=None, line_weight=None,
+             popup=None, popup_width=300, latlon=True):
+        """Add a line to the map with optional styles.
+
+        Parameters
+        ----------
+        locations: list of points (latitude, longitude)
+            Latitude and Longitude of line (Northing, Easting)
+        line_color: string, default Leaflet's default ('#03f')
+        line_opacity: float, default Leaflet's default (0.5)
+        line_weight: float, default Leaflet's default (5)
+        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).
+        latlon: bool, default True
+            Whether locations are given in the form [[lat,lon]] or not ([[lon,lat]] if False).
+            Note that the default GeoJson format is latlon=False,
+            while Leaflet polyline's default is latlon=True.
+
+        Note: If the optional styles are omitted, they will not be included
+        in the HTML output and will obtain the Leaflet defaults listed above.
+
+        Example
+        -------
+        >>>map.line(locations=[(45.5, -122.3), (42.3, -71.0)])
+        >>>map.line(locations=[(45.5, -122.3), (42.3, -71.0)],
+                    line_color='red', line_opacity=1.0)
+
+        """
+
+        p = PolyLine(locations,
+                     color=line_color,
+                     weight=line_weight,
+                     opacity=line_opacity,
+                     latlon=latlon,
+                     )
+
+        if popup is not None:
+            p.add_children(Popup(popup, max_width=popup_width))
+
+        self.add_children(p)
 #    @iter_obj('multiline')
 #    def multiline(self, locations, line_color=None, line_opacity=None,
 #                  line_weight=None):

folium/templates/polyline.js

@@ -1,5 +1,4 @@
-var latLngs = [{% for loc in locations %} [{{ loc[0] }}, {{ loc[1] }}], {% endfor %}];
-var {{ line }} = L.polyline(latLngs,{
+var {{ this.get_name() }} = L.polyline({{locations}},{
 {% if options.color != None %}color: '{{ options.color }}',{% endif %}
 {% if options.weight != None %}weight: {{ options.weight }},{% endif %}
 {% if options.opacity != None %}opacity: {{ options.opacity }},{% endif %}

tests/test_folium.py

@@ -20,7 +20,7 @@
 from folium.element import Html
 from folium.map import Popup, Marker, Icon
 from folium.features import DivIcon, CircleMarker, LatLngPopup, GeoJson,\
-    GeoJsonStyle, ColorScale, TopoJson
+    GeoJsonStyle, ColorScale, TopoJson, PolyLine
 
 
 rootpath = os.path.abspath(os.path.dirname(__file__))
@@ -560,15 +560,22 @@ def test_line(self):
             [[45.5237, -122.6750], [45.5237, -122.6751]],
             [[45.5238, -122.6750], [45.5238, -122.6751]]
         ]
-        line_rendered = line_temp.render({'line': 'line_1',
-                                          'locations': locations,
-                                          'options': line_opts})
 
+        self.setup()
         self.map.line(locations=locations,
                       line_color=line_opts['color'],
                       line_weight=line_opts['weight'],
                       line_opacity=line_opts['opacity'])
-        assert self.map.template_vars['lines'][0][0] == line_rendered
+        polyline = [val for key,val in self.map._children.items()\
+                    if isinstance(val,PolyLine)][0]
+        out = self.map._parent.render()
+
+        line_rendered = line_temp.render({'line': 'line_1',
+                                          'this':polyline,
+                                          'locations': locations,
+                                          'options': line_opts})
+
+        assert ''.join(line_rendered.split()) in ''.join(out.split())
 
     def test_multi_polyline(self):
         """Test multi_polyline."""