@abi-software/flatmap-viewer 2.2.2-beta.1 → 2.2.2-beta.3

package/README.rst

@@ -38,7 +38,7 @@ The map server endpoint is specified as ``MAP_ENDPOINT`` in ``src/main.js``. It
 Package Installation
 ====================
 
-* ``npm install @abi-software/flatmap-viewer@2.2.2-beta.1``
+* ``npm install @abi-software/flatmap-viewer@2.2.2-beta.3``
 
 Documentation
 -------------

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abi-software/flatmap-viewer",
-  "version": "2.2.2-beta.1",
+  "version": "2.2.2-beta.3",
   "description": "Flatmap viewer using Maplibre GL",
   "repository": "https://github.com/AnatomicMaps/flatmap-viewer.git",
   "main": "src/main.js",

package/src/flatmap-viewer.js

@@ -36,7 +36,7 @@ import '../static/flatmap-viewer.css';
 import {MapServer} from './mapserver.js';
 import {MinimapControl} from './minimap.js';
 import {NavigationControl} from './controls.js';
-import {SearchIndex} from './search.js';
+import {SearchIndex, SearchResults} from './search.js';
 import {UserInteractions} from './interactions.js';
 
 import * as images from './images.js';
@@ -921,10 +921,24 @@ class FlatMap
 
     //==========================================================================
 
-    search(text)
-    //==========
+    /**
+     * Find features with labels or terms matching ``text``.
+     *
+     * @param      {string}   text          The text to search
+     * @param      {boolean}  [auto=false]  If ``true`` return suggestions of text to search for.
+     * @return     Either a ``Searchresults`` object with fields of ``featureIds`` and ``results``,
+     *             where ``results`` has ``featureId``, ``score``, ``terms`` and ``text`` fields,
+     *             or a ``Suggestion`` object containing suggested matches
+     *             (see https://lucaong.github.io/minisearch/modules/_minisearch_.html#suggestion).
+     */
+    search(text, auto=false)
+    //======================
     {
-        return this.__searchIndex.search(text);
+        if (auto) {
+            return this.__searchIndex.auto_suggest(text);
+        } else {
+            return this.__searchIndex.search(text);
+        }
     }
 
     clearSearchResults()

package/src/search.js

@@ -173,6 +173,12 @@ export class SearchIndex
         this._;
     }
 
+    auto_suggest(text)
+    //================
+    {
+        return this._searchEngine.autoSuggest(text, {prefix: true});
+    }
+
     search(text)
     //==========
     {
@@ -185,7 +191,14 @@ export class SearchIndex
         } else if (text.length > 1) {
             results = this._searchEngine.search(text, {prefix: true});
         }
-        return new SearchResults(results.map(result => this._featureIds[result.id]));
+        const featureResults = results.map(r => {
+            return {
+                featureId: this._featureIds[r.id],
+                score: r.score,
+                terms: r.terms,
+                text: r.text
+            }});
+        return new SearchResults(featureResults);
     }
 }
 
@@ -193,15 +206,21 @@ export class SearchIndex
 
 class SearchResults
 {
-    constructor(featureIds)
+    constructor(results)
     {
-        this.__featureIds = featureIds;
+        this.__results = results.sort((a, b) => (b.score - a.score));
+        this.__featureIds = results.map(r => r.featureId);
     }
 
     get featureIds()
     {
         return this.__featureIds;
     }
+
+    get results()
+    {
+        return this.__results;
+    }
 }
 
 //==============================================================================

package/static/flatmap-viewer.css

@@ -183,6 +183,10 @@ li.flatmap-contextmenu-item:hover {
     font-size: 10pt;
     cursor: pointer;
     text-align: left;
+    background: white;
+    border: 1px solid gray;
+    padding: 4px;
+    opacity: 0.8;
 }
 .flatmap-nerve-grid input {
     height:  1.1em;