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

package/index.d.ts

@@ -677,7 +677,7 @@ export class InteractionChain extends AbstractInteraction {
 }
 
 /**
- * Provides inforamtion to other interaction plugins for creating bitmasks
+ * Provides information to other interaction plugins for creating bitmasks
  */
 export class BitCounter {
     static interactionTypeCounter: any;
@@ -6242,6 +6242,9 @@ export const defaultDeclarativeStyle: DeclarativeStyleItem;
 
 export function getShapeFromOptions(options: VectorStyleItemImage): import("ol/style/RegularShape").default | import("ol/style/Circle").default;
 
+/**
+ * TODO refactor to getdefaultShapeCategory...
+ */
 export const shapeCategory: any;
 
 export function getStyleOrDefaultStyle(styleOptions?: DeclarativeStyleItemOptions | VectorStyleItemOptions | StyleItem, defaultStyle?: StyleItem): StyleItem;
@@ -6751,6 +6754,11 @@ export class Collection<T extends any> {
      * @returns the index at which the item was inserted
      */
     add(item: T): number | null;
+    /**
+     * internal remove function, to remove an item from the collection, does not raise an event.
+     * @returns returns the index of the removed item or -1 if the item has not been found.
+     */
+    protected _remove(item: T): number;
     /**
      * Removes an item from the collection
      */
@@ -7031,10 +7039,7 @@ export class LayerCollection extends IndexedCollection<Layer> {
      * @returns returns the layer index or null, if the layers name is not unique
      */
     add(layer: Layer, index?: number): number | null;
-    /**
-     * Removes a layer from the collection.
-     */
-    remove(layer: Layer): void;
+    protected _remove(layer: Layer): number;
 }
 
 export function getLocaleChangedEvent(): VcsEvent<string>;
@@ -7102,11 +7107,7 @@ export class MapCollection extends Collection<VcsMap> {
      * It will add map event listeners and pass them to the event handler of this collection.
      */
     add(map: VcsMap): number | null;
-    /**
-     * Removes the map from the collection. Will also set _splitScreen & target to null and an empty _layerCollection on the map,
-     * if the map is currently part of the collection.
-     */
-    remove(map: VcsMap): void;
+    protected _remove(map: VcsMap): number;
     /**
      * Set the target for these maps.
      */
@@ -7157,7 +7158,7 @@ export const isOverrideCollection: symbol;
 /**
  * @param getDynamicContextId - function to get the current dynamic context id
  * @param [serializeItem] - optional function to serialize an item, defaults to returning item.toJSON or item: i => (i.toJSON || i)
- * @param [deserializeItem] - optional desirialization function. defaults to returning the passed object: i => i
+ * @param [deserializeItem] - optional deserialization function. defaults to returning the passed object: i => i
  * @param [ctor] - optional constructor to validate deserialized items against. if passed, deserializeItem must be an instance of ctor.
  * @param [determineShadowIndex] - return the index where a shadow should be inserted. only has relevance, if the collection is indexed. previous and current index may be null.
  */
@@ -7194,7 +7195,13 @@ export interface ProjectionOptions {
 export function setDefaultProjectionOptions(options: ProjectionOptions): void;
 
 /**
- * Projection Class, if no valid options are given, the Projection will initialize with the Framework default Projection
+ * For example:
+ *     <pre><code>
+ *         {
+ *          "epsg" : "EPSG:25833"
+ *          "proj4" : "+proj=utm +zone=33 +ellps=GRS80 +units=m +no_defs"
+ *         }
+ *     </code></pre>
  */
 export class Projection {
     constructor(options: ProjectionOptions);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/core",
-  "version": "5.0.0-rc.10",
+  "version": "5.0.0-rc.11",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -13,6 +13,7 @@
     "postinstall": "node build/postinstall.js",
     "coverage": "c8 --reporter text-summary npm run test",
     "coverage:gitlab": "c8 --reporter text-summary npm run test -- --reporter mocha-junit-reporter",
+    "build-docs": "jsdoc -c build/docs/conf.json",
     "build-index": "jsdoc -c build/index/conf.json",
     "build-typedefs": "jsdoc -c build/info/conf.json",
     "build-tsd": "node build/buildDTs.js",
@@ -25,6 +26,8 @@
   "files": [
     "build/postinstall.js",
     "src/",
+    "tests/data/",
+    "tests/unit/helpers/",
     "LICENSE.md",
     "README.md",
     "index.js",
@@ -49,10 +52,11 @@
     "node-fetch": "^3.2.0",
     "sinon": "^9.2.4",
     "sinon-chai": "^3.6.0",
+    "tui-jsdoc-template": "^1.2.2",
     "typescript": "^4.6.2"
   },
   "peerDependencies": {
-    "@vcmap/cesium": "^1.92.1",
+    "@vcmap/cesium": "~1.93.1",
     "ol": "~6.13.0"
   },
   "eslintConfig": {

package/src/classRegistry.js

@@ -104,32 +104,26 @@ class ClassRegistry {
 export default ClassRegistry;
 
 /**
- * @export
  * @type {ClassRegistry<import("@vcmap/core").Layer>}
  */
 export const layerClassRegistry = new ClassRegistry();
 /**
- * @export
  * @type {ClassRegistry<import("@vcmap/core").TileProvider>}
  */
 export const tileProviderClassRegistry = new ClassRegistry();
 /**
- * @export
  * @type {ClassRegistry<import("@vcmap/core").AbstractFeatureProvider>}
  */
 export const featureProviderClassRegistry = new ClassRegistry();
 /**
- * @export
  * @type {ClassRegistry<import("@vcmap/core").VcsMap>}
  */
 export const mapClassRegistry = new ClassRegistry();
 /**
- * @export
  * @type {ClassRegistry<import("@vcmap/core").StyleItem>}
  */
 export const styleClassRegistry = new ClassRegistry();
 /**
- * @export
  * @type {ClassRegistry<import("@vcmap/core").Category<*>>}
  */
 export const categoryClassRegistry = new ClassRegistry();

package/src/context.js

@@ -21,7 +21,6 @@ const uuidNamespace = uuidv4();
 
 /**
  * @class
- * @export
  */
 class Context {
   /**

package/src/featureProvider/abstractFeatureProvider.js

@@ -24,7 +24,6 @@ import { isProvidedFeature, showProvidedFeature } from './featureProviderSymbols
  * An abstract class providing features for {@link Layer}s which cannot provide features directly, but can provide features for
  * a given location, e.g. WmsLayer with a getFeatureInfo configuration. In this case, a feature provider can be created for this layer.
  * @class
- * @export
  * @abstract
  * @api
  */

package/src/featureProvider/wmsFeatureProvider.js

@@ -68,7 +68,6 @@ export function getFormat(responseType, options = {}) {
 
 /**
  * @class
- * @export
  * @extends {AbstractFeatureProvider}
  */
 class WMSFeatureProvider extends AbstractFeatureProvider {

package/src/interaction/abstractInteraction.js

@@ -22,7 +22,6 @@ import { EventType, ModificationKeyType, PointerKeyType } from './interactionTyp
 /**
  * An abstract interface for all interactions
  * @class
- * @export
  * @abstract
  * @api
  */

package/src/interaction/interactionChain.js

@@ -4,7 +4,6 @@ import { EventType, ModificationKeyType, PointerKeyType } from './interactionTyp
 /**
  * @class
  * @extends {AbstractInteraction}
- * @export
  */
 class InteractionChain extends AbstractInteraction {
   /**

package/src/interaction/interactionType.js

@@ -1,9 +1,8 @@
 let nextBit = 1;
 
 /**
- * Provides inforamtion to other interaction plugins for creating bitmasks
+ * Provides information to other interaction plugins for creating bitmasks
  * @class
- * @export
  */
 export class BitCounter {
   /**
@@ -19,7 +18,6 @@ export class BitCounter {
 /**
  * Enumeration of modification key types
  * @enum {number}
- * @export
  * @property {number} NONE
  * @property {number} ALT
  * @property {number} CTRL
@@ -53,7 +51,6 @@ ModificationKeyType.ALL = ModificationKeyType.NONE |
  * @property {number} DRAGEVENTS
  * @property {number} CLICKMOVE
  * @property {number} ALL
- * @export
  * @api
  */
 export const EventType = {
@@ -85,7 +82,6 @@ EventType.ALL = Object.values(EventType)
  * @property {number} RIGHT
  * @property {number} MIDDLE
  * @property {number} ALL
- * @export
  * @api
  */
 export const PointerKeyType = {

package/src/layer/cesium/cesiumTilesetCesiumImpl.js

@@ -59,7 +59,6 @@ export function getExtentFromTileset(cesium3DTileset) {
 /**
  * represents the cesium implementation for a {@link CesiumTileset} layer.
  * @class
- * @export
  * @extends {LayerImplementation<import("@vcmap/core").CesiumMap>}}
  * @implements {FeatureLayerImplementation}
  * @api stable

package/src/layer/cesium/dataSourceCesiumImpl.js

@@ -25,7 +25,6 @@ function synchronizeEntityCollections(source, destination) {
 
 /**
  * @class
- * @export
  * @extends {LayerImplementation<import("@vcmap/core").CesiumMap>}}
  */
 class DataSourceCesiumImpl extends LayerImplementation {

package/src/layer/cesium/openStreetMapCesiumImpl.js

@@ -4,7 +4,6 @@ import RasterLayerCesiumImpl from './rasterLayerCesiumImpl.js';
 /**
  * represents a specific OpenStreetMapLayer layer for cesium.
  * @class
- * @export
  * @extends {RasterLayerCesiumImpl}
  */
 class OpenStreetMapCesiumImpl extends RasterLayerCesiumImpl {

package/src/layer/cesium/rasterLayerCesiumImpl.js

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

package/src/layer/cesium/singleImageCesiumImpl.js

@@ -5,7 +5,6 @@ import { wgs84Projection } from '../../util/projection.js';
 /**
  * represents a specific Cesium SingleTileImagery Layer class.
  * @class
- * @export
  * @extends {RasterLayerCesiumImpl}
  */
 class SingleImageCesiumImpl extends RasterLayerCesiumImpl {

package/src/layer/cesium/terrainCesiumImpl.js

@@ -6,7 +6,6 @@ import { getTerrainProviderForUrl } from '../terrainHelpers.js';
 /**
  * TerrainLayer implementation for {@link CesiumMap}
  * @class
- * @export
  * @extends {LayerImplementation<import("@vcmap/core").CesiumMap>}}
  */
 class TerrainCesiumImpl extends LayerImplementation {

package/src/layer/cesium/tmsCesiumImpl.js

@@ -6,7 +6,6 @@ import { TilingScheme } from '../rasterLayer.js';
 /**
  * TmsLayer implementation for {@link CesiumMap}.
  * @class
- * @export
  * @extends {RasterLayerCesiumImpl}
  */
 class TmsCesiumImpl extends RasterLayerCesiumImpl {

package/src/layer/cesium/vectorCesiumImpl.js

@@ -11,7 +11,6 @@ import { synchronizeFeatureVisibilityWithSource } from '../vectorHelpers.js';
 /**
  * represents a specific vector layer for cesium.
  * @class
- * @export
  * @extends {LayerImplementation<import("@vcmap/core").CesiumMap>}}
  * @implements {FeatureLayerImplementation}
  */

package/src/layer/cesium/vectorRasterTileCesiumImpl.js

@@ -6,7 +6,6 @@ import { wgs84Projection } from '../../util/projection.js';
 /**
  * represents a rasterized tiled vector layer implementation for cesium.
  * @class
- * @export
  * @extends {RasterLayerCesiumImpl}
  * @implements {VectorTileImplementation}
  */

package/src/layer/cesium/vectorTileImageryProvider.js

@@ -64,7 +64,6 @@ export function getCanvasFromFeatures(features, extent, center, tileSize) {
 /**
  * implementation of Cesium ImageryProvider Interface
  * @class
- * @export
  */
 class VectorTileImageryProvider {
   /**

package/src/layer/cesium/wmsCesiumImpl.js

@@ -6,7 +6,6 @@ import { wgs84Projection } from '../../util/projection.js';
 /**
  * represents a specific Cesium WmsCesiumImpl Layer class.
  * @class
- * @export
  * @extends {RasterLayerCesiumImpl}
  */
 class WmsCesiumImpl extends RasterLayerCesiumImpl {

package/src/layer/cesium/wmtsCesiumImpl.js

@@ -6,7 +6,6 @@ import { getTilingScheme } from '../rasterLayer.js';
 /**
  * represents a specific WmtsLayer Implementation for {@link CesiumMap}.
  * @class
- * @export
  * @extends {RasterLayerCesiumImpl}
  */
 class WmtsCesiumImpl extends RasterLayerCesiumImpl {

package/src/layer/cesiumTilesetLayer.js

@@ -49,7 +49,6 @@ import { layerClassRegistry } from '../classRegistry.js';
  * @extends {FeatureLayer}
  * @implements {SplitLayer}
  * @api stable
- * @export
  */
 class CesiumTilesetLayer extends FeatureLayer {
   /** @type {string} */

package/src/layer/czmlLayer.js

@@ -12,7 +12,6 @@ import { layerClassRegistry } from '../classRegistry.js';
 
 /**
  * @class
- * @export
  * @extends {DataSourceLayer}
  */
 class CzmlLayer extends DataSourceLayer {

package/src/layer/dataSourceLayer.js

@@ -30,7 +30,6 @@ import { layerClassRegistry } from '../classRegistry.js';
 /**
  * Represents a layer of Cesium.Entity
  * @class
- * @export
  * @extends {Layer}
  * @api stable
  */

package/src/layer/featureLayer.js

@@ -44,7 +44,6 @@ import { layerClassRegistry } from '../classRegistry.js';
  * @class
  * @abstract
  * @extends {Layer}
- * @export
  * @api
  */
 class FeatureLayer extends Layer {

package/src/layer/featureStoreLayer.js

@@ -76,7 +76,6 @@ export const isTiledFeature = Symbol('isTiledFeature');
 /**
  * FeatureStoreLayer Layer
  * @class
- * @export
  * @extends {VectorLayer}
  * @api
  */

package/src/layer/featureStoreLayerState.js

@@ -10,7 +10,6 @@ export const featureStoreStateSymbol = Symbol('vcsFeatureType');
  * @property {string} STATIC
  * @property {string} EDITED
  * @api
- * @export
  */
 export const FeatureStoreLayerState = {
   DYNAMIC: 'dynamic',

package/src/layer/featureVisibility.js

@@ -181,7 +181,6 @@ export function showFeature(feature, symbol) {
 /**
  * Enumeration of feature visibility actions.
  * @enum {number}
- * @export
  * @api
  * @property {number} HIGHLIGHT
  * @property {number} UNHIGHLIGHT

package/src/layer/geojsonHelpers.js

@@ -74,7 +74,6 @@ function getFormat() {
 /**
  * @param {Object} geojson
  * @returns {string|null}
- * @export
  */
 export function getEPSGCodeFromGeojson(geojson) {
   const { crs } = geojson;
@@ -95,7 +94,6 @@ export function getEPSGCodeFromGeojson(geojson) {
 /**
  * updates legacy features to the new olcesium namespaceing olcs_
  * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
- * @export
  */
 export function updateLegacyFeature(feature) {
   // these changes can be done silently, because the features haven't been added to any layer
@@ -283,7 +281,6 @@ function readFeature(featureObj, options) {
  * @param {GeoJSONreadOptions=} readOptions
  * @returns {GeoJSONData}
  * @throws SyntaxError
- * @export
  * @api
  */
 export function parseGeoJSON(input, readOptions = {}) {
@@ -412,7 +409,6 @@ export function writeGeoJSONFeature(feature, options = {}, embeddedIcons) {
  * @param {GeoJSONData} data
  * @param {GeoJSONwriteOptions=} options
  * @returns {string|Object}
- * @export
  */
 export function writeGeoJSON(data, options = {}) { // how to handel embedded icons when they are not set on the vcsMeta but options is true?
   const vcsMeta = data.vcsMeta || {};

package/src/layer/geojsonLayer.js

@@ -20,7 +20,6 @@ export const featureFromOptions = Symbol('featureFromOptions');
 /**
  * GeojsonLayer layer for Cesium, OpenlayersMap and ObliqueMap
  * @class
- * @export
  * @extends {VectorLayer}
  * @api stable
  */

package/src/layer/globalHider.js

@@ -134,7 +134,6 @@ class GlobalHider {
 
 /**
  * @returns {GlobalHider}
- * @export
  * @api
  */
 export function getGlobalHider() {

package/src/layer/layer.js

@@ -100,7 +100,6 @@ export const vcsMetaVersion = '2.0';
  * To receive implementation options, implement `geImplementationOptions`
  * @abstract
  * @class
- * @export
  * @extends {VcsObject}
  * @api stable
  */

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

@@ -19,7 +19,6 @@ import { synchronizeFeatureVisibilityWithSource } from '../vectorHelpers.js';
 /**
  * represents a specific vector layer for oblique.
  * @class
- * @export
  * @extends {LayerObliqueImpl}
  * @implements {FeatureLayerImplementation}
  */

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

@@ -6,7 +6,6 @@ import { getGlobalHider } from '../globalHider.js';
 /**
  * represents a specific vectorlayer for openlayers.
  * @class
- * @export
  * @implements {FeatureLayerImplementation}
  * @extends {LayerOpenlayersImpl}
  */

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 {

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

@@ -75,7 +75,6 @@ export function rectangleToExtent(rectangle) {
  *
  * @class
  * @extends {VcsObject}
- * @export
  * @api
  */
 class TileProvider extends VcsObject {