@vcmap/core 5.0.0-rc.10 → 5.0.0-rc.13

package/src/util/layerCollection.js

@@ -1,13 +1,14 @@
+import { check } from '@vcsuite/check';
 import IndexedCollection from './indexedCollection.js';
 import ExclusiveManager from './exclusiveManager.js';
 import LayerState from '../layer/layerState.js';
 import VcsEvent from '../vcsEvent.js';
+import GlobalHider from '../layer/globalHider.js';
 
 /**
  * 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 +63,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';
   }
 
   /**
@@ -73,6 +90,48 @@ class LayerCollection extends IndexedCollection {
    */
   get zIndexSymbol() { return this._zIndexSymbol; }
 
+  /**
+   * The current global hider
+   * @type {GlobalHider}
+   */
+  get globalHider() {
+    return this._globalHider;
+  }
+
+  /**
+   * Set global hider for these maps.
+   * @param {GlobalHider} globalHider
+   */
+  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
    * @private
@@ -134,7 +193,7 @@ class LayerCollection extends IndexedCollection {
   }
 
   /**
-   * 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 +218,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 +233,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,18 +243,19 @@ 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(); });
       delete this._layerEventListeners[layer.name];
     }
     delete layer[this._zIndexSymbol];
+    layer.setGlobalHider(null);
     this.exclusiveManager.unregisterLayer(layer);
-    super.remove(layer);
+    return super._remove(layer);
   }
 
   clear() {
@@ -214,6 +278,7 @@ class LayerCollection extends IndexedCollection {
 
     this._layerEventListeners = {};
     this.exclusiveManager.destroy();
+    this._globalHider.destroy();
     super.destroy();
   }
 }

package/src/util/locale.js

@@ -1,20 +1,4 @@
-import VcsEvent from '../vcsEvent.js';
-
-/**
- * @type {VcsEvent<string>}
- */
-let localeChangedEvent;
-
-/**
- * @returns {VcsEvent<string>}
- */
-export function getLocaleChangedEvent() {
-  if (!localeChangedEvent) {
-    localeChangedEvent = new VcsEvent();
-  }
-  return localeChangedEvent;
-}
-
+/* eslint-disable import/prefer-default-export */
 /**
  * returns the default browserLocale, if not possible 'en'
  * @returns {string}
@@ -26,28 +10,3 @@ export function detectBrowserLocale() {
   }
   return 'en';
 }
-
-/**
- * @type {string}
- */
-let currentLocale;
-
-/**
- * @returns {string}
- */
-export function getCurrentLocale() {
-  if (!currentLocale) {
-    currentLocale = detectBrowserLocale();
-  }
-  return currentLocale;
-}
-
-/**
- * @param {string} value
- */
-export function setCurrentLocale(value) {
-  if (typeof value === 'string') {
-    currentLocale = value;
-    getLocaleChangedEvent().raiseEvent(value);
-  }
-}

package/src/util/mapCollection.js

@@ -42,7 +42,6 @@ async function setCesiumToOLViewpoint(cesiumMap, olMap) {
 
 /**
  * @class
- * @export
  * @extends {Collection<import("@vcmap/core").VcsMap>}}
  */
 // ignored do to static issues, see https://github.com/microsoft/TypeScript/issues/4628
@@ -83,6 +82,13 @@ class MapCollection extends Collection {
      */
     this._target = null;
 
+    /**
+     * if the active map is removed the last viewpoint is cached for the next mapActivation.
+     * @type {import("@vcmap/core").ViewPoint}
+     * @private
+     */
+    this._cachedViewpoint = null;
+
     /**
      * The map pointer event handler. The EventHandler is shared amongst all maps within the collection.
      * @type {EventHandler}
@@ -219,20 +225,25 @@ class MapCollection extends Collection {
   }
 
   /**
-   * Removes the map from the collection. Will also set _splitScreen & target to null and an empty _layerCollection on the map,
-   * if the map is currently part of the collection.
    * @param {import("@vcmap/core").VcsMap} map
+   * @returns {number}
+   * @protected
    */
-  remove(map) {
+  _remove(map) {
+    if (this._activeMap === map) {
+      this._cachedViewpoint = map.getViewPointSync();
+      if (this._target) {
+        const mapClassName = this._activeMap.className.split('.').pop();
+        this._target.classList.remove(mapClassName);
+      }
+      this._activeMap = null;
+    }
     if (this.has(map)) {
       map.setTarget(null);
       map.splitScreen = null;
       map.layerCollection = new LayerCollection();
     }
-    super.remove(map);
-    if (this._activeMap === map) {
-      this._activeMap = null;
-    }
+    return super._remove(map);
   }
 
   /**
@@ -334,12 +345,13 @@ class MapCollection extends Collection {
     }
 
     let viewpoint;
-    if (this._activeMap) {
+    if (this._activeMap || this._cachedViewpoint) {
       if (this._activeMap === map) {
         return map.activate();
       }
 
-      viewpoint = await this._activeMap.getViewPoint();
+      viewpoint = this._activeMap ? await this._activeMap.getViewPoint() : this._cachedViewpoint;
+
       const canShow = await map.canShowViewpoint(viewpoint);
       if (!canShow) {
         const fallbackMap = this._getFallbackMap(map);
@@ -348,10 +360,13 @@ class MapCollection extends Collection {
           return this.setActiveMap(fallbackMap.name);
         }
       }
-      this._activeMap.deactivate();
-      if (this._target) {
-        const mapClassName = this._activeMap.className.split('.').pop();
-        this._target.classList.remove(mapClassName);
+      this._cachedViewpoint = null;
+      if (this._activeMap) {
+        this._activeMap.deactivate();
+        if (this._target) {
+          const mapClassName = this._activeMap.className.split('.').pop();
+          this._target.classList.remove(mapClassName);
+        }
       }
     }
 

package/src/util/overrideCollection.js

@@ -38,7 +38,7 @@ export const isOverrideCollection = Symbol('OverrideCollection');
  * @param {Collection<T>} collection
  * @param {function():string} getDynamicContextId - function to get the current dynamic context id
  * @param {(function(T):Object)=} serializeItem - optional function to serialize an item, defaults to returning item.toJSON or item: i => (i.toJSON || i)
- * @param {(function(Object):(T|Promise<T>))=} deserializeItem - optional desirialization function. defaults to returning the passed object: i => i
+ * @param {(function(Object):(T|Promise<T>))=} deserializeItem - optional deserialization function. defaults to returning the passed object: i => i
  * @param {*=} ctor - optional constructor to validate deserialized items against. if passed, deserializeItem must be an instance of ctor.
  * @param {(function(T, (T|null|undefined), (number|undefined)):number|null)=} determineShadowIndex - return the index where a shadow should be inserted. only has relevance, if the collection is indexed. previous and current index may be null.
  * @template {*} T
@@ -81,12 +81,11 @@ function makeOverrideCollection(
 
     if (overrideCollection.hasKey(itemId)) {
       shadow = overrideCollection.getByKey(itemId);
+
       // @ts-ignore
-      index = overrideCollection._array.indexOf(shadow); // faking remove to not call removed
-      if (index > -1) {
-        // @ts-ignore
-        overrideCollection._array.splice(index, 1);
-      }
+      // eslint-disable-next-line no-underscore-dangle
+      index = overrideCollection._remove(shadow);
+
       if (!overrideCollection.shadowMap.has(itemId)) {
         overrideCollection.shadowMap.set(itemId, []);
       }
@@ -102,11 +101,11 @@ function makeOverrideCollection(
     }
 
     const usedIndex = shadow ? getShadowIndex(shadow, item, index) : null;
+    if (shadow) {
+      overrideCollection.replaced.raiseEvent(item);
+    }
     // @ts-ignore
     if (overrideCollection.add(item, usedIndex) >= 0) {
-      if (shadow) {
-        overrideCollection.replaced.raiseEvent(item);
-      }
       return item;
     }
     return null;

package/src/util/projection.js

@@ -98,7 +98,6 @@ function registerProjection(options) {
  * projection created prior to this functions call.
  * @param {ProjectionOptions} options
  * @api
- * @export
  */
 export function setDefaultProjectionOptions(options) {
   check(options, { epsg: [String, Number], proj4: [String, undefined, null] });
@@ -111,7 +110,6 @@ export function setDefaultProjectionOptions(options) {
 /**
  * Projection Class, if no valid options are given, the Projection will initialize with the Framework default Projection
  * @class
- * @export
  * For example:
  *     <pre><code>
  *         {
@@ -341,7 +339,6 @@ export default Projection;
  * Returns the default Projection.
  * @api stable
  * @returns {Projection}
- * @export
  */
 export function getDefaultProjection() {
   return new Projection(defaultProjectionOption);
@@ -351,13 +348,11 @@ export function getDefaultProjection() {
  * wgs84 Projection EPSG Code: 4326
  * @api stable
  * @type {Projection}
- * @export
  */
 export const wgs84Projection = new Projection({ epsg: 4326 });
 /**
  * mercator Projection EPSG Code: 3857
  * @api stable
  * @type {Projection}
- * @export
  */
 export const mercatorProjection = new Projection({ epsg: 3857 });

package/src/util/viewpoint.js

@@ -10,7 +10,6 @@ import Extent from './extent.js';
  * @param {number} right
  * @param {number} epsilon
  * @returns {boolean}
- * @export
  */
 export function propertyEqualsEpsilon(left, right, epsilon) {
   return Math.abs(left - right) <= epsilon;
@@ -22,7 +21,6 @@ export function propertyEqualsEpsilon(left, right, epsilon) {
  * @param {number} right angle in degree
  * @param {number} epsilon in degree
  * @returns {boolean}
- * @export
  */
 export function angleEqualsEpsilon(left, right, epsilon) {
   const diff = (left - right) - Math.trunc((left - right) / 360) * 360;
@@ -36,7 +34,6 @@ export function angleEqualsEpsilon(left, right, epsilon) {
  * @param {import("ol/coordinate").Coordinate} right
  * @param {number} epsilon
  * @returns {boolean}
- * @export
  */
 export function coordinateEqualsEpsilon(left, right, epsilon) {
   return left !== null && right !== null &&
@@ -60,7 +57,6 @@ export function coordinateEqualsEpsilon(left, right, epsilon) {
 /**
  * A Viewpoint Object
  * @class
- * @export
  * @extends {VcsObject}
  * @api stable
  */

package/src/vcsApp.js

@@ -33,6 +33,7 @@ import ClassRegistry, {
   styleClassRegistry,
   tileProviderClassRegistry,
 } from './classRegistry.js';
+import { detectBrowserLocale } from './util/locale.js';
 
 /**
  * @returns {import("@vcsuite/logger").Logger}
@@ -69,6 +70,20 @@ class VcsApp {
 
     const getDynamicContextId = () => this._dynamicContext.id;
 
+    /**
+     * represents the current Locale.
+     * @type {string}
+     * @private
+     */
+    this._locale = detectBrowserLocale();
+
+    /**
+     * fires if the current Locale changes.
+     * @type {VcsEvent<string>}
+     * @private
+     */
+    this._localeChanged = new VcsEvent();
+
     /**
      * @type {OverrideClassRegistry<VcsMap>}
      * @private
@@ -104,6 +119,8 @@ class VcsApp {
       Layer,
       getLayerIndex,
     );
+    this._layers.locale = this.locale;
+
     /**
      * @type {OverrideCollection<import("@vcmap/core").ObliqueCollection>}
      * @private
@@ -184,6 +201,7 @@ class VcsApp {
      * @private
      */
     this._featureProviderClassRegsitry = new OverrideClassRegistry(featureProviderClassRegistry);
+
     vcsApps.set(this._id, this);
   }
 
@@ -193,6 +211,40 @@ class VcsApp {
    */
   get id() { return this._id; }
 
+  /**
+   * @returns {string}
+   */
+  get locale() {
+    return this._locale;
+  }
+
+  /**
+   * sets the locale of the vcsApp and the linked layerCollection.
+   * This will trigger the localeChanged Event.
+   * @param {string} value new locale with 2 letters
+   */
+  set locale(value) {
+    check(value, String);
+
+    if (value.length !== 2) {
+      getLogger().warning('Provide a valid locale, for example "en", "de" with max. 2 letters');
+      return;
+    }
+    if (this._locale !== value) {
+      this._locale = value;
+      this.layers.locale = value;
+      this._localeChanged.raiseEvent(value);
+    }
+  }
+
+  /**
+   * @type {VcsEvent<string>}
+   * @readonly
+   */
+  get localeChanged() {
+    return this._localeChanged;
+  }
+
   /**
    * @type {OverrideMapCollection}
    * @readonly
@@ -454,6 +506,7 @@ class VcsApp {
     this._featureProviderClassRegsitry.destroy();
     this.destroyed.raiseEvent();
     this.destroyed.destroy();
+    this.localeChanged.destroy();
   }
 }
 

package/src/vcsEvent.js

@@ -1,7 +1,6 @@
 /**
  * @class
  * @template {*} T
- * @export
  * @api
  */
 class VcsEvent {