Merge pull request #759 from ocefpaf/leaflet-search_plugin

Leaflet search plugin

Author: ocefpaf

CHANGES.txt

@@ -1,6 +1,7 @@
 0.6.0
 ~~~~~
 
+- Added leaflet-search plugin (ghandic #759)
 - Improved Vector Layers docs, notebooks, and optional arguments (ocefpaf #731)
 - Implemented `export=False/True` option to the Draw plugin layer for saving
   GeoJSON files (ocefpaf #727)

examples/Features.ipynb

@@ -0,0 +1 @@
+{"type": "FeatureCollection", "generator": "overpass-turbo", "copyright": "The data included in this document is from www.openstreetmap.org. The data is made available under ODbL.", "timestamp": "2015-08-08T19:03:02Z", "features": [{"type": "Feature", "id": "node/500129236", "properties": {"@id": "node/500129236", "addr:city": "Roma", "addr:country": "IT", "addr:housenumber": "5", "addr:postcode": "00184", "addr:street": "Piazza della Madonna dei Monti", "amenity": "bar", "name": "la Bottega del caffe'"}, "geometry": {"type": "Point", "coordinates": [12.4910927, 41.8950196]}}, {"type": "Feature", "id": "node/560446888", "properties": {"@id": "node/560446888", "amenity": "bar", "name": "Marani"}, "geometry": {"type": "Point", "coordinates": [12.5132952, 41.8970607]}}, {"type": "Feature", "id": "node/574326909", "properties": {"@id": "node/574326909", "amenity": "bar", "name": "Il Faraone"}, "geometry": {"type": "Point", "coordinates": [12.4910603, 41.8948257]}}, {"type": "Feature", "id": "node/1213332726", "properties": {"@id": "node/1213332726", "addr:city": "Roma", "addr:country": "IT", "addr:housenumber": "139", "addr:postcode": "00185", "addr:street": "Via Principe Amedeo", "amenity": "bar", "name": "Snackbar Eugenio", "operator": "Marchetti Eugenio", "phone": "+39 06 4466154"}, "geometry": {"type": "Point", "coordinates": [12.5031364, 41.8970108]}}, {"type": "Feature", "id": "node/1660369493", "properties": {"@id": "node/1660369493", "addr:city": "Roma", "addr:country": "IT", "addr:housenumber": "27", "addr:street": "Via San Martino della Battaglia", "amenity": "bar", "name": "Pretorius Cafe'", "operator": "Cesarina Utilia", "phone": "+39 06 490077", "ref:vatin": "IT09397401002"}, "geometry": {"type": "Point", "coordinates": [12.5051946, 41.905864]}}, {"type": "Feature", "id": "node/1660404822", "properties": {"@id": "node/1660404822", "addr:city": "Roma", "addr:country": "IT", "addr:housenumber": "9", "addr:street": "Via Clementina", "amenity": "bar", "cuisine": "regional", "name": "Casa Clementina", "operator": "Flexy Soc.Coop Arl.", "phone": "+39 06 48913254", "ref:vatin": "IT09253451000", "restaurant:type": "enoteca"}, "geometry": {"type": "Point", "coordinates": [12.492714, 41.8959687]}}, {"type": "Feature", "id": "node/1926196463", "properties": {"@id": "node/1926196463", "amenity": "bar", "name": "Twins"}, "geometry": {"type": "Point", "coordinates": [12.5009894, 41.8999812]}}, {"type": "Feature", "id": "node/2092013187", "properties": {"@id": "node/2092013187", "addr:housenumber": "12", "addr:street": "Via di San Giovanni in Laterano", "amenity": "bar", "name": "My Bar", "operator": "Anfiteatro S.r.l.", "phone": "+39 06 7004425", "ref:vatin": "IT067475410008"}, "geometry": {"type": "Point", "coordinates": [12.4946166, 41.8898973]}}, {"type": "Feature", "id": "node/2128214065", "properties": {"@id": "node/2128214065", "addr:city": "Roma", "addr:country": "IT", "addr:housenumber": "106", "addr:postcode": "00184", "addr:street": "Via di San Giovanni in Laterano", "amenity": "bar", "cuisine": "italian", "name": "San Clemente", "source": "GPS", "website": "http://www.iclementini.it/"}, "geometry": {"type": "Point", "coordinates": [12.4979123, 41.8889233]}}, {"type": "Feature", "id": "node/2244964954", "properties": {"@id": "node/2244964954", "addr:housenumber": "40", "addr:street": "Via Palestro", "amenity": "bar", "contact:phone": "+39 06 49382682", "contact:website": "http://the-yellow.com/", "name": "The Yellow Bar", "payment:bitcoin": "yes"}, "geometry": {"type": "Point", "coordinates": [12.5045633, 41.9048511]}}, {"type": "Feature", "id": "node/2361780469", "properties": {"@id": "node/2361780469", "addr:city": "Roma", "addr:housenumber": "72/73", "addr:street": "Via Urbana", "amenity": "bar", "name": "Er Caffettiere", "operator": "Sa.Pe. SNC di Spartaco Pelle & C.", "phone": "+39 320 4168532", "ref:vatin": "IT09487221005", "restaurant:type:it": "bar;tavola_calda"}, "geometry": {"type": "Point", "coordinates": [12.4929144, 41.8949856]}}, {"type": "Feature", "id": "node/3217327590", "properties": {"@id": "node/3217327590", "addr:city": "Roma", "addr:housenumber": "65", "addr:street": "Via dei Cerchi", "amenity": "bar", "name": "0,75", "opening_hours": "Mo-Su 11:00-02:00", "phone": "+39 066875706"}, "geometry": {"type": "Point", "coordinates": [12.4839357, 41.8879519]}}, {"type": "Feature", "id": "node/3320437843", "properties": {"@id": "node/3320437843", "addr:housenumber": "26", "addr:street": "Via Capo d'Africa", "amenity": "bar", "name": "La Follia", "operator": "Dolce Calabria SAS di Morello Alessandra & C.", "phone": "+39 06 45477438", "ref:vatin": "IT11279721002", "restaurant:type:it": "wine_bar", "shop": "pastry"}, "geometry": {"type": "Point", "coordinates": [12.4952573, 41.8888415]}}, {"type": "Feature", "id": "node/3403821230", "properties": {"@id": "node/3403821230", "amenity": "bar", "name": "Snack bar peter bar"}, "geometry": {"type": "Point", "coordinates": [12.4978786, 41.9001486]}}, {"type": "Feature", "id": "node/3485963126", "properties": {"@id": "node/3485963126", "addr:housename": "Roma Termini", "addr:housenumber": "25", "addr:street": "Via Marsala", "amenity": "bar", "brand": "Chef Express", "building:level": "0", "name": "Buffet Roma Termini", "operator": "Chef Express S.p.A.", "ref:vatin": "IT00876120213"}, "geometry": {"type": "Point", "coordinates": [12.5023541, 41.9016306]}}, {"type": "Feature", "id": "node/3551307620", "properties": {"@id": "node/3551307620", "addr:housenumber": "30-34", "addr:street": "Via Ludovisi", "amenity": "bar", "name": "Bar Ludovisi", "operator": "Doppio Zero Srl.", "phone": "+39 06 42016014", "ref:vatin": "IT11344331001"}, "geometry": {"type": "Point", "coordinates": [12.4887487, 41.9069283]}}, {"type": "Feature", "id": "node/3578353919", "properties": {"@id": "node/3578353919", "addr:city": "Roma", "addr:country": "IT", "addr:housenumber": "36/37", "addr:postcode": "00185", "addr:street": "Via Merulana", "amenity": "bar", "name": "Il Pasticciaccio", "operator": "Angelo Blu s.r.l.", "phone": "+39 06 4826928", "ref:vatin": "IT09547101007"}, "geometry": {"type": "Point", "coordinates": [12.5005788, 41.8948307]}}, {"type": "Feature", "id": "node/3607603463", "properties": {"@id": "node/3607603463", "addr:city": "Roma", "addr:housenumber": "22", "addr:postcode": "00185", "addr:street": "Via Tiburtina", "amenity": "bar", "name": "Buddha Bar"}, "geometry": {"type": "Point", "coordinates": [12.5121332, 41.8971197]}}]}

examples/data/search_bars_rome.json

@@ -25,6 +25,7 @@
 from folium.plugins.time_slider_choropleth import TimeSliderChoropleth
 from folium.plugins.timestamped_geo_json import TimestampedGeoJson
 from folium.plugins.timestamped_wmstilelayer import TimestampedWmsTileLayers
+from folium.plugins.search import Search
 
 __all__ = [
     'BoatMarker',
@@ -42,4 +43,5 @@
     'TimeSliderChoropleth',
     'TimestampedGeoJson',
     'TimestampedWmsTileLayers',
+    'Search',
     ]

examples/data/search_states.json

@@ -0,0 +1,96 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import (absolute_import, division, print_function)
+
+from branca.element import CssLink, Figure, JavascriptLink, MacroElement
+
+from jinja2 import Template
+
+
+class Search(MacroElement):
+    """
+    Adds a search tool to your map.
+
+    Parameters
+    ----------
+    data: str/JSON
+        GeoJSON strings
+    search_zoom: int
+        zoom level when searching features, default 12
+    search_label: str
+        label to index the search, default 'name'
+    geom_type: str
+        geometry type, default 'Point'
+    position: str
+        Change the position of the search bar, can be:
+        'topleft', 'topright', 'bottomright' or 'bottomleft',
+        default 'topleft'
+
+    See https://github.com/stefanocudini/leaflet-search for more information.
+
+    """
+    def __init__(self, data, search_zoom=12, search_label='name', geom_type='Point', position='topleft'):
+        super(Search, self).__init__()
+        self.position = position
+        self.data = data
+        self.search_label = search_label
+        self.search_zoom = search_zoom
+        self.geom_type = geom_type
+
+        self._template = Template("""
+        {% macro script(this, kwargs) %}
+
+            var {{this.get_name()}} = new L.GeoJSON({{this.data}});
+
+            {{this._parent.get_name()}}.addLayer({{this.get_name()}});
+
+            var searchControl = new L.Control.Search({
+                layer: {{this.get_name()}},
+                propertyName: '{{this.search_label}}',
+            {% if this.geom_type == 'Point' %}
+                initial: false,
+                zoom: {{this.search_zoom}},
+                position:'{{this.position}}',
+                hideMarkerOnCollapse: true
+            {% endif %}
+            {% if this.geom_type == 'Polygon' %}
+                marker: false,
+                moveToLocation: function(latlng, title, map) {
+                var zoom = {{this._parent.get_name()}}.getBoundsZoom(latlng.layer.getBounds());
+                    {{this._parent.get_name()}}.setView(latlng, zoom); // access the zoom
+                }
+            {% endif %}
+                });
+                searchControl.on('search:locationfound', function(e) {
+
+                    e.layer.setStyle({fillColor: '#3f0', color: '#0f0'});
+                    if(e.layer._popup)
+                        e.layer.openPopup();
+
+                }).on('search:collapsed', function(e) {
+
+                    {{this.get_name()}}.eachLayer(function(layer) {   //restore feature color
+                        {{this.get_name()}}.resetStyle(layer);
+                    });
+                });
+            {{this._parent.get_name()}}.addControl( searchControl );
+
+        {% endmacro %}
+        """)  # noqa
+
+    def render(self, **kwargs):
+        super(Search, self).render()
+
+        figure = self.get_root()
+        assert isinstance(figure, Figure), ('You cannot render this Element '
+                                            'if it is not in a Figure.')
+
+        figure.header.add_child(
+            JavascriptLink('https://cdn.jsdelivr.net/npm/[email protected]/dist/leaflet-search.min.js'),  # noqa
+            name='Leaflet.Search.js'
+        )
+
+        figure.header.add_child(
+            CssLink('https://cdn.jsdelivr.net/npm/[email protected]/dist/leaflet-search.min.css'),  # noqa
+            name='Leaflet.Search.css'
+        )