@vcmap/core 5.0.0-rc.0 → 5.0.0-rc.4

package/src/vcs/vcm/util/featureProvider/abstractFeatureProvider.js

@@ -154,9 +154,9 @@ class AbstractFeatureProvider extends VcsObject {
    * @returns {AbstractFeatureProviderOptions}
    * @api
    */
-  getConfigObject() {
+  toJSON() {
     const config =
-      /** @type {AbstractFeatureProviderOptions} */ (super.getConfigObject());
+      /** @type {AbstractFeatureProviderOptions} */ (super.toJSON());
 
     const defaultOptions = AbstractFeatureProvider.getDefaultOptions();
     delete config.name; // the name is irrelevant, since its the layers name

package/src/vcs/vcm/util/featureProvider/wmsFeatureProvider.js

@@ -222,8 +222,8 @@ class WMSFeatureProvider extends AbstractFeatureProvider {
    * @inheritDoc
    * @returns {WMSFeatureProviderOptions}
    */
-  getConfigObject() {
-    const config = /** @type {WMSFeatureProviderOptions} */ (super.getConfigObject());
+  toJSON() {
+    const config = /** @type {WMSFeatureProviderOptions} */ (super.toJSON());
     const defaultOptions = WMSFeatureProvider.getDefaultOptions();
     if (this.featureInfoResponseType !== defaultOptions.responseType) {
       config.responseType = this.featureInfoResponseType;
@@ -234,7 +234,7 @@ class WMSFeatureProvider extends AbstractFeatureProvider {
     }
 
     if (this.projection !== defaultOptions.projection) {
-      config.projection = this.projection.getConfigObject();
+      config.projection = this.projection.toJSON();
     }
 
     config.url = this._wmsSourceOptions.url;
@@ -259,7 +259,7 @@ class WMSFeatureProvider extends AbstractFeatureProvider {
       config.tileSize = this._wmsSourceOptions.tileSize.slice();
     }
     if (this.extent) {
-      config.extent = this.extent.getConfigObject();
+      config.extent = this.extent.toJSON();
     }
 
     return config;

package/src/vcs/vcm/util/indexedCollection.js

@@ -42,8 +42,22 @@ class IndexedCollection extends Collection {
      * @api
      */
     this.moved = new VcsEvent();
+
+    /**
+     * @type {symbol}
+     * @private
+     */
+    this._previousIndexSymbol = Symbol('previousIndex');
   }
 
+  /**
+   * Get the symbol which is attached to an item prior to its removal. If an item is removed, the current index of the item
+   * is set on the item with this symbol.
+   * @type {symbol}
+   * @readonly
+   */
+  get previousIndexSymbol() { return this._previousIndexSymbol; }
+
   /**
    * Returns an item at index.
    * @param {number} index
@@ -76,6 +90,15 @@ class IndexedCollection extends Collection {
     return null;
   }
 
+  /**
+   * @inheritDoc
+   * @param {T} item
+   */
+  remove(item) {
+    item[this._previousIndexSymbol] = this._array.indexOf(item);
+    super.remove(item);
+  }
+
   /**
    * @param {T} item
    * @param {number} itemIndex

package/src/vcs/vcm/util/layerCollection.js

@@ -44,9 +44,6 @@ class LayerCollection extends IndexedCollection {
     this._layerEventListeners = {};
 
     /**
-     * A symbol to describe the local z index of a layer. The local z index must not equal the layers z index, but is
-     * always consistent in comparison to the neighbouring layers. If a layer is moved other then by z index, the collection
-     * ensures consistency by setting a new local z index if needed.
      * @type {symbol}
      * @private
      */
@@ -67,6 +64,15 @@ class LayerCollection extends IndexedCollection {
     this.exclusiveManager = new ExclusiveManager();
   }
 
+  /**
+   * A symbol to describe the local z index of a layer. The local z index must not equal the layers z index, but is
+   * always consistent in comparison to the neighbouring layers. If a layer is moved other then by z index, the collection
+   * ensures consistency by setting a new local z index if needed.
+   * @type {symbol}
+   * @readonly
+   */
+  get zIndexSymbol() { return this._zIndexSymbol; }
+
   /**
    * @param {import("@vcmap/core").Layer} layer
    * @private
@@ -116,10 +122,9 @@ class LayerCollection extends IndexedCollection {
   _zIndexChanged(layer) {
     const currentIndex = this.indexOf(layer);
     if (currentIndex > -1) {
-      const increased = layer[this._zIndexSymbol] < layer.zIndex;
       layer[this._zIndexSymbol] = layer.zIndex;
       let zIndexPosition = this._findZIndexPosition(layer.zIndex);
-      if (increased && zIndexPosition > 0) {
+      if (zIndexPosition > 0 && zIndexPosition > currentIndex) {
         zIndexPosition -= 1; // remove self from count
       }
       zIndexPosition = zIndexPosition != null ? zIndexPosition : this._array.length - 1;

package/src/vcs/vcm/util/projection.js

@@ -3,12 +3,15 @@ import { register } from 'ol/proj/proj4.js';
 import proj4 from 'proj4';
 import { getLogger as getLoggerByName } from '@vcsuite/logger';
 import { check } from '@vcsuite/check';
+import { VcsClassRegistry } from '../classRegistry.js';
 
 /**
  * @typedef {Object} ProjectionOptions
+ * @property {string} [type]
  * @property {string|number} [epsg] -  EPSG of the projection, for example: "EPSG:4326" if not specified, uses the framework projection
  * @property {string|undefined|null} [proj4] - definition of the projection. See for example: {@link http://spatialreference.org/ref/epsg/4326/proj4/} proj4
  * @property {Array<string>|undefined|null} [alias] - aliases to define
+ * @property {string|undefined} [prefix='EPSG:'] - an alternate prefix to use for custom projection
  * @api stable
  */
 
@@ -36,7 +39,8 @@ let defaultProjectionOption = {
  * @returns {string}
  */
 function parseEPSGCode(value, prefix = 'EPSG:') {
-  const matches = `${value}`.match(/^(?:epsg:)?(\d+)/i);
+  const regex = new RegExp(`^(?:${prefix})?(\\d+)`, 'i');
+  const matches = `${value}`.match(regex);
   if (matches && matches[1]) {
     return `${prefix}${matches[1]}`;
   }
@@ -73,9 +77,11 @@ function validateProjectionOptions(options) {
  * @returns {ProjectionOptions} valid options
  */
 function registerProjection(options) {
-  const saneOptions = {};
+  const saneOptions = {
+    prefix: options.prefix,
+  };
   if (options.epsg) {
-    saneOptions.epsg = parseEPSGCode(options.epsg);
+    saneOptions.epsg = parseEPSGCode(options.epsg, options.prefix);
     if (saneOptions.epsg) {
       if (options.proj4) {
         saneOptions.proj4 = options.proj4;
@@ -123,6 +129,11 @@ export function setDefaultProjectionOptions(options) {
  * @api stable
  */
 class Projection {
+  /**
+   * @returns {string}
+   */
+  static get className() { return 'vcs.vcm.util.Projection'; }
+
   /**
    * @param {ProjectionOptions} options
    */
@@ -143,6 +154,20 @@ class Projection {
     if (!this.proj) {
       this._epsg = Projection.parseEPSGCode(defaultProjectionOption.epsg);
     }
+
+    /**
+     * Cached for toJSON
+     * @type {Array<string>}
+     * @private
+     */
+    this._alias = saneOptions.alias;
+
+    /**
+     * Cached for toJSON
+     * @type {string}
+     * @private
+     */
+    this._prefix = saneOptions.prefix;
   }
 
   /**
@@ -262,13 +287,20 @@ class Projection {
    * @returns {ProjectionOptions}
    * @api stable
    */
-  getConfigObject() {
+  toJSON() {
     const configObject = {
+      type: Projection.className,
       epsg: this.epsg,
     };
     if (this.proj4) {
       configObject.proj4 = this.proj4;
     }
+    if (Array.isArray(this._alias) && this._alias.length > 0) {
+      configObject.alias = this._alias.slice();
+    }
+    if (this._prefix) {
+      configObject.prefix = this._prefix;
+    }
     return configObject;
   }
 
@@ -346,3 +378,5 @@ export const wgs84Projection = new Projection({ epsg: 4326 });
  * @export
  */
 export const mercatorProjection = new Projection({ epsg: 3857 });
+
+VcsClassRegistry.registerClass(Projection.className, Projection);

package/src/vcs/vcm/util/style/styleItem.js

@@ -162,6 +162,23 @@ class StyleItem extends VcsObject {
     return {};
   }
 
+  /**
+   * @inheritDoc
+   * @returns {StyleItemOptions}
+   */
+  toJSON() {
+    const config = { ...super.toJSON(), ...this.getOptions() };
+    if (this.title) {
+      config.title = this.title;
+    }
+
+    if (this.legend.length > 0) {
+      config.legend = this.legend.slice();
+    }
+
+    return config;
+  }
+
   /**
    * Clones this style
    * @param {StyleItem=} result

package/src/vcs/vcm/util/viewpoint.js

@@ -3,6 +3,7 @@ import { parseBoolean, parseNumber } from '@vcsuite/parsers';
 import Projection, { wgs84Projection } from './projection.js';
 import VcsObject from '../object.js';
 import Extent from './extent.js';
+import { VcsClassRegistry } from '../classRegistry.js';
 
 /**
  * compares two numeric properties
@@ -158,9 +159,9 @@ class ViewPoint extends VcsObject {
    * @returns {ViewPointOptions} returns a options object. This object can be used to reconstruct a new viewpoint
    * @api stable
    */
-  getConfigObject() {
+  toJSON() {
     return {
-      ...super.getConfigObject(),
+      ...super.toJSON(),
       distance: this.distance,
       cameraPosition: this.cameraPosition ? this.cameraPosition.slice() : null,
       groundPosition: this.groundPosition ? this.groundPosition.slice() : null,
@@ -179,7 +180,7 @@ class ViewPoint extends VcsObject {
    * @api stable
    */
   clone() {
-    return new ViewPoint(this.getConfigObject());
+    return new ViewPoint(this.toJSON());
   }
 
   /**
@@ -331,3 +332,5 @@ class ViewPoint extends VcsObject {
 }
 
 export default ViewPoint;
+
+VcsClassRegistry.registerClass(ViewPoint.className, ViewPoint);