DivIcons

Author: ocefpaf

folium/features.py

@@ -48,7 +48,7 @@ def __init__(self, url, name=None,
                 ).addTo({{this._parent.get_name()}});
 
         {% endmacro %}
-        """)
+        """)  # noqa
 
 
 class RegularPolygonMarker(MacroElement):
@@ -99,7 +99,7 @@ def render(self, **kwargs):
                                             "if it's not in a Figure.")
 
         figure.header.add_children(
-            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet-dvf/0.2/leaflet-dvf.markers.min.js"),
+            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet-dvf/0.2/leaflet-dvf.markers.min.js"),  # noqa
             name='dvf_js')
 
 
@@ -145,11 +145,11 @@ def render(self, **kwargs):
             """).render(this=self, **kwargs)), name=self.get_name())
 
         figure.header.add_children(
-            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.5/d3.min.js"),
+            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.5/d3.min.js"),  # noqa
             name='d3')
 
         figure.header.add_children(
-            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/vega/1.4.3/vega.min.js"),
+            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/vega/1.4.3/vega.min.js"),  # noqa
             name='vega')
 
         figure.header.add_children(
@@ -158,7 +158,7 @@ def render(self, **kwargs):
 
         figure.script.add_children(
             Template("""function vega_parse(spec, div) {
-            vg.parse.spec(spec, function(chart) { chart({el:div}).update(); });}"""),
+            vg.parse.spec(spec, function(chart) { chart({el:div}).update(); });}"""),  # noqa
             name='vega_parse')
 
 
@@ -170,20 +170,21 @@ def __init__(self, data):
         Parameters
         ----------
             data: file, dict or str.
-                The geo-json data you want to plot.
-                If file, then data will be read in the file and fully embedded in Leaflet's javascript.
-                If dict, then data will be converted to JSON and embedded in the javascript.
-                If str, then data will be passed to the javascript as-is.
+                The GeoJSON data you want to plot.
+                * If file, then data will be read in the file and fully
+                  embedded in Leaflet's JavaScript.
+                * If dict, then data will be converted to JSON and embedded
+                  in the JavaScript.
+                * If str, then data will be passed to the JavaScript as-is.
+
+                Examples:
+                >>> # Providing file.
+                >>> GeoJson(open('foo.json'))
+                >>> # Providing dict.
+                >>> GeoJson(json.load(open('foo.json')))
+                >>> # Providing string.
+                >>> GeoJson(open('foo.json').read())
 
-                examples :
-                    # providing file
-                    GeoJson(open('foo.json'))
-
-                    # providing dict
-                    GeoJson(json.load(open('foo.json')))
-
-                    # providing string
-                    GeoJson(open('foo.json').read())
         """
         super(GeoJson, self).__init__()
         self._name = 'GeoJson'
@@ -198,7 +199,7 @@ def __init__(self, data):
             {% macro script(this, kwargs) %}
                 var {{this.get_name()}} = L.geoJson({{this.data}}).addTo({{this._parent.get_name()}});
             {% endmacro %}
-            """)
+            """)  # noqa
 
 
 class TopoJson(MacroElement):
@@ -234,7 +235,7 @@ def render(self, **kwargs):
                                             "if it's not in a Figure.")
 
         figure.header.add_children(
-            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/topojson/1.6.9/topojson.min.js"),
+            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/topojson/1.6.9/topojson.min.js"),  # noqa
             name='topojson')
 
 
@@ -306,7 +307,7 @@ def render(self, **kwargs):
                                             "if it's not in a Figure.")
 
         figure.header.add_children(
-            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.5/d3.min.js"),
+            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.5/d3.min.js"),  # noqa
             name='d3')
 
 
@@ -334,7 +335,7 @@ def render(self, **kwargs):
                                             "if it's not in a Figure.")
 
         figure.header.add_children(
-            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.5/d3.min.js"),
+            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.5/d3.min.js"),  # noqa
             name='d3')
 
 
@@ -363,39 +364,73 @@ def render(self, **kwargs):
         assert isinstance(figure, Figure), ("You cannot render this Element "
                                             "if it's not in a Figure.")
         figure.header.add_children(
-            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/leaflet.markercluster-src.js"),
+            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/leaflet.markercluster-src.js"),  # noqa
             name='marker_cluster_src')
 
         figure.header.add_children(
-            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/leaflet.markercluster.js"),
+            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/leaflet.markercluster.js"),  # noqa
             name='marker_cluster')
 
         figure.header.add_children(
-            CssLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/MarkerCluster.css"),
+            CssLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/MarkerCluster.css"),  # noqa
             name='marker_cluster_css')
 
         figure.header.add_children(
-            CssLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/MarkerCluster.Default.css"),
+            CssLink("https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/MarkerCluster.Default.css"),  # noqa
             name="marker_cluster_default_css")
 
 
-class DivIcon(MacroElement):
-    def __init__(self, width=30, height=30):
-        """TODO : docstring here"""
+class DivIcon(Icon):
+    def __init__(self, html=None, icon_size=None, icon_anchor=None,
+                 popup_anchor=None, class_name='empty'):
+        """
+        Represents a lightweight icon for markers that uses a simple `div`
+        element instead of an image.
+
+        Parameters
+        ----------
+        icon_size : tuple of 2 int
+            Size of the icon image in pixels.
+        icon_anchor : tuple of 2 int
+            The coordinates of the "tip" of the icon
+            (relative to its top left corner).
+            The icon will be aligned so that this point is at the
+            marker's geographical location.
+        popup_anchor : tuple of 2 int
+            The coordinates of the point from which popups will "open",
+            relative to the icon anchor.
+        class_name : string
+            A custom class name to assign to the icon.
+            Leaflet defaults is 'leaflet-div-icon' which draws a little white
+            square with a shadow.  We set it 'empty' in folium.
+        html : string
+            A custom HTML code to put inside the div element.
+
+        For more information see:
+        http://leafletjs.com/reference.html#divicon
+
+        """
         super(DivIcon, self).__init__()
         self._name = 'DivIcon'
-        self.width = width
-        self.height = height
+        self.icon_size = icon_size
+        self.icon_anchor = icon_anchor
+        self.popup_anchor = popup_anchor
+        self.html = html
+        self.className = class_name
 
         self._template = Template(u"""
             {% macro script(this, kwargs) %}
+
                 var {{this.get_name()}} = L.divIcon({
-                    className: 'leaflet-div-icon',
-                    'iconSize': [{{ this.width }},{{ this.height }}]
+                    {% if this.icon_size %}iconSize: [{{this.icon_size[0]}},{{this.icon_size[1]}}],{% endif %}
+                    {% if this.icon_anchor %}iconAnchor: [{{this.icon_anchor[0]}},{{this.icon_anchor[1]}}],{% endif %}
+                    {% if this.popup_anchor %}popupAnchor: [{{this.popup_anchor[0]}},{{this.popup_anchor[1]}}],{% endif %}
+                    {% if this.className %}className: '{{this.className}}',{% endif %}
+                    {% if this.html %}html: '{{this.html}}',{% endif %}
                     });
                 {{this._parent.get_name()}}.setIcon({{this.get_name()}});
             {% endmacro %}
-            """)
+            """)  # noqa
 
 
 class CircleMarker(MacroElement):
@@ -449,7 +484,7 @@ def __init__(self):
                     }
                 {{this._parent.get_name()}}.on('click', latLngPop);
             {% endmacro %}
-            """)
+            """)  # noqa
 
 
 class ClickForMarker(MacroElement):
@@ -476,7 +511,7 @@ def __init__(self, popup=None):
                     };
                 {{this._parent.get_name()}}.on('click', newMarker);
             {% endmacro %}
-            """)
+            """)  # noqa
 
 
 class PolyLine(MacroElement):
@@ -517,7 +552,7 @@ def __init__(self, locations, color=None, weight=None,
                         });
                 {{this._parent.get_name()}}.addLayer({{this.get_name()}});
             {% endmacro %}
-            """)
+            """)  # noqa
 
 
 class MultiPolyLine(MacroElement):
@@ -558,7 +593,7 @@ def __init__(self, locations, color=None, weight=None,
                         });
                 {{this._parent.get_name()}}.addLayer({{this.get_name()}});
             {% endmacro %}
-            """)
+            """)  # noqa
 
 
 class ImageOverlay(MacroElement):
@@ -572,10 +607,13 @@ def __init__(self, image, bounds, opacity=1., attribution=None,
             image: string, file or array-like object
                 The data you want to draw on the map.
                 * If string, it will be written directly in the output file.
-                * If file, it's content will be converted as embeded in the output file.
-                * If array-like, it will be converted to PNG base64 string and embedded in the output.
+                * If file, it's content will be converted as embedded in the
+                  output file.
+                * If array-like, it will be converted to PNG base64 string
+                  and embedded in the output.
             bounds: list
-                Image bounds on the map in the form [[lat_min, lon_min], [lat_max, lon_max]]
+                Image bounds on the map in the form [[lat_min, lon_min],
+                [lat_max, lon_max]]
             opacity: float, default Leaflet's default (1.0)
             attr: string, default Leaflet's default ("")
             origin : ['upper' | 'lower'], optional, default 'upper'
@@ -584,11 +622,14 @@ def __init__(self, image, bounds, opacity=1., attribution=None,
             colormap : callable, used only for `mono` image.
                 Function of the form [x -> (r,g,b)] or [x -> (r,g,b,a)]
                 for transforming a mono image into RGB.
-                It must output iterables of length 3 or 4, with values between 0. and 1.
+                It must output iterables of length 3 or 4,
+                with values between 0 and 1.
                 Hint : you can use colormaps from `matplotlib.cm`.
-            mercator_project : bool, default False, used only for array-like image.
-                Transforms the data to project (longitude, latitude)
-                coordinates to the Mercator projection.
+            mercator_project : bool, default False.
+                Used only for array-like image.  Transforms the data to
+                project (longitude, latitude) coordinates to the
+                Mercator projection.
+
         """
         super(ImageOverlay, self).__init__()
         self._name = 'ImageOverlay'
@@ -627,8 +668,10 @@ def __init__(self, icon_image, icon_size=None, icon_anchor=None,
             icon_image :  string, file or array-like object
                 The data you want to use as an icon.
                 * If string, it will be written directly in the output file.
-                * If file, it's content will be converted as embedded in the output file.
-                * If array-like, it will be converted to PNG base64 string and embedded in the output.
+                * If file, it's content will be converted as embedded in the
+                  output file.
+                * If array-like, it will be converted to PNG base64 string
+                  and embedded in the output.
             icon_size : tuple of 2 int
                 Size of the icon image in pixels.
             icon_anchor : tuple of 2 int
@@ -647,6 +690,7 @@ def __init__(self, icon_image, icon_size=None, icon_anchor=None,
             popup_anchor : tuple of 2 int
                 The coordinates of the point from which popups will "open",
                 relative to the icon anchor.
+
         """
         super(Icon, self).__init__()
         self._name = 'CustomIcon'
@@ -676,4 +720,4 @@ def __init__(self, icon_image, icon_size=None, icon_anchor=None,
                     });
                 {{this._parent.get_name()}}.setIcon({{this.get_name()}});
             {% endmacro %}
-            """)
+            """)  # noqa