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

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

@@ -1,11 +1,11 @@
 import { EntityCollection } from '@vcmap/cesium';
 import Layer from './layer.js';
-import CesiumMap from '../maps/cesium.js';
-import DataSourceCesium from './cesium/dataSourceCesium.js';
+import CesiumMap from '../map/cesiumMap.js';
+import DataSourceCesiumImpl from './cesium/dataSourceCesiumImpl.js';
 import { vcsLayerName } from './layerSymbols.js';
 import FeatureVisibility, { FeatureVisibilityAction } from './featureVisibility.js';
 import { getGlobalHider } from './globalHider.js';
-import { VcsClassRegistry } from '../classRegistry.js';
+import { layerClassRegistry } from '../classRegistry.js';
 
 /**
  * @typedef {LayerOptions} DataSourceOptions
@@ -30,12 +30,11 @@ import { VcsClassRegistry } from '../classRegistry.js';
 /**
  * Represents a layer of Cesium.Entity
  * @class
- * @export
  * @extends {Layer}
  * @api stable
  */
-class DataSource extends Layer {
-  static get className() { return 'vcs.vcm.layer.DataSource'; }
+class DataSourceLayer extends Layer {
+  static get className() { return 'DataSourceLayer'; }
 
   /**
    * @returns {DataSourceOptions}
@@ -52,7 +51,7 @@ class DataSource extends Layer {
    */
   constructor(options) {
     super(options);
-    const defaultOptions = DataSource.getDefaultOptions();
+    const defaultOptions = DataSourceLayer.getDefaultOptions();
     /**
      * The entities of this layer. Use the `addEntity` API to add Enitities to ensure interoperability with vcm interfaces
      * @type {import("@vcmap/cesium").EntityCollection}
@@ -151,11 +150,11 @@ class DataSource extends Layer {
 
   /**
    * @param {CesiumMap} map
-   * @returns {Array<DataSourceCesium>}
+   * @returns {Array<DataSourceCesiumImpl>}
    */
   createImplementationsForMap(map) {
     if (map instanceof CesiumMap) {
-      return [new DataSourceCesium(map, this.getImplementationOptions())];
+      return [new DataSourceCesiumImpl(map, this.getImplementationOptions())];
     }
     return [];
   }
@@ -183,7 +182,7 @@ class DataSource extends Layer {
    */
   flyToEntity(id) {
     this.getImplementations().forEach((impl) => {
-      /** @type {DataSourceCesium} */ (impl).flyToEntity(id);
+      /** @type {DataSourceCesiumImpl} */ (impl).flyToEntity(id);
     });
   }
 
@@ -235,8 +234,8 @@ class DataSource extends Layer {
    * @inheritDoc
    * @returns {DataSourceOptions}
    */
-  getConfigObject() {
-    const config = /** @type {DataSourceOptions} */ (super.getConfigObject());
+  toJSON() {
+    const config = /** @type {DataSourceOptions} */ (super.toJSON());
     if (Object.keys(this._genericFeatureProperties).length > 0) {
       config.genericFeatureProperties = { ...this._genericFeatureProperties };
     }
@@ -255,5 +254,5 @@ class DataSource extends Layer {
   }
 }
 
-VcsClassRegistry.registerClass(DataSource.className, DataSource);
-export default DataSource;
+layerClassRegistry.registerClass(DataSourceLayer.className, DataSourceLayer);
+export default DataSourceLayer;

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

@@ -3,18 +3,16 @@ import Style from 'ol/style/Style.js';
 import { check } from '@vcsuite/check';
 import { parseInteger } from '@vcsuite/parsers';
 import Layer from './layer.js';
-import StyleItem, { referenceableStyleSymbol } from '../util/style/styleItem.js';
-import VectorStyleItem from '../util/style/vectorStyleItem.js';
+import StyleItem from '../style/styleItem.js';
+import VectorStyleItem from '../style/vectorStyleItem.js';
 import FeatureVisibility from './featureVisibility.js';
-import { getStyleOrDefaultStyle } from '../util/style/styleFactory.js';
-import VcsEvent from '../event/vcsEvent.js';
-import { styleCollection } from '../globalCollections.js';
-import { VcsClassRegistry } from '../classRegistry.js';
+import { getStyleOrDefaultStyle } from '../style/styleFactory.js';
+import VcsEvent from '../vcsEvent.js';
+import { layerClassRegistry } from '../classRegistry.js';
 
 /**
  * @typedef {LayerOptions} FeatureLayerOptions
- * @property {DeclarativeStyleItemOptions|VectorStyleItemOptions|import("@vcmap/core").StyleItem|string|undefined} style
- * @property {string|undefined} activeStyleName - vcs:undocumented
+ * @property {DeclarativeStyleItemOptions|VectorStyleItemOptions|import("@vcmap/core").StyleItem|undefined} style
  * @property {Object|undefined} genericFeatureProperties - properties to add to generic features, eg for display in the balloon
  * @property {number} [balloonHeightOffset=10]
  * @property {FeatureVisibility|undefined} featureVisibility - vcs:undocumented
@@ -42,16 +40,15 @@ import { VcsClassRegistry } from '../classRegistry.js';
  */
 
 /**
- * Base class for all layers representing features, e.g. Vector, Buildings, POIs
+ * Base class for all layers representing features, e.g. VectorLayer, Buildings, POIs
  * @class
  * @abstract
  * @extends {Layer}
- * @export
  * @api
  */
 class FeatureLayer extends Layer {
   /** @type {string} */
-  static get className() { return 'vcs.vcm.layer.FeatureLayer'; }
+  static get className() { return 'FeatureLayer'; }
 
   /**
    * @returns {FeatureLayerOptions}
@@ -76,7 +73,7 @@ class FeatureLayer extends Layer {
      * @type {import("@vcmap/core").StyleItem}
      * @private
      */
-    this._style = this.getStyleOrDefaultStyle(options.activeStyleName || options.style);
+    this._style = this.getStyleOrDefaultStyle(options.style);
     /**
      * @type {import("@vcmap/core").StyleItem}
      * @private
@@ -180,7 +177,7 @@ class FeatureLayer extends Layer {
   }
 
   /**
-   * @param {(Reference|DeclarativeStyleItemOptions|VectorStyleItemOptions|import("@vcmap/core").StyleItem|string)=} styleOptions
+   * @param {(DeclarativeStyleItemOptions|VectorStyleItemOptions|import("@vcmap/core").StyleItem)=} styleOptions
    * @param {(import("@vcmap/core").VectorStyleItem|import("@vcmap/core").DeclarativeStyleItem)=} defaultStyle
    * @returns {import("@vcmap/core").StyleItem}
    */
@@ -191,21 +188,14 @@ class FeatureLayer extends Layer {
 
   /**
    * Sets the style based on a styleName on a layer
-   * @param {string|import("ol/style/Style").default|import("ol/style/Style").StyleFunction|import("@vcmap/core").StyleItem} style
+   * @param {import("ol/style/Style").default|import("ol/style/Style").StyleFunction|import("@vcmap/core").StyleItem} style
    * @param {boolean=} silent
    * @api
    */
   setStyle(style, silent) {
-    check(style, [Style, StyleItem, Function, String]);
+    check(style, [Style, StyleItem, Function]);
 
-    if (typeof style === 'string') {
-      const styleItem = styleCollection.getByKey(style);
-      if (!styleItem) {
-        this.getLogger().warning(`could not find style with name ${style}`);
-        return;
-      }
-      this._style = styleItem;
-    } else if (style instanceof StyleItem) {
+    if (style instanceof StyleItem) {
       this._style = style;
     } else {
       this._style = new VectorStyleItem({});
@@ -229,14 +219,10 @@ class FeatureLayer extends Layer {
   /**
    * @returns {FeatureLayerOptions}
    */
-  getConfigObject() {
-    const config = /** @type {FeatureLayerOptions} */ (super.getConfigObject());
+  toJSON() {
+    const config = /** @type {FeatureLayerOptions} */ (super.toJSON());
     if (!this.getStyleOrDefaultStyle().equals(this._style)) {
-      if (this._style[referenceableStyleSymbol]) {
-        config.style = this.style.getReference();
-      } else {
-        config.style = this.style.getOptions();
-      }
+      config.style = this.style.toJSON();
     }
 
     if (Object.keys(this._genericFeatureProperties).length > 0) {
@@ -257,5 +243,5 @@ class FeatureLayer extends Layer {
   }
 }
 
-VcsClassRegistry.registerClass(FeatureLayer.className, FeatureLayer);
+layerClassRegistry.registerClass(FeatureLayer.className, FeatureLayer);
 export default FeatureLayer;

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

@@ -1,34 +1,34 @@
-import axios from 'axios';
 import Feature from 'ol/Feature.js';
-import { Cesium3DTileFeature, Cesium3DTilePointFeature, ImagerySplitDirection } from '@vcmap/cesium';
+import { Cesium3DTileFeature, Cesium3DTilePointFeature, SplitDirection } from '@vcmap/cesium';
 import VectorSource from 'ol/source/Vector.js';
 import { createEmpty, extend as extendExtent } from 'ol/extent.js';
 
-import Vector from './vector.js';
-import { featureStoreStateSymbol, featureStoreState } from './featureStoreState.js';
+import VectorLayer from './vectorLayer.js';
+import { featureStoreStateSymbol, FeatureStoreLayerState } from './featureStoreLayerState.js';
 import { parseGeoJSON } from './geojsonHelpers.js';
 import { mercatorProjection } from '../util/projection.js';
-import FeatureStoreChanges from './featureStoreChanges.js';
-import VectorStyleItem, { defaultVectorStyle, vectorStyleSymbol } from '../util/style/vectorStyleItem.js';
+import FeatureStoreLayerChanges from './featureStoreLayerChanges.js';
+import VectorStyleItem, { defaultVectorStyle, vectorStyleSymbol } from '../style/vectorStyleItem.js';
 import FeatureVisibility, {
   FeatureVisibilityAction,
   originalStyle,
   synchronizeFeatureVisibility,
   updateOriginalStyle,
 } from './featureVisibility.js';
-import CesiumTilesetCesium, { getExtentFromTileset } from './cesium/cesiumTilesetCesium.js';
-import CesiumMap from '../maps/cesium.js';
-import Openlayers from '../maps/openlayers.js';
-import Oblique from '../maps/oblique.js';
-import CesiumTileset from './cesiumTileset.js';
+import CesiumTilesetCesiumImpl, { getExtentFromTileset } from './cesium/cesiumTilesetCesiumImpl.js';
+import CesiumMap from '../map/cesiumMap.js';
+import OpenlayersMap from '../map/openlayersMap.js';
+import ObliqueMap from '../map/obliqueMap.js';
+import CesiumTilesetLayer from './cesiumTilesetLayer.js';
 import VectorProperties from './vectorProperties.js';
-import VectorOpenlayers from './openlayers/vectorOpenlayers.js';
+import VectorOpenlayersImpl from './openlayers/vectorOpenlayersImpl.js';
 import Layer from './layer.js';
-import DeclarativeStyleItem from '../util/style/declarativeStyleItem.js';
-import VectorOblique from './oblique/vectorOblique.js';
+import DeclarativeStyleItem from '../style/declarativeStyleItem.js';
+import VectorObliqueImpl from './oblique/vectorObliqueImpl.js';
 import Extent from '../util/extent.js';
 import { isMobile } from '../util/isMobile.js';
-import { VcsClassRegistry } from '../classRegistry.js';
+import { layerClassRegistry } from '../classRegistry.js';
+import { requestJson } from '../util/fetch.js';
 
 /**
  * @typedef {Object} FeatureStoreStaticRepresentation
@@ -43,7 +43,7 @@ import { VcsClassRegistry } from '../classRegistry.js';
  * @property {Object} properties - the properties bag
  * @property {Object} geometry
  * @property {Object|undefined} vcsMeta
- * @property {featureStoreState} state
+ * @property {FeatureStoreLayerState} state
  * @property {string} type - the featureType
  * @todo write vcsMeta for features
  * @todo set type to be one of an enum
@@ -66,7 +66,7 @@ import { VcsClassRegistry } from '../classRegistry.js';
 
 /**
  * @typedef {FeatureStoreLayerSchema} FeatureStoreOptions
- * @property {Function|undefined} injectedFetchDynamicFeatureFunc - injected function for fetching dynamic features from a remote FeatureStore server
+ * @property {Function|undefined} injectedFetchDynamicFeatureFunc - injected function for fetching dynamic features from a remote FeatureStoreLayer server
  * @api
  */
 
@@ -74,14 +74,13 @@ import { VcsClassRegistry } from '../classRegistry.js';
 export const isTiledFeature = Symbol('isTiledFeature');
 
 /**
- * FeatureStore Layer
+ * FeatureStoreLayer Layer
  * @class
- * @export
- * @extends {Vector}
+ * @extends {VectorLayer}
  * @api
  */
-class FeatureStore extends Vector {
-  static get className() { return 'vcs.vcm.layer.FeatureStore'; }
+class FeatureStoreLayer extends VectorLayer {
+  static get className() { return 'FeatureStoreLayer'; }
 
   /**
    * @returns {FeatureStoreOptions}
@@ -89,11 +88,11 @@ class FeatureStore extends Vector {
   static getDefaultOptions() {
     return {
       id: '',
-      type: 'vcs.vcm.layer.FeatureStore',
+      type: 'FeatureStoreLayer',
       featureType: 'simple',
       features: [],
-      ...Vector.getDefaultOptions(),
-      projection: mercatorProjection.getConfigObject(),
+      ...VectorLayer.getDefaultOptions(),
+      projection: mercatorProjection.toJSON(),
       staticRepresentation: {},
       hiddenStaticFeatureIds: [],
       vcsMeta: {
@@ -108,7 +107,7 @@ class FeatureStore extends Vector {
    * @param {FeatureStoreOptions} options
    */
   constructor(options) {
-    const defaultOptions = FeatureStore.getDefaultOptions();
+    const defaultOptions = FeatureStoreLayer.getDefaultOptions();
     const vectorOptions = {
       projection: defaultOptions.projection,
       ...options,
@@ -116,8 +115,8 @@ class FeatureStore extends Vector {
     super(vectorOptions);
     this._supportedMaps = [
       CesiumMap.className,
-      Openlayers.className,
-      Oblique.className,
+      OpenlayersMap.className,
+      ObliqueMap.className,
     ];
 
     /**
@@ -136,10 +135,10 @@ class FeatureStore extends Vector {
     this.hiddenStaticFeatureIds = new Set(options.hiddenStaticFeatureIds || defaultOptions.hiddenStaticFeatureIds);
 
     /**
-     * @type {FeatureStoreChanges}
+     * @type {FeatureStoreLayerChanges}
      * @api
      */
-    this.changeTracker = new FeatureStoreChanges(this);
+    this.changeTracker = new FeatureStoreLayerChanges(this);
 
     const { vcsMeta } = defaultOptions;
     if (options.vcsMeta) {
@@ -249,7 +248,7 @@ class FeatureStore extends Vector {
   _loadTwoDim() {
     if (!this._twoDimLoaded) {
       this._twoDimLoaded = (async () => {
-        const { data } = await axios.get(this.staticRepresentation.twoDim);
+        const data = await requestJson(this.staticRepresentation.twoDim);
         const { features } = parseGeoJSON(data, {
           targetProjection: mercatorProjection,
           dynamicStyle: true,
@@ -288,14 +287,14 @@ class FeatureStore extends Vector {
 
   /**
    * @param {import("@vcmap/core").VcsMap} map
-   * @returns {Array<VectorOblique|import("@vcmap/core").VectorCesium|VectorOpenlayers|CesiumTilesetCesium>}
+   * @returns {Array<VectorObliqueImpl|import("@vcmap/core").VectorCesiumImpl|VectorOpenlayersImpl|CesiumTilesetCesiumImpl>}
    */
   // @ts-ignore
   createImplementationsForMap(map) {
     const impls = /** @type {Array<import("@vcmap/core").LayerImplementation>} */
       (super.createImplementationsForMap(map));
     if (map instanceof CesiumMap && this.staticRepresentation && this.staticRepresentation.threeDim) {
-      impls.push(new CesiumTilesetCesium(map, /** @type {CesiumTilesetImplementationOptions} */ ({
+      impls.push(new CesiumTilesetCesiumImpl(map, /** @type {CesiumTilesetImplementationOptions} */ ({
         url: this.staticRepresentation.threeDim,
         tilesetOptions: {
           maximumScreenSpaceError: isMobile() ? this.screenSpaceErrorMobile : this.screenSpaceError,
@@ -310,19 +309,19 @@ class FeatureStore extends Vector {
         name: this.name,
         style: this.style,
         featureVisibility: this._staticFeatureVisibility,
-        splitDirection: ImagerySplitDirection.NONE,
+        splitDirection: SplitDirection.NONE,
         jumpToLocation: false,
       })));
     } else if (this.staticRepresentation && this.staticRepresentation.twoDim) {
       this._loadTwoDim();
-      if (map instanceof Openlayers) {
-        impls.push(new VectorOpenlayers(map, this._getTwoDimStaticImplOptions()));
-      } else if (map instanceof Oblique) {
-        impls.push(new VectorOblique(map, this._getTwoDimStaticImplOptions()));
+      if (map instanceof OpenlayersMap) {
+        impls.push(new VectorOpenlayersImpl(map, this._getTwoDimStaticImplOptions()));
+      } else if (map instanceof ObliqueMap) {
+        impls.push(new VectorObliqueImpl(map, this._getTwoDimStaticImplOptions()));
       }
     }
     // eslint-disable-next-line max-len
-    return /** @type {Array<VectorOblique|import("@vcmap/core").VectorCesium|VectorOpenlayers|CesiumTilesetCesium>} */ (impls);
+    return /** @type {Array<VectorObliqueImpl|import("@vcmap/core").VectorCesiumImpl|VectorOpenlayersImpl|CesiumTilesetCesiumImpl>} */ (impls);
   }
 
   /**
@@ -371,7 +370,7 @@ class FeatureStore extends Vector {
 
   /**
    * @inheritDoc
-   * @param {string|import("ol/style/Style").default|import("ol/style/Style").StyleFunction|import("@vcmap/core").StyleItem} style
+   * @param {import("ol/style/Style").default|import("ol/style/Style").StyleFunction|import("@vcmap/core").StyleItem} style
    * @param {boolean=} silent
    * @api
    */
@@ -409,7 +408,7 @@ class FeatureStore extends Vector {
    */
   setEditing(symbol, featureType) {
     this.getImplementations().forEach((impl) => {
-      if (impl instanceof CesiumTilesetCesium) {
+      if (impl instanceof CesiumTilesetCesiumImpl) {
         if (impl.initialized) {
           if (featureType != null) {
             impl.cesium3DTileset[symbol] = featureType;
@@ -447,7 +446,7 @@ class FeatureStore extends Vector {
    */
   objectClickedHandler(feature) {
     if ((feature instanceof Cesium3DTileFeature || feature instanceof Cesium3DTilePointFeature)) {
-      return CesiumTileset.prototype.objectClickedHandler.call(this, feature);
+      return CesiumTilesetLayer.prototype.objectClickedHandler.call(this, feature);
     } else if (feature instanceof Feature) {
       return super.objectClickedHandler(feature);
     }
@@ -463,7 +462,7 @@ class FeatureStore extends Vector {
       // @ts-ignore
       return super.getGenericFeatureFromClickedObject(/** @type {VectorClickedObject} */ (object));
     }
-    const generic = CesiumTileset.prototype.getGenericFeatureFromClickedObject.call(this, object);
+    const generic = CesiumTilesetLayer.prototype.getGenericFeatureFromClickedObject.call(this, object);
     generic.layerName = this.name;
     generic.layerClass = this.className;
     return generic;
@@ -481,9 +480,9 @@ class FeatureStore extends Vector {
     const extent = super.getZoomToExtent();
     const mercatorExtent = extent ? extent.getCoordinatesInProjection(mercatorProjection) : createEmpty();
     if (this.staticRepresentation.threeDim) {
-      const threeDImpl = /** @type {CesiumTilesetCesium} */ (this.getImplementations()
+      const threeDImpl = /** @type {CesiumTilesetCesiumImpl} */ (this.getImplementations()
         .find((impl) => {
-          return impl instanceof CesiumTilesetCesium && impl.cesium3DTileset;
+          return impl instanceof CesiumTilesetCesiumImpl && impl.cesium3DTileset;
         }));
 
       if (threeDImpl) {
@@ -497,7 +496,7 @@ class FeatureStore extends Vector {
     }
 
     const actualExtent = new Extent({
-      ...mercatorProjection.getConfigObject(),
+      projection: mercatorProjection.toJSON(),
       coordinates: mercatorExtent,
     });
 
@@ -522,7 +521,7 @@ class FeatureStore extends Vector {
 
     this.getImplementations()
       .forEach((impl) => {
-        if (impl instanceof CesiumTilesetCesium && impl.cesium3DTileset) {
+        if (impl instanceof CesiumTilesetCesiumImpl && impl.cesium3DTileset) {
           impl.cesium3DTileset.maximumScreenSpaceError = value;
         }
       });
@@ -530,7 +529,7 @@ class FeatureStore extends Vector {
 
   /**
    * switch an array of static features to dynamic features
-   * This is done by hiding the static features and adding their dynamic counterparts to the FeatureStore layer
+   * This is done by hiding the static features and adding their dynamic counterparts to the FeatureStoreLayer layer
    * @param {string|number} [featureId] input static feature ID
    * @returns {Promise<import("ol").Feature<import("ol/geom/Geometry").default>>}
    * @api
@@ -573,7 +572,7 @@ class FeatureStore extends Vector {
     this.hiddenStaticFeatureIds.add(featureId);
     const feature = new Feature();
     feature.setId(featureId);
-    feature[featureStoreStateSymbol] = featureStoreState.STATIC;
+    feature[featureStoreStateSymbol] = FeatureStoreLayerState.STATIC;
     this.changeTracker.removeFeature(feature);
   }
 
@@ -596,9 +595,9 @@ class FeatureStore extends Vector {
    * @inheritDoc
    * @returns {FeatureStoreOptions}
    */
-  getConfigObject() {
-    const config = /** @type {FeatureStoreOptions} */ (super.getConfigObject());
-    const defaultOptions = FeatureStore.getDefaultOptions();
+  toJSON() {
+    const config = /** @type {FeatureStoreOptions} */ (super.toJSON());
+    const defaultOptions = FeatureStoreLayer.getDefaultOptions();
 
     delete config.projection;
     config.vcsMeta = this.vectorProperties
@@ -643,5 +642,5 @@ class FeatureStore extends Vector {
   }
 }
 
-VcsClassRegistry.registerClass(FeatureStore.className, FeatureStore);
-export default FeatureStore;
+layerClassRegistry.registerClass(FeatureStoreLayer.className, FeatureStoreLayer);
+export default FeatureStoreLayer;