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

package/src/{vcs/vcm/layer → layer}/layer.js

@@ -1,29 +1,17 @@
-import { check } from '@vcsuite/check';
+import { check, checkMaybe } from '@vcsuite/check';
 import { parseBoolean, parseInteger } from '@vcsuite/parsers';
-import VcsObject from '../object.js';
+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 '../event/vcsEvent.js';
-import { getCurrentLocale, getLocaleChangedEvent } from '../util/locale.js';
-import { VcsClassRegistry } from '../classRegistry.js';
-
-/**
- * @typedef {Object} GenericFeature
- * @property {number} longitude
- * @property {number} latitude
- * @property {number} height
- * @property {string} layerName
- * @property {string} layerClass
- * @property {any} attributes
- * @property {boolean} relativeToGround
- */
+import VcsEvent from '../vcsEvent.js';
+import { layerClassRegistry } from '../classRegistry.js';
+import GlobalHider from './globalHider.js';
 
 /**
  * @typedef {import("@vcmap/core").Layer} SplitLayer
- * @property {import("@vcmap/cesium").ImagerySplitDirection} splitDirection
- * @property {VcsEvent<import("@vcmap/cesium").ImagerySplitDirection>} splitDirectionChanged
+ * @property {import("@vcmap-cesium/engine").SplitDirection} splitDirection
+ * @property {VcsEvent<import("@vcmap-cesium/engine").SplitDirection>} splitDirectionChanged
  */
 
 /**
@@ -38,11 +26,12 @@ import { VcsClassRegistry } from '../classRegistry.js';
 /**
  * @typedef {VectorPropertiesOptions} VcsMeta
  * @property {string|undefined} version - the version of the vcsMeta schema
- * @property {VectorStyleItemOptions|DeclarativeStyleItemOptions|Reference|undefined} style
+ * @property {VectorStyleItemOptions|DeclarativeStyleItemOptions|undefined} style
  * @property {Array<string>|undefined} embeddedIcons
  * @property {number|undefined} screenSpaceError
  * @property {*|undefined} flightOptions
  * @property {string|undefined} baseUrl
+ * @property {Object|undefined} [layerProperties] - the layers properties bag
  * @api
  */
 
@@ -69,6 +58,12 @@ import { VcsClassRegistry } from '../classRegistry.js';
  * @api
  */
 
+/**
+ * @typedef {LayerImplementationOptions} SplitLayerImplementationOptions
+ * @property {import("@vcmap-cesium/engine").SplitDirection} splitDirection
+ * @api
+ */
+
 /**
  * Layer implementations for the {@link CesiumMap} map
  * @namespace cesium
@@ -92,7 +87,7 @@ import { VcsClassRegistry } from '../classRegistry.js';
  * @type {string}
  * @const
  */
-export const vcsMetaVersion = '2.0';
+export const vcsMetaVersion = '2.1';
 
 /**
  * Abstract base class for Layers.
@@ -100,20 +95,23 @@ export const vcsMetaVersion = '2.0';
  * To receive implementation options, implement `geImplementationOptions`
  * @abstract
  * @class
- * @export
  * @extends {VcsObject}
  * @api stable
  */
 class Layer extends VcsObject {
   /** @type {string} */
-  static get className() { return 'vcs.vcm.layer.Layer'; }
+  static get className() {
+    return 'Layer';
+  }
 
   /**
    * Symbol to declare a layers name on its visualizations, e.g. ol.layer.Layer, Cesium.Cesium3DTileset
    * @type {symbol}
    * @api
    */
-  static get vcsLayerNameSymbol() { return vcsLayerName; }
+  static get vcsLayerNameSymbol() {
+    return vcsLayerName;
+  }
 
   /** @returns {LayerOptions} */
   static getDefaultOptions() {
@@ -149,12 +147,18 @@ class Layer extends VcsObject {
      * @type {boolean}
      * @api
      */
-    this.activeOnStartup = parseBoolean(options.activeOnStartup, defaultOptions.activeOnStartup);
+    this.activeOnStartup = parseBoolean(
+      options.activeOnStartup,
+      defaultOptions.activeOnStartup,
+    );
     /**
      * @type {boolean}
      * @private
      */
-    this._allowPicking = parseBoolean(options.allowPicking, defaultOptions.allowPicking);
+    this._allowPicking = parseBoolean(
+      options.allowPicking,
+      defaultOptions.allowPicking,
+    );
     /**
      * @type {LayerState}
      * @private
@@ -188,16 +192,10 @@ class Layer extends VcsObject {
 
     /**
      * @type {string|Object}
-     * @private
+     * @protected
      */
     this._url = options.url;
 
-    /**
-     * @type {Function}
-     * @private
-     */
-    this._localeChangedListener = null;
-
     /**
      * @type {number}
      * @private
@@ -214,19 +212,26 @@ 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) ?
-      options.hiddenObjectIds :
-      defaultOptions.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
      */
-    this._exclusiveGroups = Array.isArray(options.exclusiveGroups) ?
-      options.exclusiveGroups.slice() :
-      defaultOptions.exclusiveGroups;
+    this._exclusiveGroups = Array.isArray(options.exclusiveGroups)
+      ? options.exclusiveGroups.slice()
+      : defaultOptions.exclusiveGroups;
 
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
@@ -235,9 +240,6 @@ class Layer extends VcsObject {
      */
     this.exclusiveGroupsChanged = new VcsEvent();
 
-    /** @type {import("@vcmap/core").GlobalHider} */
-    this.globalHider = getGlobalHider();
-
     /**
      * @type {CopyrightOptions|undefined}
      */
@@ -268,6 +270,12 @@ class Layer extends VcsObject {
      * @api
      */
     this.featureProvider = undefined;
+
+    /**
+     * @type {string}
+     * @private
+     */
+    this._locale = 'en';
   }
 
   /**
@@ -332,9 +340,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 +360,45 @@ 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
@@ -381,7 +427,7 @@ class Layer extends VcsObject {
 
     if (
       groups.length !== this._exclusiveGroups.length ||
-      !groups.every(g => this._exclusiveGroups.includes(g))
+      !groups.every((g) => this._exclusiveGroups.includes(g))
     ) {
       this._exclusiveGroups = groups.slice();
       this.exclusiveGroupsChanged.raiseEvent(groups);
@@ -392,7 +438,9 @@ class Layer extends VcsObject {
    * @type {number}
    * @api
    */
-  get zIndex() { return this._zIndex; }
+  get zIndex() {
+    return this._zIndex;
+  }
 
   /**
    * @param {number} index
@@ -406,6 +454,33 @@ 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 +576,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();
   }
@@ -531,7 +592,9 @@ class Layer extends VcsObject {
    * @returns {Promise<void>}
    */
   async mapActivated(map) {
-    this.getLogger().debug(`Layer: ${this.name} mapActivated is called from Map: ${map.name}`);
+    this.getLogger().debug(
+      `Layer: ${this.name} mapActivated is called from Map: ${map.name}`,
+    );
     this._activeMaps.add(map);
     if (this.active || (this.loading && this.initialized)) {
       await this._activateImplsForMap(map);
@@ -544,13 +607,14 @@ class Layer extends VcsObject {
    * @param {import("@vcmap/core").VcsMap} map
    */
   mapDeactivated(map) {
-    this.getLogger().debug(`Layer: ${this.name} mapDeactivated is called from Map: ${map.name}`);
+    this.getLogger().debug(
+      `Layer: ${this.name} mapDeactivated is called from Map: ${map.name}`,
+    );
     this._activeMaps.delete(map);
     if (this.active || this.loading) {
-      this.getImplementationsForMap(map)
-        .forEach((impl) => {
-          impl.deactivate();
-        });
+      this.getImplementationsForMap(map).forEach((impl) => {
+        impl.deactivate();
+      });
     }
   }
 
@@ -561,10 +625,9 @@ class Layer extends VcsObject {
    */
   removedFromMap(map) {
     this._activeMaps.delete(map);
-    this.getImplementationsForMap(map)
-      .forEach((impl) => {
-        impl.destroy();
-      });
+    this.getImplementationsForMap(map).forEach((impl) => {
+      impl.destroy();
+    });
     this._implementations.delete(map);
   }
 
@@ -575,9 +638,11 @@ class Layer extends VcsObject {
    * @api stable
    */
   isSupported(map) {
-    return map &&
+    return (
+      map &&
       this._supportedMaps.includes(map.className) &&
-      (this.mapNames.length === 0 || this.mapNames.indexOf(map.name) >= 0);
+      (this.mapNames.length === 0 || this.mapNames.indexOf(map.name) >= 0)
+    );
   }
 
   /**
@@ -588,12 +653,16 @@ class Layer extends VcsObject {
   async _activateImplsForMap(map) {
     const impls = this.getImplementationsForMap(map);
     try {
-      await Promise.all(impls.map(i => i.activate()));
+      await Promise.all(impls.map((i) => i.activate()));
     } catch (err) {
-      this.getLogger().error(`Layer ${this.name} could not activate impl for map ${map.name}`);
+      this.getLogger().error(
+        `Layer ${this.name} could not activate impl for map ${map.name}`,
+      );
       this.getLogger().error(err);
       this._implementations.set(map, []);
-      impls.forEach((i) => { i.destroy(); });
+      impls.forEach((i) => {
+        i.destroy();
+      });
     }
   }
 
@@ -606,23 +675,31 @@ class Layer extends VcsObject {
     try {
       this.stateChanged.raiseEvent(LayerState.LOADING);
     } catch (e) {
-      this.getLogger().debug(`Error on raising LayerState.LOADING event for layer ${this.name} : ${e.message}`);
+      this.getLogger().debug(
+        `Error on raising LayerState.LOADING event for layer ${this.name} : ${e.message}`,
+      );
     }
     await this.initialize();
     if (this._state !== LayerState.LOADING) {
       return;
     }
 
-    await Promise.all([...this._activeMaps].map(m => this._activateImplsForMap(m)));
+    await Promise.all(
+      [...this._activeMaps].map((m) => this._activateImplsForMap(m)),
+    );
     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);
     } catch (e) {
-      this.getLogger().debug(`Error on raising LayerState.ACTIVE event for layer ${this.name} : ${e.message}`);
+      this.getLogger().debug(
+        `Error on raising LayerState.ACTIVE event for layer ${this.name} : ${e.message}`,
+      );
     }
     this._loadingPromise = null;
   }
@@ -641,11 +718,10 @@ class Layer extends VcsObject {
     }
 
     if (this._state === LayerState.INACTIVE) {
-      this._loadingPromise = this._activate()
-        .catch((err) => {
-          this._state = LayerState.INACTIVE;
-          return Promise.reject(err);
-        });
+      this._loadingPromise = this._activate().catch((err) => {
+        this._state = LayerState.INACTIVE;
+        return Promise.reject(err);
+      });
       return this._loadingPromise;
     }
 
@@ -667,12 +743,16 @@ 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);
       } catch (e) {
-        this.getLogger().debug(`Error on raising LayerState.INACTIVE event for layer ${this.name} : ${e.message}`);
+        this.getLogger().debug(
+          `Error on raising LayerState.INACTIVE event for layer ${this.name} : ${e.message}`,
+        );
       }
     }
   }
@@ -731,15 +811,10 @@ class Layer extends VcsObject {
     }
 
     this._activeMaps.clear();
-    this.getImplementations()
-      .forEach((impl) => {
-        impl.destroy();
-      });
+    this.getImplementations().forEach((impl) => {
+      impl.destroy();
+    });
 
-    if (this._localeChangedListener) {
-      this._localeChangedListener();
-      this._localeChangedListener = null;
-    }
     this._initialized = false;
     this._implementations.clear();
     this.stateChanged.destroy();
@@ -748,5 +823,5 @@ class Layer extends VcsObject {
   }
 }
 
-VcsClassRegistry.registerClass(Layer.className, Layer);
+layerClassRegistry.registerClass(Layer.className, Layer);
 export default Layer;

package/src/{vcs/vcm/layer → layer}/layerImplementation.js

@@ -1,17 +1,18 @@
-import VcsObject from '../object.js';
+import VcsObject from '../vcsObject.js';
 import LayerState from './layerState.js';
 
 /**
  * represents an implementation for a Layer for a specific Map
  * @class
- * @export
  * @extends {VcsObject}
  * @abstract
  * @api
  * @template {import("@vcmap/core").VcsMap} T
  */
 class LayerImplementation extends VcsObject {
-  static get className() { return 'vcs.vcm.layer.LayerImplementation'; }
+  static get className() {
+    return 'LayerImplementation';
+  }
 
   /**
    * @param {T} map
@@ -43,19 +44,25 @@ class LayerImplementation extends VcsObject {
    * @type {boolean}
    * @readonly
    */
-  get initialized() { return this._initialized; }
+  get initialized() {
+    return this._initialized;
+  }
 
   /**
    * @type {boolean}
    * @api
    */
-  get active() { return this._state === LayerState.ACTIVE; }
+  get active() {
+    return this._state === LayerState.ACTIVE;
+  }
 
   /**
    * @type {boolean}
    * @api
    */
-  get loading() { return this._state === LayerState.LOADING; }
+  get loading() {
+    return this._state === LayerState.LOADING;
+  }
 
   /**
    * interface to initialize this implementation, is used to setup elements which have to be created only once.

package/src/{vcs/vcm/layer → 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/{vcs/vcm/layer → layer}/layerSymbols.js

@@ -1,6 +1,7 @@
+/* eslint-disable import/prefer-default-export */
+
 /**
  * @type {symbol}
  * @const
  */
-// eslint-disable-next-line import/prefer-default-export
 export const vcsLayerName = Symbol('vcsLayerName');

package/src/{vcs/vcm/layer/oblique/layerOblique.js → layer/oblique/layerObliqueImpl.js}

@@ -3,12 +3,12 @@ import { vcsLayerName } from '../layerSymbols.js';
 
 /**
  * @class
- * @extends {LayerImplementation<import("@vcmap/core").Oblique>}}
+ * @extends {LayerImplementation<import("@vcmap/core").ObliqueMap>}}
  * @abstract
  */
-class LayerOblique extends LayerImplementation {
+class LayerObliqueImpl extends LayerImplementation {
   /**
-   * @param {import("@vcmap/core").Oblique} map
+   * @param {import("@vcmap/core").ObliqueMap} map
    * @param {LayerImplementationOptions} options
    */
   constructor(map, options) {
@@ -59,7 +59,9 @@ class LayerOblique extends LayerImplementation {
    * @returns {import("ol/layer").Layer<import("ol/source/Source").default>}
    */
   // eslint-disable-next-line class-methods-use-this
-  getOLLayer() { throw new Error(); }
+  getOLLayer() {
+    throw new Error();
+  }
 
   /**
    * @inheritDoc
@@ -73,4 +75,4 @@ class LayerOblique extends LayerImplementation {
   }
 }
 
-export default LayerOblique;
+export default LayerObliqueImpl;