Merge pull request #891 from martinRenou/search_location_found_callback

SearchControl: location found callback

Author: martinRenou

docs/source/api_reference/search_control.rst

@@ -21,6 +21,27 @@ Example
 
     m
 
+You can add a callback that will be run when on search found:
+
+.. jupyter-execute::
+
+    m = Map(center=[47, 2], zoom=5)
+
+    search = SearchControl(
+        position="topleft",
+        url='https://cartoradon.irsn.fr/commune.py/communes/search/FR/{s}?',
+        zoom=5
+    )
+    m.add_control(search)
+
+    def on_found(**kwargs):
+        # Print the result of the search (text, location etc)
+        print(kwargs)
+
+    search.on_location_found(on_found)
+
+    m
+
 You can also search features from GeoJSON layers.
 
 .. jupyter-execute::
@@ -77,5 +98,6 @@ Methods
 ================     =====================================     ===
 Method               Arguments                                 Doc
 ================     =====================================     ===
+on_location_found    Callable object                           Adds a callback on location found event.
 on_feature_found     Callable object                           Adds a callback on found event for searching in GeoJSON layer.
-================     =====================================     ===
+================     =====================================     ===

ipyleaflet/leaflet.py

@@ -1894,15 +1894,19 @@ class SearchControl(Control):
     marker = Instance(Marker, allow_none=True, default_value=None).tag(sync=True, **widget_serialization)
     layer = Instance(LayerGroup, allow_none=True, default_value=None).tag(sync=True, **widget_serialization)
 
+    _location_found_callbacks = Instance(CallbackDispatcher, ())
     _feature_found_callbacks = Instance(CallbackDispatcher, ())
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self.on_msg(self._handle_leaflet_event)
 
     def _handle_leaflet_event(self, _, content, buffers):
-        if content.get('event', '') == 'found':
-            self._feature_found_callbacks(**content)
+        if content.get('event', '') == 'locationfound':
+            if content.get('feature', None) is not None:
+                self._feature_found_callbacks(**content)
+            else:
+                self._location_found_callbacks(**content)
 
     def on_feature_found(self, callback, remove=False):
         """Add a found feature event listener for searching in GeoJSON layer.
@@ -1916,6 +1920,18 @@ def on_feature_found(self, callback, remove=False):
         """
         self._feature_found_callbacks.register_callback(callback, remove=remove)
 
+    def on_location_found(self, callback, remove=False):
+        """Add a found location event listener. The callback will be called when a search result has been found.
+
+        Parameters
+        ----------
+        callback : callable
+            Callback function that will be called on location found event.
+        remove: boolean
+            Whether to remove this callback or not. Defaults to False.
+        """
+        self._location_found_callbacks.register_callback(callback, remove=remove)
+
 
 class MapStyle(Style, Widget):
     """Map Style Widget

js/src/controls/SearchControl.js

@@ -50,17 +50,21 @@ export class LeafletSearchControlView extends control.LeafletControlView {
   }
 
   leaflet_events() {
-    if (this.model.get('layer') !== null) {
+    this.obj.on('search:locationfound', (e) => {
+      if (e.layer !== null) {
         var found_style = this.model.get('found_style');
-        this.obj.on('search:locationfound', (e) => {
-           e.layer.setStyle(found_style);
-           if(e.layer._popup)
-              e.layer.openPopup();
-           this.send({
-             event: 'found',
-             feature: e.layer.feature
-           });
-        });
-    }
+        e.layer.setStyle(found_style);
+        if (e.layer._popup) {
+          e.layer.openPopup();
+        }
+      }
+
+      this.send({
+        event: 'locationfound',
+        text: e.text,
+        feature: e.layer !== null ? e.layer.feature : null,
+        location: [e.latlng.lat, e.latlng.lng]
+      });
+    });
   }
 }