@vcmap/core 5.0.0-rc.3 → 5.0.0-rc.31

package/src/{vcs/vcm/util → util}/geometryHelpers.js

@@ -1,4 +1,4 @@
-import { offset } from 'ol/sphere.js';
+import { offset as offsetSphere } from 'ol/sphere.js';
 import Circle from 'ol/geom/Circle.js';
 import Point from 'ol/geom/Point.js';
 import LineString from 'ol/geom/LineString.js';
@@ -7,6 +7,7 @@ import MultiPoint from 'ol/geom/MultiPoint.js';
 import MultiLineString from 'ol/geom/MultiLineString.js';
 import MultiPolygon from 'ol/geom/MultiPolygon.js';
 import GeometryCollection from 'ol/geom/GeometryCollection.js';
+import { SimpleGeometry } from 'ol/geom.js';
 import Projection from './projection.js';
 
 /**
@@ -16,16 +17,15 @@ import Projection from './projection.js';
 export function getFlatCoordinatesFromSimpleGeometry(geometry) {
   const stride = geometry.getStride();
   const flatCoordinates = geometry.getFlatCoordinates();
-  if (flatCoordinates.length) {
+  if (flatCoordinates.length > 0) {
     const numberOfCoordinates = Math.floor(flatCoordinates.length / stride);
     const coordinates = new Array(numberOfCoordinates);
     for (let i = 0; i < numberOfCoordinates; i++) {
       const flatIndex = i * stride;
-      const coord = new Array(stride);
+      coordinates[i] = new Array(stride);
       for (let j = 0; j < stride; j++) {
-        coord[j] = flatCoordinates[flatIndex + j];
+        coordinates[i][j] = flatCoordinates[flatIndex + j];
       }
-      coordinates[i] = coord;
     }
     return coordinates;
   }
@@ -38,18 +38,25 @@ export function getFlatCoordinatesFromSimpleGeometry(geometry) {
  * @returns {Array.<import("ol/coordinate").Coordinate>}
  */
 export function getFlatCoordinatesFromGeometry(geometry, inputCoordinates) {
-  const coordinates = inputCoordinates || geometry.getCoordinates();
+  if (!inputCoordinates && geometry instanceof SimpleGeometry) {
+    return getFlatCoordinatesFromSimpleGeometry(geometry);
+  }
+  const coordinates = inputCoordinates;
   let flattenCoordinates = null;
   if (geometry instanceof Point) {
     flattenCoordinates = [coordinates];
   } else if (geometry instanceof LineString) {
     flattenCoordinates = coordinates;
   } else if (geometry instanceof Polygon) {
-    flattenCoordinates = coordinates.reduce((current, next) => current.concat(next));
+    flattenCoordinates = coordinates.reduce((current, next) =>
+      current.concat(next),
+    );
   } else if (geometry instanceof MultiPoint) {
     flattenCoordinates = coordinates;
   } else if (geometry instanceof MultiLineString) {
-    flattenCoordinates = coordinates.reduce((current, next) => current.concat(next));
+    flattenCoordinates = coordinates.reduce((current, next) =>
+      current.concat(next),
+    );
   } else if (geometry instanceof MultiPolygon) {
     flattenCoordinates = coordinates
       .reduce((current, next) => current.concat(next))
@@ -57,8 +64,9 @@ export function getFlatCoordinatesFromGeometry(geometry, inputCoordinates) {
   } else if (geometry instanceof Circle) {
     flattenCoordinates = coordinates;
   } else if (geometry instanceof GeometryCollection) {
-    flattenCoordinates = geometry.getGeometries()
-      .map((g, i) => getFlatCoordinatesFromGeometry(g, coordinates[i]))
+    flattenCoordinates = geometry
+      .getGeometries()
+      .map((g, i) => getFlatCoordinatesFromGeometry(g, coordinates?.[i]))
       .reduce((current, next) => current.concat(next));
   }
   return flattenCoordinates;
@@ -70,18 +78,18 @@ export function getFlatCoordinatesFromGeometry(geometry, inputCoordinates) {
  * @returns {import("ol/geom/Circle").default}
  */
 export function circleFromCenterRadius(center, radius) {
-  const offsetWGS84 = offset(Projection.mercatorToWgs84(center), radius, Math.PI / 2);
+  const offsetWGS84 = offsetSphere(
+    Projection.mercatorToWgs84(center),
+    radius,
+    Math.PI / 2,
+  );
   const of = Projection.wgs84ToMercator(offsetWGS84);
   const dx = center[0] - of[0];
   const dy = center[1] - of[1];
   const dx2 = dx * dx;
   const dy2 = dy * dy;
   const radiusProjected = Math.sqrt(dx2 + dy2);
-  return new Circle(
-    center,
-    radiusProjected,
-    'XYZ',
-  );
+  return new Circle(center, radiusProjected, 'XYZ');
 }
 
 /**
@@ -150,7 +158,7 @@ function ringArea(ring) {
   for (let i = 0; i <= positions - 2; i++) {
     const p1 = ring[i];
     const p2 = ring[i + 1];
-    area += ((p1[0] * p2[1]) - (p1[1] * p2[0]));
+    area += p1[0] * p2[1] - p1[1] * p2[0];
   }
 
   area /= 2;

package/src/{vcs/vcm/util → util}/indexedCollection.js

@@ -1,10 +1,9 @@
-import VcsEvent from '../event/vcsEvent.js';
+import VcsEvent from '../vcsEvent.js';
 import Collection from './collection.js';
 
 /**
  * A generic array based collection. Implements the Symbol.iterator (e.g. [...collection])
  * @class
- * @export
  * @template {*} T
  * @extends {Collection<T>}
  * @api
@@ -20,7 +19,9 @@ class IndexedCollection extends Collection {
    * @api
    */
   static from(iterable, uniqueKey) {
-    const collection = /** @type {IndexedCollection<T>} */ (new IndexedCollection(uniqueKey));
+    const collection = /** @type {IndexedCollection<T>} */ (
+      new IndexedCollection(uniqueKey)
+    );
     if (iterable) {
       // eslint-disable-next-line no-restricted-syntax
       for (const i of iterable) {
@@ -56,7 +57,9 @@ class IndexedCollection extends Collection {
    * @type {symbol}
    * @readonly
    */
-  get previousIndexSymbol() { return this._previousIndexSymbol; }
+  get previousIndexSymbol() {
+    return this._previousIndexSymbol;
+  }
 
   /**
    * Returns an item at index.
@@ -110,12 +113,28 @@ class IndexedCollection extends Collection {
     let target = targetIndex;
     target = target >= 0 ? target : 0;
     target = target < this._array.length ? target : this._array.length - 1;
-    this._array.splice(itemIndex, 1);
-    this._array.splice(target, 0, item);
-    this.moved.raiseEvent(item);
+    if (itemIndex !== target) {
+      this._array.splice(itemIndex, 1);
+      this._array.splice(target, 0, item);
+      this.moved.raiseEvent(item);
+    }
     return target;
   }
 
+  /**
+   * Moves an item to a provided index
+   * @param {T} item
+   * @param {number} targetIndex
+   * @returns {number|null} the new index of the item
+   */
+  moveTo(item, targetIndex) {
+    const index = this._array.indexOf(item);
+    if (index > -1) {
+      return this._move(item, index, targetIndex);
+    }
+    return null;
+  }
+
   /**
    * Lowers an item within the array
    * @param {T} item
@@ -166,7 +185,7 @@ class IndexedCollection extends Collection {
     if (!this.uniqueKey) {
       return undefined;
     }
-    return this._array.findIndex(e => e[this.uniqueKey] === value);
+    return this._array.findIndex((e) => e[this.uniqueKey] === value);
   }
 
   /**

package/src/{vcs/vcm/util → util}/isMobile.js

@@ -7,6 +7,12 @@
 export function isMobile() {
   // @ts-ignore
   const agent = navigator.userAgent || navigator.vendor || window.opera;
-  return /(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino|android|ipad|playbook|silk/i.test(agent) ||
-    /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw-(n|u)|c55\/|capi|ccwa|cdm-|cell|chtm|cldc|cmd-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc-s|devi|dica|dmob|do(c|p)o|ds(12|-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(-|_)|g1 u|g560|gene|gf-5|g-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd-(m|p|t)|hei-|hi(pt|ta)|hp( i|ip)|hs-c|ht(c(-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i-(20|go|ma)|i230|iac( |-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|-[a-w])|libw|lynx|m1-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|-([1-8]|c))|phil|pire|pl(ay|uc)|pn-2|po(ck|rt|se)|prox|psio|pt-g|qa-a|qc(07|12|21|32|60|-[2-7]|i-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h-|oo|p-)|sdk\/|se(c(-|0|1)|47|mc|nd|ri)|sgh-|shar|sie(-|m)|sk-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h-|v-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl-|tdg-|tel(i|m)|tim-|t-mo|to(pl|sh)|ts(70|m-|m3|m5)|tx-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas-|your|zeto|zte-/i.test(agent.substr(0, 4));
+  return (
+    /(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino|android|ipad|playbook|silk/i.test(
+      agent,
+    ) ||
+    /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw-(n|u)|c55\/|capi|ccwa|cdm-|cell|chtm|cldc|cmd-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc-s|devi|dica|dmob|do(c|p)o|ds(12|-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(-|_)|g1 u|g560|gene|gf-5|g-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd-(m|p|t)|hei-|hi(pt|ta)|hp( i|ip)|hs-c|ht(c(-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i-(20|go|ma)|i230|iac( |-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|-[a-w])|libw|lynx|m1-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|-([1-8]|c))|phil|pire|pl(ay|uc)|pn-2|po(ck|rt|se)|prox|psio|pt-g|qa-a|qc(07|12|21|32|60|-[2-7]|i-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h-|oo|p-)|sdk\/|se(c(-|0|1)|47|mc|nd|ri)|sgh-|shar|sie(-|m)|sk-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h-|v-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl-|tdg-|tel(i|m)|tim-|t-mo|to(pl|sh)|ts(70|m-|m3|m5)|tx-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas-|your|zeto|zte-/i.test(
+      agent.substr(0, 4),
+    )
+  );
 }

package/src/{vcs/vcm/util → util}/layerCollection.js

@@ -1,13 +1,21 @@
+import { check } from '@vcsuite/check';
 import IndexedCollection from './indexedCollection.js';
 import ExclusiveManager from './exclusiveManager.js';
 import LayerState from '../layer/layerState.js';
-import VcsEvent from '../event/vcsEvent.js';
+import VcsEvent from '../vcsEvent.js';
+import GlobalHider from '../layer/globalHider.js';
+
+/**
+ * The largest integer zindex which can be safely assigned to a layer (equal to Number.MAX_SAFE_INTEGER)
+ * You should use this to ensure layers are always rendered on top.
+ * @type {number}
+ */
+export const maxZIndex = Number.MAX_SAFE_INTEGER;
 
 /**
  * A collection of layers. Manages rendering order and layer exclusivity. Emits state changes for convenience. Passed to
  * {@link Map} for layers available to said map. Layers must have unique names.
  * @class
- * @export
  * @api
  * @extends {IndexedCollection<import("@vcmap/core").Layer>}}
  */
@@ -62,6 +70,22 @@ class LayerCollection extends IndexedCollection {
      * @api
      */
     this.exclusiveManager = new ExclusiveManager();
+
+    /**
+     * The global hider for this collection.
+     * @type {GlobalHider}
+     * @private
+     */
+    this._globalHider = new GlobalHider();
+
+    /**
+     * Locale for this layerCollection, will be synchronized by the vcsApp, if part of an vcsApp.
+     * This Locale will be set on all Member Layers. On setting the Locale this will trigger a reload of all locale
+     * aware layers.
+     * @type {string}
+     * @private
+     */
+    this._locale = 'en';
   }
 
   /**
@@ -71,7 +95,53 @@ class LayerCollection extends IndexedCollection {
    * @type {symbol}
    * @readonly
    */
-  get zIndexSymbol() { return this._zIndexSymbol; }
+  get zIndexSymbol() {
+    return this._zIndexSymbol;
+  }
+
+  /**
+   * The current global hider of these layers
+   * @type {GlobalHider}
+   */
+  get globalHider() {
+    return this._globalHider;
+  }
+
+  /**
+   * The current global hider of these layers
+   * @type {GlobalHider}
+   * @param {GlobalHider} globalHider
+   * @returns {void}
+   */
+  set globalHider(globalHider) {
+    check(globalHider, GlobalHider);
+
+    this._globalHider = globalHider;
+    this._array.forEach((layer) => {
+      layer.setGlobalHider(this._globalHider);
+    });
+  }
+
+  /**
+   * @type {string}
+   */
+  get locale() {
+    return this._locale;
+  }
+
+  /**
+   * @param {string} value
+   */
+  set locale(value) {
+    check(value, String);
+
+    if (this._locale !== value) {
+      this._locale = value;
+      [...this].forEach((layer) => {
+        layer.locale = this._locale;
+      });
+    }
+  }
 
   /**
    * @param {import("@vcmap/core").Layer} layer
@@ -89,15 +159,20 @@ class LayerCollection extends IndexedCollection {
       this._zIndexChanged(layer);
     });
 
-    const exclusiveGroupsListener = layer.exclusiveGroupsChanged.addEventListener(() => {
-      this.exclusiveManager.handleExclusiveGroupsChanged(layer);
-    });
+    const exclusiveGroupsListener =
+      layer.exclusiveGroupsChanged.addEventListener(() => {
+        this.exclusiveManager.handleExclusiveGroupsChanged(layer);
+      });
 
     const listeners = [stateListener, zIndexListener, exclusiveGroupsListener];
     if (/** @type {SplitLayer} */ (layer).splitDirectionChanged) {
-      listeners.push(/** @type {SplitLayer} */ (layer).splitDirectionChanged.addEventListener(() => {
-        this.exclusiveManager.handleSplitDirectionChanged(layer);
-      }));
+      listeners.push(
+        /** @type {SplitLayer} */ (
+          layer
+        ).splitDirectionChanged.addEventListener(() => {
+          this.exclusiveManager.handleSplitDirectionChanged(layer);
+        }),
+      );
     }
     this._layerEventListeners[layer.name] = listeners;
   }
@@ -109,7 +184,9 @@ class LayerCollection extends IndexedCollection {
    * @private
    */
   _findZIndexPosition(zIndex) {
-    const usedIndex = this._array.findIndex(l => l[this._zIndexSymbol] > zIndex);
+    const usedIndex = this._array.findIndex(
+      (l) => l[this._zIndexSymbol] > zIndex,
+    );
     return usedIndex > -1 ? usedIndex : null;
   }
 
@@ -127,14 +204,15 @@ class LayerCollection extends IndexedCollection {
       if (zIndexPosition > 0 && zIndexPosition > currentIndex) {
         zIndexPosition -= 1; // remove self from count
       }
-      zIndexPosition = zIndexPosition != null ? zIndexPosition : this._array.length - 1;
+      zIndexPosition =
+        zIndexPosition != null ? zIndexPosition : this._array.length - 1;
       this._move(layer, currentIndex, zIndexPosition);
       this._ensureLocalZIndex(layer);
     }
   }
 
   /**
-   * Ensures the local z index is consisten with the neighbours of a given layer.
+   * Ensures the local z index is consistent with the neighbours of a given layer.
    * e.g. the layer on elower must have a lower or equal zIndex
    * and the one higher a higher or equal zIndex.
    * @param {import("@vcmap/core").Layer} layer
@@ -159,6 +237,8 @@ class LayerCollection extends IndexedCollection {
 
   /**
    * Adds a layer to the collection. Can optionally be passed an index at which to insert the layer.
+   * The layer locale will be set to the same locale of the layerCollection. This will trigger a forceRedraw
+   * of the layer if the layer locale is different and the layer is locale aware.
    * @param {import("@vcmap/core").Layer} layer
    * @param {number=} index
    * @returns {number|null} returns the layer index or null, if the layers name is not unique
@@ -172,6 +252,8 @@ class LayerCollection extends IndexedCollection {
     const insertedAt = super.add(layer, usedIndex);
     if (insertedAt != null) {
       layer[this._zIndexSymbol] = layer.zIndex;
+      layer.setGlobalHider(this._globalHider);
+      layer.locale = this.locale;
       this._ensureLocalZIndex(layer);
       this._listenToLayerEvents(layer);
       this.exclusiveManager.registerLayer(layer);
@@ -180,24 +262,29 @@ class LayerCollection extends IndexedCollection {
   }
 
   /**
-   * Removes a layer from the collection.
    * @param {import("@vcmap/core").Layer} layer
-   * @api
+   * @returns {number}
+   * @protected
    */
-  remove(layer) {
+  _remove(layer) {
     if (this._layerEventListeners[layer.name]) {
-      this._layerEventListeners[layer.name].forEach((cb) => { cb(); });
+      this._layerEventListeners[layer.name].forEach((cb) => {
+        cb();
+      });
       delete this._layerEventListeners[layer.name];
     }
     delete layer[this._zIndexSymbol];
+    layer.setGlobalHider(null);
     this.exclusiveManager.unregisterLayer(layer);
-    super.remove(layer);
+    return super._remove(layer);
   }
 
   clear() {
     Object.values(this._layerEventListeners)
       .flat()
-      .forEach((r) => { r(); });
+      .forEach((r) => {
+        r();
+      });
     this._array.forEach((l) => {
       delete l[this._zIndexSymbol];
     });
@@ -210,10 +297,13 @@ class LayerCollection extends IndexedCollection {
   destroy() {
     Object.values(this._layerEventListeners)
       .flat()
-      .forEach((r) => { r(); });
+      .forEach((r) => {
+        r();
+      });
 
     this._layerEventListeners = {};
     this.exclusiveManager.destroy();
+    this._globalHider.destroy();
     super.destroy();
   }
 }

package/src/util/locale.js

@@ -0,0 +1,12 @@
+/* eslint-disable import/prefer-default-export */
+/**
+ * returns the default browserLocale, if not possible 'en'
+ * @returns {string}
+ */
+export function detectBrowserLocale() {
+  if (navigator.language) {
+    const lang = navigator.language;
+    return lang.substring(0, 2);
+  }
+  return 'en';
+}