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

package/src/layer/vectorTileLayer.js

@@ -69,7 +69,6 @@ function synchronizeFeatureVisibility(featureVisibility, globalHider, feature) {
 /**
  * VectorTileLayer Layer for tiled vector Data. Can be connected to data with a TileProvider
  * @class
- * @export
  * @extends {FeatureLayer}
  * @api stable
  */
@@ -139,6 +138,9 @@ class VectorTileLayer extends FeatureLayer {
     this.tileProvider = options.tileProvider instanceof TileProvider ? // XXX this now throws if not passing in a tileProvider.
       options.tileProvider :
       getObjectFromClassRegistry(tileProviderClassRegistry, options.tileProvider);
+    if (this.tileProvider) {
+      this.tileProvider.locale = this.locale;
+    }
 
     /**
      * @type {number|undefined}
@@ -156,7 +158,7 @@ class VectorTileLayer extends FeatureLayer {
      * @type {Array<Function>}
      * @private
      */
-    this._featureVisibilityListener = [];
+    this._featureVisibilityListeners = [];
 
     /**
      * @type {Function}
@@ -178,6 +180,25 @@ class VectorTileLayer extends FeatureLayer {
     this._styleZIndex = 0;
   }
 
+  /**
+   * returns the currently set locale. Can be used to provide locale specific URLs.
+   * @type {string}
+   */
+  get locale() {
+    return super.locale;
+  }
+
+  /**
+   * sets the locale and reloads the layer the if the URL is a locale aware Object.
+   * @param {string} value
+   */
+  set locale(value) {
+    if (this.tileProvider) {
+      this.tileProvider.locale = super.locale;
+    }
+    super.locale = value;
+  }
+
   /**
    * initializes the layer, can be used to defer loading
    * @returns {Promise<void>}
@@ -255,15 +276,24 @@ class VectorTileLayer extends FeatureLayer {
   }
 
   /**
-   *
-   * @returns {Array<Function>}
+   * @param {import("@vcmap/core").GlobalHider} globalHider
+   */
+  setGlobalHider(globalHider) {
+    super.setGlobalHider(globalHider);
+    this._setupFeatureVisibilityHandlers();
+  }
+
+  /**
+   * Sets up listeners for featureVisibility and global hider
    * @private
    */
   _setupFeatureVisibilityHandlers() {
     if (!this.tileProvider.trackFeaturesToTiles) {
-      return [];
+      return;
     }
-    return [
+    this._featureVisibilityListeners.forEach((cb) => { cb(); });
+
+    this._featureVisibilityListeners = [
       this.featureVisibility.changed.addEventListener(({ action, ids }) => {
         const tileIdsChanged = new Set();
         ids.forEach((id) => {
@@ -290,8 +320,10 @@ class VectorTileLayer extends FeatureLayer {
         });
         this.updateTiles([...tileIdsChanged]);
       }),
+    ];
 
-      this.globalHider.changed.addEventListener(({ action, ids }) => {
+    if (this.globalHider) {
+      this._featureVisibilityListeners.push(this.globalHider.changed.addEventListener(({ action, ids }) => {
         const tileIdsChanged = new Set();
         ids.forEach((id) => {
           const tileIds = this.tileProvider.featureIdToTileIds.get(id);
@@ -312,8 +344,8 @@ class VectorTileLayer extends FeatureLayer {
           }
         });
         this.updateTiles([...tileIdsChanged]);
-      }),
-    ];
+      }));
+    }
   }
 
   /**
@@ -401,8 +433,8 @@ class VectorTileLayer extends FeatureLayer {
    */
   async activate() {
     await super.activate();
-    this._featureVisibilityListener = this._setupFeatureVisibilityHandlers();
-    if (this.tileProvider.trackFeaturesToTiles) {
+    this._setupFeatureVisibilityHandlers();
+    if (this.tileProvider.trackFeaturesToTiles && this.globalHider) {
       this.tileProvider.forEachFeature((feature) => {
         synchronizeFeatureVisibility(this.featureVisibility, this.globalHider, feature);
       });
@@ -415,7 +447,7 @@ class VectorTileLayer extends FeatureLayer {
    */
   deactivate() {
     super.deactivate();
-    this._featureVisibilityListener.forEach((cb) => { cb(); });
+    this._featureVisibilityListeners.forEach((cb) => { cb(); });
   }
 
   /**
@@ -423,7 +455,7 @@ class VectorTileLayer extends FeatureLayer {
    * @api
    */
   destroy() {
-    this._featureVisibilityListener.forEach((cb) => { cb(); });
+    this._featureVisibilityListeners.forEach((cb) => { cb(); });
     super.destroy();
     this._tileLoadEventListener();
     if (this.featureProvider) {

package/src/layer/wfsLayer.js

@@ -16,7 +16,6 @@ import { requestJson } from '../util/fetch.js';
 /**
  * WfsLayer VectorLayer Layer
  * @class
- * @export
  * @extends {VectorLayer}
  * @api
  */

package/src/layer/wmsLayer.js

@@ -32,7 +32,6 @@ import { layerClassRegistry } from '../classRegistry.js';
 /**
  * WmsLayer layer for Cesium and OpenlayersMap
  * @class
- * @export
  * @extends {RasterLayer}
  * @api stable
  */

package/src/layer/wmtsLayer.js

@@ -60,7 +60,6 @@ function getMatrixIds(matrixIds, maxLevel, prefix) {
 /**
  * WmtsLayer layer
  * @class
- * @export
  * @extends {RasterLayer}
  * @api stable
  */

package/src/map/baseOLMap.js

@@ -36,7 +36,6 @@ export function ensureLayerInCollection(layers, layer, layerCollection) {
  * @class
  * @abstract
  * @api
- * @export
  * @extends {VcsMap}
  */
 class BaseOLMap extends VcsMap {

package/src/map/cameraLimiter.js

@@ -26,7 +26,6 @@ export const CameraLimiterMode = {
 /**
  * Can limit a Cesium.Cameras position based on absolute height or distance to a given terrain
  * @class
- * @export
  * @api
  */
 class CameraLimiter {

package/src/map/cesiumMap.js

@@ -202,7 +202,6 @@ ExperimentalFeatures.enableModelExperimental = false; // TODO check on release
 /**
  * Cesium Globe Map Class (3D map)
  * @class
- * @export
  * @extends {VcsMap}
  * @api stable
  */

package/src/map/mapState.js

@@ -2,7 +2,6 @@
  * The state of a map.
  * State machine: inactive <-> loading -> active -> inactive
  * @enum {number}
- * @export
  * @api
  * @property {number} INACTIVE
  * @property {number} ACTIVE

package/src/map/obliqueMap.js

@@ -76,7 +76,6 @@ export function getMercatorViewpointCenter(viewpoint) {
  * ObliqueMap Map Class (2D map with oblique imagery)
  *
  * @class
- * @export
  * @extends {BaseOLMap}
  * @api stable
  */

package/src/map/openlayersMap.js

@@ -18,7 +18,6 @@ import { mapClassRegistry } from '../classRegistry.js';
 /**
  * OpenlayersMap Map Class (2D map)
  * @class
- * @export
  * @extends {BaseOLMap}
  * @api stable
  */

package/src/map/vcsMap.js

@@ -504,13 +504,17 @@ class VcsMap extends VcsObject {
     this._collectionListeners.forEach((cb) => { cb(); });
     this._collectionListeners = [];
 
-    [...this.layerCollection].forEach((l) => { l.removedFromMap(this); });
+    if (this.layerCollection) {
+      [...this.layerCollection].forEach((l) => {
+        l.removedFromMap(this);
+      });
+    }
     if (this.stateChanged) {
       this.stateChanged.destroy();
       this.stateChanged = null;
     }
 
-    if (this.destroyLayerCollection) {
+    if (this.destroyLayerCollection && this.layerCollection) {
       this.layerCollection.destroy();
     }
 

package/src/oblique/helpers.js

@@ -80,7 +80,6 @@ function angleBetweenTwo2DVectors(v1, v2) {
  * @param {Array<import("ol/coordinate").Coordinate>} segment1
  * @param {Array<import("ol/coordinate").Coordinate>} segment2
  * @returns {{x: (number|null), y:(number|null), onLine1: boolean, onLine2: boolean}}
- * @export
  */
 export function checkLineIntersection(segment1, segment2) {
   // if the lines intersect, the result contains the x and y of the intersection (treating the lines as infinite) and booleans for whether line segment 1 or line segment 2 contain the point
@@ -306,7 +305,6 @@ export function transformCWIFC(inputOrigin, inputTarget, originIsImage, coordina
  * @param {import("ol/coordinate").Coordinate} worldCoordinate if not in web mercatpr, specify data-projection in options
  * @param {ImageTransformationOptions=} options
  * @returns {Promise<{coords: import("ol/coordinate").Coordinate, height: number, estimate: (boolean|undefined)}>}
- * @export
  */
 export function transformToImage(image, worldCoordinate, options = {}) {
   let gpInternalCoordinates;
@@ -404,7 +402,6 @@ function pickTerrain(pickTerrainOptions) {
  * @param {import("ol/coordinate").Coordinate} imageCoordinate
  * @param {ImageTransformationOptions=} options
  * @returns {Promise<PickTerrainReturn>} return coordinates are in mercator if not specified in options
- * @export
  */
 export async function transformFromImage(image, imageCoordinate, options = {}) {
   const initialWorldCoords = transform(

package/src/oblique/obliqueCollection.js

@@ -111,7 +111,6 @@ function getTileFeatures(tiles) {
 
 /**
  * @class
- * @export
  * @extends {VcsObject}
  */
 class ObliqueCollection extends VcsObject {

package/src/oblique/obliqueDataSet.js

@@ -18,7 +18,6 @@ import { requestJson } from '../util/fetch.js';
  * @property {number} PENDING
  * @property {number} LOADING
  * @property {number} READY
- * @export
  * @api
  */
 export const DataState = {
@@ -45,7 +44,6 @@ export function getStateFromStatesArray(states) {
 
 /**
  * @class
- * @export
  */
 class ObliqueDataSet {
   /**

package/src/oblique/obliqueImage.js

@@ -20,7 +20,6 @@ import { getHeightFromTerrainProvider } from '../layer/terrainHelpers.js';
 
 /**
  * @class
- * @export
  */
 class ObliqueImage {
   /**

package/src/oblique/obliqueImageMeta.js

@@ -20,7 +20,6 @@ import { cartesian2DDistance } from '../util/math.js';
 
 /**
  * @class
- * @export
  */
 class ObliqueImageMeta {
   /**

package/src/oblique/obliqueProvider.js

@@ -35,7 +35,6 @@ function withinBounds(number, max) {
 
 /**
  * @class
- * @export
  */
 class ObliqueProvider {
   /**

package/src/oblique/obliqueView.js

@@ -40,7 +40,6 @@ function getDefaultImage() {
 
 /**
  * @class
- * @export
  */
 class ObliqueView {
   /**

package/src/oblique/obliqueViewDirection.js

@@ -6,7 +6,6 @@
  * @property {number} SOUTH
  * @property {number} WEST
  * @property {number} NADIR
- * @export
  * @api
  */
 export const ObliqueViewDirection = {
@@ -19,7 +18,6 @@ export const ObliqueViewDirection = {
 
 /**
  * @type {Object<string, ObliqueViewDirection>}
- * @export
  */
 export const obliqueViewDirectionNames = {
   north: ObliqueViewDirection.NORTH,
@@ -32,7 +30,6 @@ export const obliqueViewDirectionNames = {
 /**
  * @param {number} direction
  * @returns {string|undefined}
- * @export
  */
 export function getDirectionName(direction) {
   return Object.keys(obliqueViewDirectionNames)

package/src/ol/render/canvas/canvasTileRenderer.js

@@ -8,7 +8,6 @@ import { transform2D } from 'ol/geom/flat/transform.js';
  * @class
  * @extends {CanvasImmediateRenderer}
  * @memberOf ol
- * @exports
  * Tile Renderer Implementation of openlayers CanvasImmediateRenderer
  * can be used to allow for a correction Factor to take into account Mercator Tile distortion
  */

package/src/style/declarativeStyleItem.js

@@ -94,7 +94,6 @@ function addCustomProperty(style, key, options) {
 /**
  * Style Object {@see https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/Styling}
  * @class
- * @export
  * @extends {StyleItem}
  * @api stable
  */

package/src/style/shapesCategory.js

@@ -6,7 +6,6 @@ import Circle from 'ol/style/Circle.js';
 /**
  * @param {VectorStyleItemImage} options
  * @returns {import("ol/style/RegularShape").default|import("ol/style/Circle").default}
- * @export
  */
 
 export function getShapeFromOptions(options) {
@@ -43,7 +42,6 @@ class ShapeCategory {
 }
 
 /**
- * @export
  * TODO refactor to getdefaultShapeCategory...
  */
 export const shapeCategory = new ShapeCategory();

package/src/style/styleHelpers.js

@@ -27,7 +27,6 @@ function getLogger() {
 /**
  * @enum {number}
  * @const
- * @export
  * @property {number} NWSE
  * @property {number} SWNE
  * @property {number} DIAGONALCROSS
@@ -50,7 +49,6 @@ export const PatternType = {
  * @param {string} h
  * @param {number=} opacity
  * @returns {import("ol/color").Color}
- * @export
  */
 export function hexToOlColor(h, opacity) {
   let hex = h.substring(1);
@@ -81,7 +79,6 @@ export function cesiumColorToColor(cesiumColor) {
  * @param {import("ol/color").Color} olColor
  * @returns {import("@vcmap/cesium").Color}
  * @api
- * @export
  */
 export function olColorToCesiumColor(olColor) {
   return Color.fromBytes(olColor[0], olColor[1], olColor[2], olColor[3] * 255);
@@ -93,7 +90,6 @@ export function olColorToCesiumColor(olColor) {
  * @param {import("ol/color").Color=} defaultColor
  * @returns {import("ol/color").Color}
  * @api
- * @export
  */
 export function parseColor(color, defaultColor) {
   if (Array.isArray(color)) {
@@ -135,7 +131,6 @@ export function parseColor(color, defaultColor) {
  * @param {import("ol/color").Color|import("ol/colorlike").ColorLike} color
  * @param {import("ol/color").Color} defaultColor
  * @returns {import("@vcmap/cesium").Color}
- * @export
  */
 export function getCesiumColor(color, defaultColor) {
   const olColor = parseColor(color, defaultColor);
@@ -145,7 +140,6 @@ export function getCesiumColor(color, defaultColor) {
 /**
  * @param {import("ol/color").Color|Array<number>|import("ol/colorlike").ColorLike} color
  * @returns {string}
- * @export
  */
 export function getStringColor(color) {
   return `rgba(${parseColor(color).join(',')})`;
@@ -155,7 +149,6 @@ export function getStringColor(color) {
  * @param {VectorStyleItemFill} options
  * @param {HTMLCanvasElement=} optCanvas
  * @returns {CanvasPattern}
- * @export
  */
 export function createPattern(options, optCanvas) {
   const pixelRatio = DEVICE_PIXEL_RATIO;
@@ -215,7 +208,6 @@ export function createPattern(options, optCanvas) {
 /**
  * @param {import("ol/color").Color} color
  * @returns {string}
- * @export
  */
 export function olColorToHex(color) {
   function componentHex(c) {
@@ -230,7 +222,6 @@ export function olColorToHex(color) {
 /**
  * @param {string} colorValue
  * @returns {boolean}
- * @export
  */
 export function validateHexColor(colorValue) {
   return /^#[0-9a-f]{6}$/.test(colorValue);
@@ -239,7 +230,6 @@ export function validateHexColor(colorValue) {
 /**
  * @param {string|FontObject} font
  * @returns {FontObject}
- * @export
  */
 export function parseFont(font) {
   if (typeof font !== 'string') {
@@ -310,7 +300,6 @@ export function parseFont(font) {
 /**
  * @param {FontObject} fontObject
  * @returns {string}
- * @export
  */
 export function combineFont(fontObject) {
   const order = [

package/src/style/styleItem.js

@@ -28,7 +28,6 @@ import { styleClassRegistry } from '../classRegistry.js';
 /**
  * An abstract style definition which can be applied to a layer
  * @class
- * @export
  * @api
  * @abstract
  * @extends {VcsObject}

package/src/style/vectorStyleItem.js

@@ -118,14 +118,12 @@ export const OlcsGeometryType = {
  * Is set by the Editor if the layerStyle is overwritten. The VectorLayer layer assures this style is set, if
  * the style on the layer is not a DeclarativeStyle
  * @type {symbol}
- * @export
  */
 export const vectorStyleSymbol = Symbol('VcsVectorStyleItem');
 
 /**
  * @class
  * @extends {StyleItem}
- * @export
  * @api
  */
 class VectorStyleItem extends StyleItem {
@@ -895,7 +893,6 @@ export default VectorStyleItem;
 
 /**
  * @type {VectorStyleItem}
- * @export
  */
 export const defaultVectorStyle = new VectorStyleItem(getDefaultVectorStyleItemOptions());
 styleClassRegistry.registerClass(VectorStyleItem.className, VectorStyleItem);
@@ -903,7 +900,6 @@ styleClassRegistry.registerClass(VectorStyleItem.className, VectorStyleItem);
 /**
  * @param {import("@vcmap/cesium").Color} cesiumColor
  * @returns {VectorStyleItem}
- * @export
  */
 export function fromCesiumColor(cesiumColor) {
   const color = /** @type {import("ol/color").Color} */ (cesiumColor.toBytes());

package/src/util/clipping/clippingObject.js

@@ -10,7 +10,6 @@ import LayerCollection from '../layerCollection.js';
 
 /**
  * @namespace clipping
- * @export
  * @api
  */
 
@@ -50,7 +49,6 @@ const globeSymbol = Symbol('ClippingObjectGlobe');
  * To update the Cesium.ClippingPlaneCollection or its definitions, you must trigger an update by setting the clippingPlaneCollection
  * property to the new definition.
  * @class
- * @export
  * @api stable
  */
 class ClippingObject {

package/src/util/clipping/clippingObjectManager.js

@@ -12,7 +12,6 @@ import CesiumMap from '../../map/cesiumMap.js';
  * overwritten in the order they where added to the manager. Exclusive [ClippingObjects]{@link ClippingObject} are always applied last, even
  * if a default [ClippingObject]{@link ClippingObject} is added after.
  * @class
- * @export
  * @api stable
  */
 class ClippingObjectManager {

package/src/util/clipping/clippingPlaneHelper.js

@@ -139,7 +139,6 @@ function createEndingPlanes(coords) {
  * @param {import("@vcmap/cesium").Matrix4=} transformMatrix - 4x4 matrix specifying the transform of clipping planes from Earth's fixed frame to another one
  * @returns {import("@vcmap/cesium").ClippingPlaneCollection|null}
  * @api stable
- * @export
  */
 export function createClippingPlaneCollection(feature, options = {}, transformMatrix) {
   check(feature, Feature);
@@ -203,7 +202,6 @@ export function createClippingPlaneCollection(feature, options = {}, transformMa
  * @param {import("@vcmap/cesium").Cartesian3=} originPoint - the origin point of the transformation target, so the plane distance can be set correctly
  * @returns {import("@vcmap/cesium").ClippingPlaneCollection}
  * @api stable
- * @export
  */
 export function copyClippingPlanesToCollection(source, result, transformMatrix, originPoint) {
   check(source, ClippingPlaneCollection);
@@ -346,7 +344,6 @@ export function setClippingPlanes(target, clippingPlaneCollection, local) {
  * @param {number} [offsetDistance=25] - the offset from the coordinate to use for the size of the geometry
  * @returns {import("ol").Feature<import("ol/geom/Geometry").default>} - the features geometry is in web mercator
  * @api
- * @export
  */
 export function createClippingFeature(coordinate, camera, vertical = false, offsetDistance = 25) {
   check(coordinate, [Number]);
@@ -389,7 +386,6 @@ export function createClippingFeature(coordinate, camera, vertical = false, offs
  * @param {boolean=} [infinite=false]
  * @returns {CreationOptions}
  * @api
- * @export
  */
 export function getClippingOptions(feature, infinite = false) {
   checkMaybe(feature, Feature);

package/src/util/collection.js

@@ -3,7 +3,6 @@ import VcsEvent from '../vcsEvent.js';
 /**
  * A generic array based collection. Implements the Symbol.iterator (e.g. [...collection])
  * @class
- * @export
  * @template {*} T
  * @api
  */
@@ -135,15 +134,28 @@ class Collection {
     return null;
   }
 
+  /**
+   * internal remove function, to remove an item from the collection, does not raise an event.
+   * @param {T} item
+   * @returns {number} returns the index of the removed item or -1 if the item has not been found.
+   * @protected
+   */
+  _remove(item) {
+    const index = this._array.indexOf(item);
+    if (index > -1) {
+      this._array.splice(index, 1);
+    }
+    return index;
+  }
+
   /**
    * Removes an item from the collection
    * @param {T} item
    * @api
    */
   remove(item) {
-    const index = this._array.indexOf(item);
+    const index = this._remove(item);
     if (index > -1) {
-      this._array.splice(index, 1);
       this.removed.raiseEvent(item);
     }
   }

package/src/util/extent.js

@@ -33,7 +33,6 @@ function checkExtentValidity(extent) {
 /**
  * Extent Class
  * @class
- * @export
  * @api
  */
 class Extent {

package/src/util/indexedCollection.js

@@ -4,7 +4,6 @@ import Collection from './collection.js';
 /**
  * A generic array based collection. Implements the Symbol.iterator (e.g. [...collection])
  * @class
- * @export
  * @template {*} T
  * @extends {Collection<T>}
  * @api