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

package/src/layer/globalHider.js

@@ -9,11 +9,16 @@ import {
 import VcsEvent from '../vcsEvent.js';
 
 /**
- * @type {GlobalHider}
+ * @typedef {Object} HiddenObject
+ * @property {string} id
  */
-let instance;
 
 /**
+ * GlobalHider globally hides features existing within a layer of a {@link LayerCollection}.
+ * Features can be defined as hidden by {@link VcsAppConfig} or {@link LayerOptions}.
+ * Hiding will be performed, when a {@link Context} is loaded, a {@link Layer} is activated or GlobalHider API is called.
+ * A feature can be hidden multiple times by different actors, e.g. contexts, layers, which is handled by this class.
+ * A feature will be shown again, when a {@link Context} is removed, a {@link Layer} is deactivated or GlobalHider API is called.
  * @class
  */
 class GlobalHider {
@@ -123,25 +128,6 @@ class GlobalHider {
     this._hiddenObjectFeatures = {};
     this.changed.destroy();
   }
-
-  static destroy() {
-    if (instance) {
-      instance.destroy();
-    }
-    instance = undefined;
-  }
-}
-
-/**
- * @returns {GlobalHider}
- * @export
- * @api
- */
-export function getGlobalHider() {
-  if (!instance) {
-    instance = new GlobalHider();
-  }
-  return instance;
 }
 
 export default GlobalHider;

package/src/layer/layer.js

@@ -1,13 +1,12 @@
-import { check } from '@vcsuite/check';
+import { check, checkMaybe } from '@vcsuite/check';
 import { parseBoolean, parseInteger } from '@vcsuite/parsers';
 import VcsObject from '../vcsObject.js';
 import Extent from '../util/extent.js';
-import { getGlobalHider } from './globalHider.js';
 import { vcsLayerName } from './layerSymbols.js';
 import LayerState from './layerState.js';
 import VcsEvent from '../vcsEvent.js';
-import { getCurrentLocale, getLocaleChangedEvent } from '../util/locale.js';
 import { layerClassRegistry } from '../classRegistry.js';
+import GlobalHider from './globalHider.js';
 
 /**
  * @typedef {Object} GenericFeature
@@ -100,7 +99,6 @@ export const vcsMetaVersion = '2.0';
  * To receive implementation options, implement `geImplementationOptions`
  * @abstract
  * @class
- * @export
  * @extends {VcsObject}
  * @api stable
  */
@@ -188,16 +186,10 @@ class Layer extends VcsObject {
 
     /**
      * @type {string|Object}
-     * @private
+     * @protected
      */
     this._url = options.url;
 
-    /**
-     * @type {Function}
-     * @private
-     */
-    this._localeChangedListener = null;
-
     /**
      * @type {number}
      * @private
@@ -214,12 +206,19 @@ class Layer extends VcsObject {
     /**
      * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
      * @type {Array.<string>}
+     * @private
      * @api
      */
-    this.hiddenObjectIds = Array.isArray(options.hiddenObjectIds) ?
+    this._hiddenObjectIds = Array.isArray(options.hiddenObjectIds) ?
       options.hiddenObjectIds :
       defaultOptions.hiddenObjectIds;
 
+    /**
+     * @type {import("@vcmap/core").GlobalHider|null}
+     * @private
+     */
+    this._globalHider = null;
+
     /**
      * @type {Array<string|symbol>}
      * @private
@@ -235,9 +234,6 @@ class Layer extends VcsObject {
      */
     this.exclusiveGroupsChanged = new VcsEvent();
 
-    /** @type {import("@vcmap/core").GlobalHider} */
-    this.globalHider = getGlobalHider();
-
     /**
      * @type {CopyrightOptions|undefined}
      */
@@ -268,6 +264,12 @@ class Layer extends VcsObject {
      * @api
      */
     this.featureProvider = undefined;
+
+    /**
+     * @type {string}
+     * @private
+     */
+    this._locale = 'en';
   }
 
   /**
@@ -332,9 +334,8 @@ class Layer extends VcsObject {
       if (typeof this._url === 'string') {
         return this._url;
       }
-      const locale = getCurrentLocale();
-      if (this._url[locale]) {
-        return this._url[locale];
+      if (this._url[this._locale]) {
+        return this._url[this._locale];
       }
       return Object.values(this._url)[0];
     }
@@ -353,6 +354,42 @@ class Layer extends VcsObject {
     }
   }
 
+  /**
+   * @type {Array<string>}
+   */
+  get hiddenObjectIds() { return this._hiddenObjectIds; }
+
+  /**
+   * @param {Array<string>} hiddenObjectIds
+   */
+  set hiddenObjectIds(hiddenObjectIds) {
+    check(hiddenObjectIds, [String]);
+
+    if (this._globalHider && this.active) {
+      this._globalHider.hideObjects(hiddenObjectIds);
+    }
+    this._hiddenObjectIds = hiddenObjectIds;
+  }
+
+
+  /**
+   * @type {import("@vcmap/core").GlobalHider|null}
+   * @readonly
+   */
+  get globalHider() { return this._globalHider; }
+
+  /**
+   * @param {import("@vcmap/core").GlobalHider} globalHider
+   */
+  setGlobalHider(globalHider) {
+    checkMaybe(globalHider, GlobalHider);
+
+    if (globalHider && this.active) {
+      globalHider.hideObjects(this.hiddenObjectIds);
+    }
+    this._globalHider = globalHider;
+  }
+
   /**
    * Indicates, that this layer is part of an exclusiveGroup
    * @api
@@ -406,6 +443,29 @@ class Layer extends VcsObject {
     }
   }
 
+  /**
+   * returns the currently set locale. Can be used to provide locale specific URLs.
+   * @type {string}
+   */
+  get locale() {
+    return this._locale;
+  }
+
+  /**
+   * sets the locale and reloads the layer the if the URL is a locale aware Object.
+   * @param {string} value
+   */
+  set locale(value) {
+    check(value, String);
+
+    if (this._locale !== value) {
+      this._locale = value;
+      if (this._url && typeof this._url === 'object' && this._url[this._locale]) {
+        this.reload();
+      }
+    }
+  }
+
   /**
    * creates an array of layer implementations for the given map.
    * @param {import("@vcmap/core").VcsMap} map Map
@@ -501,25 +561,11 @@ class Layer extends VcsObject {
     return null;
   }
 
-  /**
-   * recreates the implementations on locale change, if the url of this layer is an Object
-   * @param {string} locale
-   * @private
-   */
-  _handleLocaleChange(locale) {
-    if (this._url && typeof this._url === 'object' && this._url[locale]) {
-      this.reload();
-    }
-  }
-
   /**
    * initializes the layer, can be used to defer loading
    * @returns {Promise<void>}
    */
   initialize() {
-    if (!this.initialized) {
-      this._localeChangedListener = getLocaleChangedEvent().addEventListener(this._handleLocaleChange.bind(this));
-    }
     this._initialized = true;
     return Promise.resolve();
   }
@@ -617,7 +663,9 @@ class Layer extends VcsObject {
     if (this._state !== LayerState.LOADING) {
       return;
     }
-    this.globalHider.hideObjects(this.hiddenObjectIds);
+    if (this._globalHider) {
+      this._globalHider.hideObjects(this.hiddenObjectIds);
+    }
     this._state = LayerState.ACTIVE;
     try {
       this.stateChanged.raiseEvent(LayerState.ACTIVE);
@@ -667,7 +715,9 @@ class Layer extends VcsObject {
           impl.deactivate();
         }
       });
-      this.globalHider.showObjects(this.hiddenObjectIds);
+      if (this._globalHider) {
+        this._globalHider.showObjects(this.hiddenObjectIds);
+      }
       this._state = LayerState.INACTIVE;
       try {
         this.stateChanged.raiseEvent(LayerState.INACTIVE);
@@ -736,10 +786,6 @@ class Layer extends VcsObject {
         impl.destroy();
       });
 
-    if (this._localeChangedListener) {
-      this._localeChangedListener();
-      this._localeChangedListener = null;
-    }
     this._initialized = false;
     this._implementations.clear();
     this.stateChanged.destroy();

package/src/layer/layerImplementation.js

@@ -4,7 +4,6 @@ import LayerState from './layerState.js';
 /**
  * represents an implementation for a Layer for a specific Map
  * @class
- * @export
  * @extends {VcsObject}
  * @abstract
  * @api

package/src/layer/layerState.js

@@ -2,7 +2,6 @@
  * Enumeration of possible layer states.
  * State machine: inactive <-> loading -> active -> inactive
  * @enum {number}
- * @export
  * @api
  * @property {number} INACTIVE
  * @property {number} ACTIVE

package/src/layer/oblique/vectorObliqueImpl.js

@@ -5,7 +5,6 @@ import Feature from 'ol/Feature.js';
 
 import { mercatorProjection } from '../../util/projection.js';
 import { mercatorGeometryToImageGeometry, imageGeometryToMercatorGeometry, getPolygonizedGeometry, setNewGeometry } from './obliqueHelpers.js';
-import { getGlobalHider } from '../globalHider.js';
 import {
   actuallyIsCircle,
   alreadyTransformedToImage,
@@ -19,7 +18,6 @@ import { synchronizeFeatureVisibilityWithSource } from '../vectorHelpers.js';
 /**
  * represents a specific vector layer for oblique.
  * @class
- * @export
  * @extends {LayerObliqueImpl}
  * @implements {FeatureLayerImplementation}
  */
@@ -75,7 +73,7 @@ class VectorObliqueImpl extends LayerObliqueImpl {
     /**
      * @type {import("@vcmap/core").GlobalHider}
      */
-    this.globalHider = getGlobalHider();
+    this.globalHider = options.globalHider;
     /**
      * @type {import("ol/source").Vector<import("ol/geom/Geometry").default>}
      */

package/src/layer/openStreetMapLayer.js

@@ -20,7 +20,6 @@ import { layerClassRegistry } from '../classRegistry.js';
 /**
  * OpenStreetMapLayer Layer
  * @class
- * @export
  * @extends {Layer}
  * @api stable
  * @implements {SplitLayer}

package/src/layer/openlayers/layerOpenlayersImpl.js

@@ -4,7 +4,6 @@ import LayerImplementation from '../layerImplementation.js';
 /**
  * Layer implementation for {@link CesiumMap}.
  * @class
- * @export
  * @extends {LayerImplementation<import("@vcmap/core").OpenlayersMap>}}
  */
 class LayerOpenlayersImpl extends LayerImplementation {

package/src/layer/openlayers/openStreetMapOpenlayersImpl.js

@@ -5,7 +5,6 @@ import RasterLayerOpenlayersImpl from './rasterLayerOpenlayersImpl.js';
 /**
  * represents a specific OpenStreetMapLayer layer for openlayers.
  * @class
- * @export
  * @extends {RasterLayerOpenlayersImpl}
  */
 class OpenStreetMapOpenlayersImpl extends RasterLayerOpenlayersImpl {

package/src/layer/openlayers/singleImageOpenlayersImpl.js

@@ -7,7 +7,6 @@ import { isSameOrigin } from '../../util/urlHelpers.js';
 /**
  * represents a specific OpenLayers SingleImageLayer Layer class.
  * @class
- * @export
  * @extends {RasterLayerOpenlayersImpl}
  */
 class SingleImageOpenlayersImpl extends RasterLayerOpenlayersImpl {

package/src/layer/openlayers/tileDebugOpenlayersImpl.js

@@ -5,7 +5,6 @@ import LayerOpenlayersImpl from './layerOpenlayersImpl.js';
 /**
  * layer Implementation to render tile boundaries.
  * @class
- * @export
  * @extends {LayerOpenlayersImpl}
  * @implements {VectorTileImplementation}
  */

package/src/layer/openlayers/tmsOpenlayersImpl.js

@@ -8,7 +8,6 @@ import { isSameOrigin } from '../../util/urlHelpers.js';
 /**
  * TmsLayer implementation for {@link Openlayers}.
  * @class
- * @export
  * @extends {RasterLayerOpenlayersImpl}
  */
 class TmsOpenlayersImpl extends RasterLayerOpenlayersImpl {

package/src/layer/openlayers/vectorOpenlayersImpl.js

@@ -1,12 +1,10 @@
 import OLVectorLayer from 'ol/layer/Vector.js';
 import LayerOpenlayersImpl from './layerOpenlayersImpl.js';
 import { synchronizeFeatureVisibilityWithSource } from '../vectorHelpers.js';
-import { getGlobalHider } from '../globalHider.js';
 
 /**
  * represents a specific vectorlayer for openlayers.
  * @class
- * @export
  * @implements {FeatureLayerImplementation}
  * @extends {LayerOpenlayersImpl}
  */
@@ -36,7 +34,8 @@ class VectorOpenlayersImpl extends LayerOpenlayersImpl {
     this._featureVisibilityListeners = [];
     /** @type {import("ol/layer/Vector").default<import("ol/source").Vector<import("ol/geom/Geometry").default>>|null} */
     this.olLayer = null;
-    this.globalHider = getGlobalHider();
+    /** @type {import("@vcmap/core").GlobalHider} */
+    this.globalHider = options.globalHider;
   }
 
   /**

package/src/layer/openlayers/vectorTileOpenlayersImpl.js

@@ -7,7 +7,6 @@ import { mercatorProjection } from '../../util/projection.js';
 /**
  * represents a specific vectorTileLayer for openlayers.
  * @class
- * @export
  * @implements {VectorTileImplementation}
  * @extends {LayerOpenlayersImpl}
  */

package/src/layer/openlayers/wmsOpenlayersImpl.js

@@ -5,7 +5,6 @@ import { getWMSSource } from '../wmsHelpers.js';
 /**
  * represents a specific Cesium WmsOpenlayersImpl Layer class.
  * @class
- * @export
  * @extends {RasterLayerOpenlayersImpl}
  */
 class WmsOpenlayersImpl extends RasterLayerOpenlayersImpl {

package/src/layer/openlayers/wmtsOpenlayersImpl.js

@@ -10,7 +10,6 @@ import { isSameOrigin } from '../../util/urlHelpers.js';
 /**
  * WmtsLayer implementation for {@link Openlayers}.
  * @class
- * @export
  * @extends {RasterLayerOpenlayersImpl}
  */
 class WmtsOpenlayersImpl extends RasterLayerOpenlayersImpl {

package/src/layer/pointCloudLayer.js

@@ -32,7 +32,6 @@ export const defaultPointCloudStyle = new DeclarativeStyleItem({});
  * </ul>
  *
  * @class
- * @export
  * @extends {CesiumTilesetLayer}
  * @api stable
  */

package/src/layer/rasterLayer.js

@@ -41,7 +41,6 @@ import { layerClassRegistry } from '../classRegistry.js';
  * @api
  * @property {string} GEOGRAPHIC
  * @property {string} MERCATOR
- * @export
  */
 export const TilingScheme = {
   GEOGRAPHIC: 'geographic',
@@ -112,7 +111,6 @@ export function calculateMinLevel(extent, tilingScheme, maxLevel, minLevel = 0)
  * This abstract class allows for automatic loading scheme determination
  * for raster layers
  * @class
- * @export
  * @extends {Layer}
  * @implements {SplitLayer}
  * @abstract

package/src/layer/singleImageLayer.js

@@ -22,7 +22,6 @@ import { wgs84Projection } from '../util/projection.js';
 /**
  * Image layer for Cesium and OpenlayersMap
  * @class
- * @export
  * @extends {RasterLayer}
  * @api stable
  */

package/src/layer/terrainLayer.js

@@ -21,7 +21,6 @@ import { layerClassRegistry } from '../classRegistry.js';
 /**
  * represents a terrain layer.
  * @class
- * @export
  * @extends {Layer}
  * @api stable
  */

package/src/layer/tileProvider/mvtTileProvider.js

@@ -18,7 +18,6 @@ import { tileProviderClassRegistry } from '../../classRegistry.js';
  *
  * @class
  * @extends {TileProvider}
- * @export
  * @api
  */
 class MVTTileProvider extends TileProvider {
@@ -63,6 +62,26 @@ class MVTTileProvider extends TileProvider {
     this._MVTFormat = new MVT({ featureClass: Feature });
   }
 
+  /**
+   * @type {string}
+   */
+  get locale() {
+    return super.locale;
+  }
+
+  /**
+   * sets the locale and clears the Cache if the URL is a locale aware Object.
+   * @param {string} value
+   */
+  set locale(value) {
+    if (this.locale !== value) {
+      super.locale = value;
+      if (this.url.includes('{locale}')) {
+        this.clearCache();
+      }
+    }
+  }
+
   /**
    * @inheritDoc
    * @param {number} x
@@ -72,7 +91,7 @@ class MVTTileProvider extends TileProvider {
    */
   async loader(x, y, z) {
     const rectangle = this.tilingScheme.tileXYToRectangle(x, y, z);
-    const url = getURL(this.url, x, y, z, rectangle);
+    const url = getURL(this.url, x, y, z, rectangle, this.locale);
     const extent = rectangleToExtent(rectangle);
     const center = getCenter(extent);
     const data = await requestArrayBuffer(url);

package/src/layer/tileProvider/staticGeojsonTileProvider.js

@@ -14,7 +14,6 @@ import { tileProviderClassRegistry } from '../../classRegistry.js';
  *
  * @class
  * @extends {TileProvider}
- * @export
  * @api
  */
 class StaticGeoJSONTileProvider extends TileProvider {

package/src/layer/tileProvider/tileProvider.js

@@ -1,5 +1,6 @@
 import { v4 as uuidv4 } from 'uuid';
 import RBush from 'rbush';
+import { check } from '@vcsuite/check';
 import { Rectangle, Math as CesiumMath, WebMercatorTilingScheme, Cartographic } from '@vcmap/cesium';
 import LRUCache from 'ol/structs/LRUCache.js';
 import { buffer, createOrUpdateFromCoordinate } from 'ol/extent.js';
@@ -75,7 +76,6 @@ export function rectangleToExtent(rectangle) {
  *
  * @class
  * @extends {VcsObject}
- * @export
  * @api
  */
 class TileProvider extends VcsObject {
@@ -177,6 +177,12 @@ class TileProvider extends VcsObject {
      * @api
      */
     this.tileLoadedEvent = new VcsEvent();
+
+    /**
+     * @type {string}
+     * @private
+     */
+    this._locale = 'en';
   }
 
   /**
@@ -189,6 +195,26 @@ class TileProvider extends VcsObject {
     return this._tileCacheSize;
   }
 
+
+  /**
+   * @type {string}
+   */
+  get locale() {
+    return this._locale;
+  }
+
+  /**
+   * sets the locale and reloads the layer the if the URL is a locale aware Object.
+   * @param {string} value
+   */
+  set locale(value) {
+    check(value, String);
+    if (this._locale !== value) {
+      this._locale = value;
+    }
+  }
+
+
   /**
    * @param {number} value
    * @returns {Promise<*>}

package/src/layer/tileProvider/urlTemplateTileProvider.js

@@ -1,7 +1,6 @@
 import { Math as CesiumMath, Rectangle } from '@vcmap/cesium';
 import { parseGeoJSON } from '../geojsonHelpers.js';
 import TileProvider from './tileProvider.js';
-import { getCurrentLocale } from '../../util/locale.js';
 import { requestJson } from '../../util/fetch.js';
 import { tileProviderClassRegistry } from '../../classRegistry.js';
 
@@ -14,16 +13,17 @@ import { tileProviderClassRegistry } from '../../classRegistry.js';
 /**
  * replaces {x}, {y}, {z} with the x, y, z tiling coordinates
  * replaces {minx}, {miny}, {maxx}, {maxy} with extent of the tile if tilingExtent is provided
- * replaces {locale} with the current locale
+ * replaces {locale} with the given locale
  *
  * @param {string} url
  * @param {number} x
  * @param {number} y
  * @param {number} z
  * @param {import("@vcmap/cesium").Rectangle=} tilingExtent
+ * @param {string=} locale
  * @returns {string}
  */
-export function getURL(url, x, y, z, tilingExtent) {
+export function getURL(url, x, y, z, tilingExtent, locale = 'en') {
   let replacedURL = url;
   if (tilingExtent) {
     const southwest = Rectangle.southwest(tilingExtent);
@@ -43,7 +43,7 @@ export function getURL(url, x, y, z, tilingExtent) {
     .replace(/\{x\}/, String(x))
     .replace(/\{y\}/, String(y))
     .replace(/\{z\}/, String(z))
-    .replace(/\{locale\}/, getCurrentLocale());
+    .replace(/\{locale\}/, locale);
   return replacedURL;
 }
 
@@ -55,7 +55,6 @@ export function getURL(url, x, y, z, tilingExtent) {
  *
  * @class
  * @extends {TileProvider}
- * @export
  * @api
  */
 class URLTemplateTileProvider extends TileProvider {
@@ -88,6 +87,27 @@ class URLTemplateTileProvider extends TileProvider {
     this.url = options.url || defaultOptions.url;
   }
 
+
+  /**
+   * @type {string}
+   */
+  get locale() {
+    return super.locale;
+  }
+
+  /**
+   * sets the locale and clears the Cache if the URL is a locale aware Object.
+   * @param {string} value
+   */
+  set locale(value) {
+    if (this.locale !== value) {
+      super.locale = value;
+      if (this.url.includes('{locale}')) {
+        this.clearCache();
+      }
+    }
+  }
+
   /**
    * @inheritDoc
    * @param {number} x
@@ -97,7 +117,7 @@ class URLTemplateTileProvider extends TileProvider {
    */
   async loader(x, y, z) {
     const rectangle = this.tilingScheme.tileXYToRectangle(x, y, z);
-    const url = getURL(this.url, x, y, z, rectangle);
+    const url = getURL(this.url, x, y, z, rectangle, this.locale);
     const data = await requestJson(url);
     const { features } = parseGeoJSON(data, { dynamicStyle: true });
     return features;

package/src/layer/tmsLayer.js

@@ -21,7 +21,6 @@ import { layerClassRegistry } from '../classRegistry.js';
 /**
  * TmsLayer Layer
  * @class
- * @export
  * @extends {RasterLayer}
  * @api stable
  */

package/src/layer/vectorLayer.js

@@ -84,7 +84,6 @@ import { layerClassRegistry } from '../classRegistry.js';
 /**
  * VectorLayer Layer for OpenlayersMap, Cesium and ObliqueMap
  * @class
- * @export
  * @extends {FeatureLayer}
  * @api stable
  */

package/src/layer/vectorProperties.js

@@ -164,7 +164,6 @@ export function getCartesian3Options(cartesian3) {
 /**
  * Properties Collection for VectorLayer Features
  * @class
- * @export
  * @api stable
  */
 class VectorProperties {