@abi-software/flatmap-viewer 2.7.0 → 2.7.1-a.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abi-software/flatmap-viewer",
-  "version": "2.7.0",
+  "version": "2.7.1-a.2",
   "description": "Flatmap viewer using Maplibre GL",
   "repository": {
     "type": "git",
@@ -11,7 +11,8 @@
   "files": [
     "lib",
     "src",
-    "static"
+    "static",
+    "thirdParty"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",

package/src/interactions.js

@@ -1020,6 +1020,10 @@ export class UserInteractions
         // Simulate `mouseenter` events on features
 
         const feature = features[0];
+
+//is feature a marker??
+console.log('mm', event.type, feature)
+
         const featureModels = ('properties' in feature && 'models' in feature.properties)
                             ? feature.properties.models
                             : null;
@@ -1444,6 +1448,7 @@ export class UserInteractions
     markerMouseEvent_(marker, anatomicalId, event)
     //============================================
     {
+console.log('mk', event.type)
         // No tooltip when context menu is open
         if (this._modal
          || (this.__activeMarker !== null && event.type === 'mouseleave')) {
@@ -1464,6 +1469,7 @@ export class UserInteractions
 
             this.markerEvent_(event, markerId, marker.getLngLat(),
                                      anatomicalId, annotation)
+console.log('mk handled...')
             event.stopPropagation()
         }
     }

package/src/layers/cluster.js

@@ -113,6 +113,7 @@ export class ClusteredMarkerLayer
             const features = this.#map.queryRenderedFeatures(e.point, {
                 layers: ['clustered-markers']
             })
+            console.log('Cluster marker', features)
             const clusterId = features[0].properties.cluster_id
             const zoom = await this.#map.getSource('markers').getClusterExpansionZoom(clusterId)
             this.#map.easeTo({
@@ -121,10 +122,10 @@ export class ClusteredMarkerLayer
             })
         })
 
-            console.log('Unclustered click', e, features)
         this.#map.on('click', 'single-points', this.singleMarkerEvent.bind(this))
         this.#map.on('mouseenter', 'single-points', this.singleMarkerEvent.bind(this))
         this.#map.on('mousemove', 'single-points', this.singleMarkerEvent.bind(this))
+//        this.#map.on('mouseleave', 'single-points', this.singleMarkerEvent.bind(this))
 
         this.#map.on('mouseenter', 'clustered-markers', () => {
             this.#map.getCanvas().style.cursor = 'pointer'
@@ -138,6 +139,7 @@ export class ClusteredMarkerLayer
     singleMarkerEvent(event)
     //======================
     {
+console.log('cl', event.type)
         const features = this.#map.queryRenderedFeatures(event.point, {
             layers: ['single-points']
         })
@@ -146,6 +148,7 @@ export class ClusteredMarkerLayer
             const position = properties.markerPosition.slice(1, -1).split(',').map(p => +p)
             this.#ui.markerEvent_(event, feature.id, position, properties.models, properties)
         }
+console.log('cl handled...')
         event.originalEvent.stopPropagation()
     }
 

package/src/layers/index.js

@@ -425,10 +425,14 @@ export class LayerManager
             mapLayer.setFilter(this.__layerOptions);
         }
         if (this.#flightPathLayer) {
+//    * @arg options.layerOptions.sckan {string} Show neuron paths known to SCKAN: values are ``valid`` (default),
+//    *                                        ``invalid``, ``all`` or ``none``.
+
+
             const sckanState = options.sckan || 'valid'
             const sckanFilter = (sckanState == 'none') ? {NOT: {HAS: 'sckan'}} :
                                 (sckanState == 'valid') ? {sckan: true} :
-                                (sckanState == 'invalid') ? {NOT: {sckan: true}} :
+                                (sckanState == 'invalid') ? {NOT: {sckan: true}} :  // {sckan: false} is different...
                                 true
             const featureFilter = new PropertiesFilter(sckanFilter)
             if ('taxons' in options) {

package/src/main.js

@@ -49,12 +49,15 @@ const ALL_MARKERS = [
     'UBERON:0037094',
     'ILX:0738305',
 
-    'UBERON:0000948', // {className: 'heart-marker'}); // Heart
+//    'UBERON:0000948', // {className: 'heart-marker'}); // Heart
     'UBERON:0002048', // Lung
     'UBERON:0000945', // Stomach
     'UBERON:0001155', // Colon
     'UBERON:0001255', // Bladder
     'UBERON:0001759', // Vagus
+
+    'UBERON:0016508', // Pelvic ganglion
+
 ]
 
 //==============================================================================
@@ -172,6 +175,8 @@ export async function standaloneViewer(map_endpoint=null, options={})
                     mapOptions.background = args[0].value;
                 } else if (eventType === 'annotation') {
                     drawControl.handleEvent(...args)
+                } else if (args[0].type === 'marker') {
+                    console.log(eventType, ...args)
                 }
             }, mapOptions)
             .then(map => {
@@ -183,7 +188,11 @@ export async function standaloneViewer(map_endpoint=null, options={})
                 map.addMarker('UBERON:0001255'); // Bladder
                 map.addMarker('UBERON:0001759'); // Vagus
 */
-                map.addMarkers(ALL_MARKERS, {cluster: true})
+                map.addMarker('UBERON:0000945', {cluster: true}); // Stomach
+//                map.addMarker('UBERON:0016508', {cluster: false}); // Pelvic ganglion
+                map.addMarker('UBERON:0016508', {cluster: true}); // Pelvic ganglion
+                map.addMarker('UBERON:0000948', {cluster: true, className: 'heart-marker'}); // Heart
+//                map.addMarkers(ALL_MARKERS)
                 currentMap = map;
                 drawControl = new DrawControl(map)
             })

package/src/types.ts

@@ -0,0 +1,26 @@
+/******************************************************************************
+
+Flatmap viewer and annotation tool
+
+Copyright (c) 2019 - 2024  David Brooks
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+******************************************************************************/
+
+export type Constructor<T> = new(...args: any[]) => T
+
+export type ObjectRecord = Record<string, any>
+
+//==============================================================================
+

package/src/utils.js

@@ -120,6 +120,7 @@ export function normaliseId(id)
 
 export function setDefaults(options, defaultOptions)
 {
+// c.f. Object.assign({}, defaultOptions, options)
     if (options === undefined || options === null) {
         return defaultOptions;
     }

package/thirdParty/maplibre-gl-svg/CHANGELOG.md

@@ -0,0 +1,13 @@
+## Maplibre GL SVG Plugin Changelog
+
+<a name="0.0.1"></a>
+# 0.0.1
+
+Initial release.
+
+**Features**
+
+- Load an SVG into the maps image sprite and use as an icon in a symbol layer, or as an fill pattern.
+- SVG templates manager to easily create reusable customizable icon templates using SVGs. Includes
+  - 27 built-in symbol/marker icon templates
+  - 15 built-in fill pattern templates.

package/thirdParty/maplibre-gl-svg/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ricky Brundritt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/thirdParty/maplibre-gl-svg/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ricky Brundritt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/thirdParty/maplibre-gl-svg/README.md

@@ -0,0 +1,24 @@
+# MapLibre GL SVG Plugin
+
+> Status: New plugin, still being validated. 
+
+A [maplibre-gl-js](https://maplibre.org/maplibre-gl-js/docs/) plugin that adds support for loading SVGs images into the maps image sprite.
+
+- [Go to the examples page](https://rbrundritt.github.io/maplibre-gl-svg/index.html)
+- [Read the docs](https://github.com/rbrundritt/maplibre-gl-svg/blob/main/docs/docs.md)
+
+**Features:**
+
+- Load an SVG into the maps image sprite and use as an icon in a symbol layer, or as an fill pattern.
+- Framework for templatable SVG icons. Great way to create reusable icons that you can programmatically change the styles of.
+- HTML marker support
+
+**Known Limitations**
+
+- When loaded into the maps image sprite SVG's are converted into a data URI, and loaded as a static image into the maps image sprite. This means animations and CSS classes are not supported. All CSS styles should be embedded within the SVG. SVG's used with HTML markers will support CSS classes and animations as usual.
+  
+## License
+
+MIT
+ 
+See [License](https://github.com/rbrundritt/maplibre-gl-svg/blob/main/LICENSE.md) for full license text.

package/thirdParty/maplibre-gl-svg/assets/Smiley_face_changed.svg

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   version="1.0"
+   x="0"
+   y="0"
+   width="194"
+   height="200"
+   id="Face">
+  <path
+     d="M 186.11394,98.304237 C 186.62399,134.66870 162.61525,169.70928 128.55578,182.43531 C 95.991320,195.60352 56.276124,187.11517 31.824005,161.93377 C 6.1490073,136.74335 -1.7726986,95.589284 12.895063,62.717752 C 26.131798,30.871489 58.959432,8.6063558 93.435503,8.0498005 C 130.40005,6.5693681 166.62078,30.464084 179.78044,65.055801 C 183.95955,75.607305 186.15088,86.951651 186.11394,98.304237 z "
+     style="opacity:1;fill:#ffff00;fill-opacity:1;stroke:#000000;stroke-width:2;stroke-opacity:1"
+     id="path1352" />
+  <path
+     d="M 77.006599,70.918053 C 77.527726,79.716943 64.712340,84.270466 59.707418,76.889791 C 54.124523,70.591110 60.327827,59.897153 68.519803,61.268419 C 73.235680,61.807597 77.099882,66.152789 77.006599,70.918053 z "
+     style="opacity:1;fill:#cece00;fill-opacity:1;stroke:#000000;stroke-width:1;stroke-opacity:1"
+     id="eye" />
+  <use
+     transform="translate(57.58983,0.496064)"
+     id="eye2"
+     x="0"
+     y="0"
+     width="744.09448"
+     height="1052.3622"
+     xlink:href="#eye" />
+  <path
+     d="M 77.814522,115.89286 C 83.829118,103.68413 89.843712,91.475395 95.858307,79.266663 C 101.87290,91.475397 107.88750,103.68413 113.90210,115.89286 C 101.87291,115.89286 89.843714,115.89286 77.814522,115.89286 z "
+     style="fill:#0000ff;fill-opacity:1;stroke:#000000;stroke-width:1;stroke-opacity:1"
+     id="nose" />
+  <path
+     d="M 145.14207,136.36044 C 124.78121,151.38904 102.90920,149.14419 79.824122,131.65685 C 70.594385,128.53160 54.906902,141.79498 46.843849,136.36044"
+     style="fill:none;stroke:#000000;stroke-width:1.3228360;stroke-opacity:1"
+     id="mouth" />
+</svg>

package/thirdParty/maplibre-gl-svg/build/build.js

@@ -0,0 +1,210 @@
+const pkg = require("../package.json");
+const fs = require("fs-extra");
+const path = require("path");
+const { rollup } = require("rollup");
+const commonjs = require("rollup-plugin-commonjs");
+const nodeResolve = require("rollup-plugin-node-resolve");
+const { uglify } = require("rollup-plugin-uglify");
+const ts = require("typescript");
+
+// Configure any functions/properties used by the drawing tools and 
+// exported by a dependency that rollup can't automatically detect.
+const namedExports = {
+};
+
+// Parse the command line.
+const args = require("yargs").options({
+    "isNpmBuild": {
+        describe: "Whether the build is for NPM.",
+        type: "boolean"
+    }
+}).help().argv;
+
+// Host for formating typescript diagnostics.
+const formatDiagnosticHost = {
+    getCanonicalFileName: path.normalize,
+    getCurrentDirectory: ts.sys.getCurrentDirectory,
+    getNewLine: () => ts.sys.newLine
+};
+
+// Host for parsing the config file host.
+const parseConfigFileHost = {
+    useCaseSensitiveFileNames: false,
+    fileExists: ts.sys.fileExists,
+    getCurrentDirectory: ts.sys.getCurrentDirectory,
+    readDirectory: ts.sys.readDirectory,
+    readFile: ts.sys.readFile,
+    onUnRecoverableConfigFileDiagnostic: (diag) =>
+        console.error(ts.formatDiagnostic(diag, formatDiagnosticHost))
+};
+
+// Define and immediately execute the main build function.
+let rollupError = false;
+(async function build() {
+    // Cleanup the dist folder where the js packages will be output
+    const distDirPath = "./dist";
+    fs.emptyDirSync(distDirPath);
+
+    // Get the major and minor version for the output folder name
+    //const [majorVersion, minorVersion] = pkg.version.split(".");
+
+    // File name and path for non-minified browser js
+    const outFilePath = `${distDirPath}/maplibre-gl-svg.js`;
+    const outMinFilePath = `${distDirPath}/maplibre-gl-svg.min.js`;
+
+    const inputPath = "./js/index.js";
+
+    // Ensure that all necessary output folders are created.
+    await fs.ensureDir(path.dirname(outFilePath));
+    await fs.ensureDir(path.dirname(outMinFilePath));
+
+
+    // Parse the typescript config file.
+    console.log("Parsing tsconfig.json");
+    const tsConfig = ts.getParsedCommandLineOfConfigFile("./tsconfig.json", {}, parseConfigFileHost);
+    if (tsConfig.errors.length > 0) {
+        for (const error of tsConfig.errors) {
+            console.error(ts.formatDiagnostic(error, formatDiagnosticHost));
+        }
+
+        process.exit(-1);
+    }
+
+    // Empty the directory for storing the compiled typescript.
+    console.log("Clearing the typescript output folder");
+    await fs.emptyDir(tsConfig.options.outDir);
+
+    // Compile the typescript source.
+    console.log("Compiling typescript to javascript");
+    const tsProgram = ts.createProgram(tsConfig.fileNames, tsConfig.options);
+    const tsResult = tsProgram.emit();
+    const tsDiag = ts.getPreEmitDiagnostics(tsProgram).concat(tsResult.diagnostics);
+    if (tsDiag.length > 0) {
+        for (const error of tsDiag) {
+            console.error(ts.formatDiagnostic(error, formatDiagnosticHost));
+        }
+
+        process.exit(-1);
+    }
+
+    // Read license.txt to define the banner for the packages.
+    let banner = "/*\n";
+    banner += (await fs.readFile("./license.md", "utf8")).trim();
+    banner += "\n*/\n";
+
+    let rollupInputOps, rollupOutputOps;
+    if (!args.isNpmBuild) {
+        // Set rollup options for browser builds.
+        rollupInputOps = {
+            external: ["maplibregll"],
+            onwarn: rollupWarn,
+            input: inputPath,
+            plugins: [
+                nodeResolve({
+                    browser: true,
+                    preferBuiltins: false
+                }),
+                commonjs({
+                    namedExports: namedExports
+                })
+            ]
+        };
+
+        rollupOutputOps = {
+            exports: "named",
+            file: outFilePath,
+            format: "iife",
+            name: "maplibregl",
+            extend: true,
+            globals: {
+                "maplibregl": "maplibregl"
+            }
+        };
+    } else {
+        rollupInputOps = {
+            external: ["maplibregl"],
+            onwarn: rollupWarn,
+            input: inputPath,
+            plugins: [
+                nodeResolve(),
+                commonjs({
+                    namedExports: namedExports
+                })
+            ]
+        };
+
+        rollupOutputOps = {
+            file: outFilePath,
+            format: "cjs"
+        };
+    }
+
+    // Rollup non-minified version.
+    console.log("Bundling non-minified javascript package");
+    await bundle(rollupInputOps, rollupOutputOps, banner);
+
+    // Add uglify to the rollup input plugins.
+    // Update the output file path for the minified version.
+    rollupOutputOps.file = outMinFilePath;
+    rollupInputOps.plugins.push(uglify());
+
+    // Rollup minified version.
+    const minifiedLicense = "/* MIT License - Copyright (c) Ricky Brundritt. */\n\n"
+    console.log("Bundling minified javascript package");
+    await bundle(rollupInputOps, rollupOutputOps, minifiedLicense);
+
+    //Remove js folder.
+    await fs.remove("./js");
+
+    // Build is done!
+    console.log(rollupError ? "Build failed" : "Build completed successfully!");
+    process.exit(rollupError ? -1 : 0);
+})()
+
+async function bundle(inputOptions, outputOptions) {
+    const bundle = await rollup(inputOptions);
+    await bundle.write(outputOptions);
+}
+
+function rollupWarn(warning) {
+    // Print the warning to the console.
+    console.warn(warning.toString());
+
+    // If the warning is about missing export provide more info.
+    if (warning.code === "MISSING_EXPORT") {
+        console.warn(
+            `  if '${warning.missing}' is exported by '${warning.exporter}' then try adding\n` +
+            `  "${warning.exporter}": [${warning.missing}] to namedExports in ${__filename}`
+        );
+    }
+}
+
+async function bundle(rollupInputOps, rollupOutputOps, banner) {
+    try {
+        const bundle = await rollup(rollupInputOps);
+        const { output } = await bundle.generate(rollupOutputOps);
+
+        const chunk = output.find((chunk) =>
+            chunk.fileName === path.basename(rollupOutputOps.file)
+        );
+
+        await fs.writeFile(rollupOutputOps.file, banner + "\n" + chunk.code, "utf8");
+    } catch (error) {
+        throw new Error(`Failed to bundle the javascript package:\n${error.message}\n` +
+            JSON.stringify(error, null, 2));
+    }
+}
+
+function rollupWarn(warning) {
+    // If the warning is about missing export provide more info.
+    if (warning.code === "MISSING_EXPORT") {
+        rollupError = true;
+        console.error("ERROR: " + warning.toString() + "\n" +
+            `  if '${warning.missing}' is exported by '${warning.exporter}' then try adding\n` +
+            `  "${warning.exporter}": [${warning.missing}] to namedExports in ${__filename}`
+        );
+    } else {
+        // Print the warning to the console.
+        console.warn("WARNING: " + warning.toString());
+    }
+}