Add options parameter to LocateControl plugin

Author: fullonic

folium/plugins/__init__.py

@@ -19,6 +19,7 @@
 from folium.plugins.fullscreen import Fullscreen
 from folium.plugins.heat_map import HeatMap
 from folium.plugins.heat_map_withtime import HeatMapWithTime
+from folium.plugins.locate_control import LocateControl
 from folium.plugins.marker_cluster import MarkerCluster
 from folium.plugins.measure_control import MeasureControl
 from folium.plugins.minimap import MiniMap
@@ -45,6 +46,7 @@
     'Fullscreen',
     'HeatMap',
     'HeatMapWithTime',
+    'LocateControl',
     'MarkerCluster',
     'MeasureControl',
     'MiniMap',

folium/plugins/locate_control.py

@@ -0,0 +1,61 @@
+"""Add Locate control to folium Map.
+
+Based on leaflet plugin: https://github.com/domoritz/leaflet-locatecontrol
+"""
+
+from branca.element import CssLink, Figure, JavascriptLink, MacroElement
+
+from jinja2 import Template
+
+
+class LocateControl(MacroElement):
+    """Control plugin to geolocate the user.
+
+    Parameters
+    ----------
+    options: dict, optional
+        For possible options, see https://github.com/domoritz/leaflet-locatecontrol
+
+    Examples
+    --------
+    >>> import folium
+    >>> from folium.plugins import LocateControl
+    >>> map = folium.Map()
+    # With default settings
+    >>> LocateControl().add_to(map)
+
+    # With custom options
+    >>> options = {"position": "topright",
+    ...             "strings":{
+    ...                     "title":"Show my current location"}}
+    >>> LocateControl(options=options).add_to(map)
+
+    For more info check:
+    https://github.com/domoritz/leaflet-locatecontrol
+
+    """
+
+    _template = Template(u"""
+                         {% macro script(this, kwargs) %}
+                         var {{this.get_name()}} = L.control.locate(
+                                        {{this.options|tojson}}).addTo({{this._parent.get_name()}});
+                         {% endmacro %}
+                         """)
+
+    def __init__(self, options=None):
+        """Initialization."""
+        super(LocateControl, self).__init__()
+        self._name = 'LocateControl'
+        self.options = options or {}
+
+    def render(self, **kwargs):
+        super(LocateControl, self).render(**kwargs)
+        figure = self.get_root()
+        assert isinstance(figure, Figure), ('You cannot render this Element '
+                                            'if it is not in a Figure.')
+
+        figure.header.add_child(
+            CssLink(
+                "https://cdnjs.cloudflare.com/ajax/libs/leaflet-locatecontrol/0.66.2/L.Control.Locate.min.css"))  # noqa
+        figure.header.add_child(JavascriptLink(
+            "https://cdnjs.cloudflare.com/ajax/libs/leaflet-locatecontrol/0.66.2/L.Control.Locate.min.js"))  # noqa