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

package/index.d.ts

@@ -20,7 +20,7 @@ export interface CategoryOptions extends VcsObjectOptions {
     /**
      * the class registry name on the current app to provide classes for this category. if provided, parseItems will deserialize using this class registry. See: {@link getObjectFromClassRegistry}.
     */
-    classRegistryName?: string;
+    classRegistryName?: string | symbol;
     featureProperty?: string | undefined;
     layerOptions?: VectorOptions;
     /**
@@ -44,11 +44,15 @@ export class Category<T extends Object|VcsObject> extends VcsObject {
     };
     protected _app: VcsApp;
     protected _layer: VectorLayer;
-    readonly classRegistryName: string;
+    readonly classRegistryName: string | symbol;
     /**
      * The collection of this category.
      */
     readonly collection: OverrideCollection<T>;
+    /**
+     * Event raised if the collection is reset
+     */
+    readonly collectionChanged: VcsEvent<void>;
     /**
      * Returns the layer of this collection. Caution, do not use the layer API to add or remove items.
      * When adding items to the collection, the features are added to the layer async (timeout of 0), since there is weird behavior
@@ -65,7 +69,7 @@ export class Category<T extends Object|VcsObject> extends VcsObject {
      */
     mergeOptions(options: CategoryOptions): void;
     /**
-     * When setting the category, it MUST use the same unqiueKey as the previous collection (default is "name").
+     * When setting the category, it MUST use the same uniqueKey as the previous collection (default is "name").
      * All items in the current collection _will be destroyed_ and the current collection will be destroyed. The category will take
      * complete ownership of the collection and destroy it once the category is destroyed. The collection will
      * be turned into an {@see OverrideCollection}.
@@ -749,6 +753,7 @@ export class CesiumTilesetCesiumImpl extends LayerImplementation<CesiumMap> impl
     splitDirection: import("@vcmap/cesium").SplitDirection;
     style: StyleItem;
     featureVisibility: FeatureVisibility;
+    globalHider: GlobalHider;
     tilesetProperties: CesiumTilesetTilesetProperties[];
     modelMatrix: import("@vcmap/cesium").Matrix4;
     offset: import("ol/coordinate").Coordinate;
@@ -878,6 +883,7 @@ export class VectorCesiumImpl extends LayerImplementation<CesiumMap> implements
     featureVisibility: FeatureVisibility;
 
     protected _context: VectorContext | ClusterContext | null;
+    globalHider: GlobalHider;
     protected _setupContext(cesiumMap: CesiumMap): Promise<void>;
     initialize(): Promise<void>;
     /**
@@ -1151,15 +1157,10 @@ export class CesiumTilesetLayer extends FeatureLayer implements SplitLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -1181,6 +1182,8 @@ export class CesiumTilesetLayer extends FeatureLayer implements SplitLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -1242,15 +1245,10 @@ export class CzmlLayer extends DataSourceLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -1272,6 +1270,8 @@ export class CzmlLayer extends DataSourceLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -1358,15 +1358,10 @@ export class DataSourceLayer extends Layer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -1388,6 +1383,8 @@ export class DataSourceLayer extends Layer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -1421,6 +1418,7 @@ export interface FeatureLayerOptions extends LayerOptions {
 }
 
 export interface FeatureLayerImplementationOptions extends LayerImplementationOptions {
+    globalHider: GlobalHider;
     featureVisibility: FeatureVisibility;
     style: StyleItem;
 }
@@ -1500,15 +1498,10 @@ export class FeatureLayer extends Layer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -1530,6 +1523,8 @@ export class FeatureLayer extends Layer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -1717,15 +1712,10 @@ export class FeatureStoreLayer extends VectorLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -1746,6 +1736,8 @@ export class FeatureStoreLayer extends VectorLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -1904,6 +1896,11 @@ export const enum FeatureVisibilityAction {
 
 export function synchronizeFeatureVisibility(source: FeatureVisibility, destination: FeatureVisibility): (...params: any[]) => any;
 
+/**
+ * FeatureVisibility handles the visibility and highlighting of features of a specific {@link FeatureLayer} or {@link DataSourceLayer}
+ * and its {@link FeatureLayerImplementation} resp. {@link DataSourceCesiumImpl}.
+ * The visibility is being synchronized with the {@link GlobalHider}.
+ */
 export class FeatureVisibility {
     hiddenObjects: {
         [key: string]: Set<import("@vcmap/cesium").Cesium3DTileFeature | import("ol").Feature<import("ol/geom/Geometry").default> | import("@vcmap/cesium").Entity>;
@@ -2121,15 +2118,10 @@ export class GeoJSONLayer extends VectorLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -2150,6 +2142,8 @@ export class GeoJSONLayer extends VectorLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -2167,6 +2161,17 @@ export class GeoJSONLayer extends VectorLayer {
     readonly className: string;
 }
 
+export interface HiddenObject {
+    id: string;
+}
+
+/**
+ * GlobalHider globally hides features existing within a layer of a {@link LayerCollection}.
+ * Features can be defined as hidden by {@link VcsAppConfig} or {@link LayerOptions}.
+ * Hiding will be performed, when a {@link Context} is loaded, a {@link Layer} is activated or GlobalHider API is called.
+ * A feature can be hidden multiple times by different actors, e.g. contexts, layers, which is handled by this class.
+ * A feature will be shown again, when a {@link Context} is removed, a {@link Layer} is deactivated or GlobalHider API is called.
+ */
 export class GlobalHider {
     hiddenObjects: {
         [key: string]: number;
@@ -2189,8 +2194,6 @@ export class GlobalHider {
     hasFeature(uuid: string | number, feature: import("ol").Feature<import("ol/geom/Geometry").default> | import("@vcmap/cesium").Cesium3DTileFeature | import("@vcmap/cesium").Cesium3DTilePointFeature | import("@vcmap/cesium").Entity): boolean;
 }
 
-export function getGlobalHider(): GlobalHider;
-
 export interface GenericFeature {
     longitude: number;
     latitude: number;
@@ -2315,15 +2318,10 @@ export class Layer extends VcsObject {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -2342,6 +2340,9 @@ export class Layer extends VcsObject {
     readonly state: LayerState;
     allowPicking: any;
     url: any;
+    hiddenObjectIds: any;
+    readonly globalHider: GlobalHider | null;
+    setGlobalHider(globalHider: GlobalHider): void;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -2612,15 +2613,10 @@ export class OpenStreetMapLayer extends Layer implements SplitLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -2642,6 +2638,8 @@ export class OpenStreetMapLayer extends Layer implements SplitLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -2753,6 +2751,7 @@ export class VectorOpenlayersImpl extends LayerOpenlayersImpl implements Feature
     minResolution: number;
     featureVisibility: FeatureVisibility;
     olLayer: import("ol/layer/Vector").default<import("ol/source").Vector<import("ol/geom/Geometry").default>> | null;
+    globalHider: GlobalHider;
     updateStyle(style: StyleItem, silent?: boolean): void;
     setVisibility(visibility: boolean): void;
 }
@@ -2921,15 +2920,10 @@ export class PointCloudLayer extends CesiumTilesetLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -2951,6 +2945,8 @@ export class PointCloudLayer extends CesiumTilesetLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -3065,15 +3061,10 @@ export class RasterLayer extends Layer implements SplitLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -3095,6 +3086,8 @@ export class RasterLayer extends Layer implements SplitLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -3176,15 +3169,10 @@ export class SingleImageLayer extends RasterLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -3206,6 +3194,8 @@ export class SingleImageLayer extends RasterLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -3294,15 +3284,10 @@ export class TerrainLayer extends Layer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -3324,6 +3309,8 @@ export class TerrainLayer extends Layer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -3742,15 +3729,10 @@ export class TMSLayer extends RasterLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -3772,6 +3754,8 @@ export class TMSLayer extends RasterLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -4001,15 +3985,10 @@ export class VectorLayer extends FeatureLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -4030,6 +4009,8 @@ export class VectorLayer extends FeatureLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -4365,15 +4346,10 @@ export class VectorTileLayer extends FeatureLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -4395,6 +4371,8 @@ export class VectorTileLayer extends FeatureLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -4511,15 +4489,10 @@ export class WFSLayer extends VectorLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -4540,6 +4513,8 @@ export class WFSLayer extends VectorLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -4675,15 +4650,10 @@ export class WMSLayer extends RasterLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -4705,6 +4675,8 @@ export class WMSLayer extends RasterLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -4803,15 +4775,10 @@ export class WMTSLayer extends RasterLayer {
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
     zIndexChanged: VcsEvent<number>;
-    /**
-     * array of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
-     */
-    hiddenObjectIds: string[];
     /**
      * event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
      */
     exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>;
-    globalHider: GlobalHider;
     copyright: CopyrightOptions | undefined;
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -4833,6 +4800,8 @@ export class WMTSLayer extends RasterLayer {
      * A layers url, should on be configured, else an empty string
      */
     url: string;
+    hiddenObjectIds: string[];
+    readonly globalHider: GlobalHider | null;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
      */
@@ -7034,6 +7003,10 @@ export class LayerCollection extends IndexedCollection<Layer> {
      * ensures consistency by setting a new local z index if needed.
      */
     readonly zIndexSymbol: symbol;
+    /**
+     * Set global hider for these maps.
+     */
+    globalHider: any;
     /**
      * Adds a layer to the collection. Can optionally be passed an index at which to insert the layer.
      * @returns returns the layer index or null, if the layers name is not unique

package/index.js

@@ -48,7 +48,7 @@ export { featureStoreStateSymbol, FeatureStoreLayerState } from './src/layer/fea
 export { originalStyle, highlighted, hidden, globalHidden, featureExists, FeatureVisibilityAction, synchronizeFeatureVisibility, default as FeatureVisibility } from './src/layer/featureVisibility.js';
 export { getEPSGCodeFromGeojson, updateLegacyFeature, parseGeoJSON, writeGeoJSONFeature, writeGeoJSON } from './src/layer/geojsonHelpers.js';
 export { featureFromOptions, default as GeoJSONLayer } from './src/layer/geojsonLayer.js';
-export { getGlobalHider, default as GlobalHider } from './src/layer/globalHider.js';
+export { default as GlobalHider } from './src/layer/globalHider.js';
 export { vcsMetaVersion, default as Layer } from './src/layer/layer.js';
 export { default as LayerImplementation } from './src/layer/layerImplementation.js';
 export { default as LayerState } from './src/layer/layerState.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/core",
-  "version": "5.0.0-rc.11",
+  "version": "5.0.0-rc.12",
   "description": "",
   "main": "index.js",
   "type": "module",

package/src/category/category.js

@@ -11,11 +11,12 @@ import Collection from '../util/collection.js';
 import { getStyleOrDefaultStyle } from '../style/styleFactory.js';
 import { categoryClassRegistry, getObjectFromClassRegistry } from '../classRegistry.js';
 import OverrideClassRegistry from '../overrideClassRegistry.js';
+import VcsEvent from '../vcsEvent.js';
 
 /**
  * @typedef {VcsObjectOptions} CategoryOptions
  * @property {string|Object<string, string>} [title]
- * @property {string} [classRegistryName=''] - the class registry name on the current app to provide classes for this category. if provided, parseItems will deserialize using this class registry. See: {@link getObjectFromClassRegistry}.
+ * @property {string|symbol} [classRegistryName] - the class registry name on the current app to provide classes for this category. if provided, parseItems will deserialize using this class registry. See: {@link getObjectFromClassRegistry}.
  * @property {string|undefined} [featureProperty]
  * @property {VectorOptions} [layerOptions={}]
  * @property {Array<Object>} [items] - items are not evaluated by the constructor but passed to parseItem during deserialization.
@@ -56,7 +57,7 @@ function assignLayerOptions(layer, options) {
  * @param {T} value
  * @param {T} defaultOption
  * @param {T=} option
- * @template {number|boolean|string} T
+ * @template {number|boolean|string|symbol} T
  * @returns {void}
  */
 function checkMergeOptionOverride(key, value, defaultOption, option) {
@@ -113,7 +114,7 @@ class Category extends VcsObject {
      */
     this._featureProperty = options.featureProperty || defaultOptions.featureProperty;
     /**
-     * @type {string}
+     * @type {string|symbol}
      * @private
      */
     this._classRegistryName = options.classRegistryName;
@@ -136,6 +137,12 @@ class Category extends VcsObject {
      * @private
      */
     this._keyProperty = options.keyProperty || defaultOptions.keyProperty;
+    /**
+     * Event raised if the collection is reset
+     * @type {VcsEvent<void>}
+     * @private
+     */
+    this._collectionChanged = new VcsEvent();
     /**
      * @type {Array<function():void>}
      * @private
@@ -155,7 +162,7 @@ class Category extends VcsObject {
   }
 
   /**
-   * @type {string}
+   * @type {string|symbol}
    * @readonly
    */
   get classRegistryName() { return this._classRegistryName; }
@@ -169,6 +176,13 @@ class Category extends VcsObject {
     return this._collection;
   }
 
+  /**
+   * Event raised if the collection is reset
+   * @type {VcsEvent<void>}
+   * @readonly
+   */
+  get collectionChanged() { return this._collectionChanged; }
+
   /**
    * Returns the layer of this collection. Caution, do not use the layer API to add or remove items.
    * When adding items to the collection, the features are added to the layer async (timeout of 0), since there is weird behavior
@@ -268,7 +282,7 @@ class Category extends VcsObject {
   }
 
   /**
-   * When setting the category, it MUST use the same unqiueKey as the previous collection (default is "name").
+   * When setting the category, it MUST use the same uniqueKey as the previous collection (default is "name").
    * All items in the current collection _will be destroyed_ and the current collection will be destroyed. The category will take
    * complete ownership of the collection and destroy it once the category is destroyed. The collection will
    * be turned into an {@see OverrideCollection}.
@@ -314,6 +328,7 @@ class Category extends VcsObject {
       // @ts-ignore
       this._collectionListeners.push(this._collection.moved.addEventListener(this._itemMoved.bind(this)));
     }
+    this.collectionChanged.raiseEvent();
   }
 
   /**
@@ -393,6 +408,7 @@ class Category extends VcsObject {
     this._contextRemovedListener();
     this._contextRemovedListener = () => {};
     destroyCollection(this._collection);
+    this._collectionChanged.destroy();
     this._app = null;
   }
 }

package/src/layer/cesium/cesiumTilesetCesiumImpl.js

@@ -11,7 +11,6 @@ import {
 import { createEmpty } from 'ol/extent.js';
 import LayerImplementation from '../layerImplementation.js';
 import { vcsLayerName } from '../layerSymbols.js';
-import { getGlobalHider } from '../globalHider.js';
 import { originalStyle, updateOriginalStyle } from '../featureVisibility.js';
 import Projection from '../../util/projection.js';
 import { circleFromCenterRadius } from '../../util/geometryHelpers.js';
@@ -84,6 +83,8 @@ class CesiumTilesetCesiumImpl extends LayerImplementation {
     this.style = options.style;
     /** @type {import("@vcmap/core").FeatureVisibility} */
     this.featureVisibility = options.featureVisibility;
+    /** @type {import("@vcmap/core").GlobalHider} */
+    this.globalHider = options.globalHider;
     /** @type {Array<CesiumTilesetTilesetProperties>} */
     this.tilesetProperties = options.tilesetProperties;
     /** @type {import("@vcmap/cesium").Matrix4} */
@@ -105,7 +106,6 @@ class CesiumTilesetCesiumImpl extends LayerImplementation {
      * @private
      */
     this._styleLastUpdated = Date.now();
-    this.globalHider = getGlobalHider();
   }
 
   /**

package/src/layer/cesium/vectorCesiumImpl.js

@@ -5,7 +5,6 @@ import convert from '../../util/featureconverter/convert.js';
 import VectorContext from './vectorContext.js';
 import { vcsLayerName } from '../layerSymbols.js';
 import LayerImplementation from '../layerImplementation.js';
-import { getGlobalHider } from '../globalHider.js';
 import { synchronizeFeatureVisibilityWithSource } from '../vectorHelpers.js';
 
 /**
@@ -71,7 +70,8 @@ class VectorCesiumImpl extends LayerImplementation {
      * @private
      */
     this._scene = null;
-    this.globalHider = getGlobalHider();
+    /** @type {import("@vcmap/core").GlobalHider} */
+    this.globalHider = options.globalHider;
   }
 
   /**
@@ -115,9 +115,9 @@ class VectorCesiumImpl extends LayerImplementation {
   async initialize() {
     if (!this.initialized) {
       this._scene = this.map.getScene();
-      await this._setupContext(this.map);
       this._addListeners();
       this._addFeatures(this.source.getFeatures());
+      await this._setupContext(this.map);
     }
     await super.initialize();
   }

package/src/layer/dataSourceLayer.js

@@ -4,7 +4,6 @@ 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 { layerClassRegistry } from '../classRegistry.js';
 
 /**
@@ -85,12 +84,21 @@ class DataSourceLayer extends Layer {
     ];
   }
 
+  /**
+   * @param {import("@vcmap/core").GlobalHider} globalHider
+   */
+  setGlobalHider(globalHider) {
+    super.setGlobalHider(globalHider);
+    this._setUpFeatureVisibility();
+  }
+
   /**
    * Sets up listeners for featureVisibility and global hider
    * @private
    */
   _setUpFeatureVisibility() {
-    const globalHider = getGlobalHider();
+    this._featureVisibilityListeners.forEach((cb) => { cb(); });
+
     this._featureVisibilityListeners = [
       this.featureVisibility.changed.addEventListener(({ action, ids }) => {
         if (action === FeatureVisibilityAction.HIDE) {
@@ -102,28 +110,30 @@ class DataSourceLayer extends Layer {
           });
         } // highlight is _possible_ but very tricky with all the possible entity values with potential materials
       }),
-      globalHider.changed.addEventListener(({ action, ids }) => {
-        if (action === FeatureVisibilityAction.HIDE) {
-          ids.forEach((id) => {
-            const entity = this.entities.getById(id);
-            if (entity) {
-              globalHider.addFeature(id, entity);
-            }
-          });
-        }
-      }),
       this.entities.collectionChanged.addEventListener((c, added) => {
         added.forEach((entity) => {
           if (this.featureVisibility.hiddenObjects[entity.id]) {
             this.featureVisibility.addHiddenFeature(entity.id, entity);
           }
-
-          if (globalHider.hiddenObjects[entity.id]) {
-            globalHider.addFeature(entity.id, entity);
+          if (this.globalHider && this.globalHider.hiddenObjects[entity.id]) {
+            this.globalHider.addFeature(entity.id, entity);
           }
         });
       }),
     ];
+
+    if (this.globalHider) {
+      this._featureVisibilityListeners.push(this.globalHider.changed.addEventListener(({ action, ids }) => {
+        if (action === FeatureVisibilityAction.HIDE) {
+          ids.forEach((id) => {
+            const entity = this.entities.getById(id);
+            if (entity) {
+              this.globalHider.addFeature(id, entity);
+            }
+          });
+        }
+      }));
+    }
   }
 
   /**

package/src/layer/featureLayer.js

@@ -21,6 +21,7 @@ import { layerClassRegistry } from '../classRegistry.js';
 
 /**
  * @typedef {LayerImplementationOptions} FeatureLayerImplementationOptions
+ * @property {GlobalHider} globalHider
  * @property {FeatureVisibility} featureVisibility
  * @property {import("@vcmap/core").StyleItem} style
  * @api
@@ -140,11 +141,20 @@ class FeatureLayer extends Layer {
   getImplementationOptions() {
     return {
       ...super.getImplementationOptions(),
+      globalHider: this.globalHider,
       featureVisibility: this.featureVisibility,
       style: this.style,
     };
   }
 
+  /**
+   * @param {import("@vcmap/core").GlobalHider} globalHider
+   */
+  setGlobalHider(globalHider) {
+    super.setGlobalHider(globalHider);
+    this.forceRedraw();
+  }
+
   /**
    * @param {Object|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Cesium3DTilePointFeature|import("@vcmap/cesium").Cesium3DTileFeature|DataSourcePickedObject} object
    * @returns {?Object}

package/src/layer/featureStoreLayer.js

@@ -309,6 +309,7 @@ class FeatureStoreLayer extends VectorLayer {
         name: this.name,
         style: this.style,
         featureVisibility: this._staticFeatureVisibility,
+        globalHider: this.globalHider,
         splitDirection: SplitDirection.NONE,
         jumpToLocation: false,
       })));

package/src/layer/featureVisibility.js

@@ -231,6 +231,9 @@ export function synchronizeFeatureVisibility(source, destination) {
 }
 
 /**
+ * FeatureVisibility handles the visibility and highlighting of features of a specific {@link FeatureLayer} or {@link DataSourceLayer}
+ * and its {@link FeatureLayerImplementation} resp. {@link DataSourceCesiumImpl}.
+ * The visibility is being synchronized with the {@link GlobalHider}.
  * @class
  */
 class FeatureVisibility {

package/src/layer/globalHider.js

@@ -9,11 +9,16 @@ import {
 import VcsEvent from '../vcsEvent.js';
 
 /**
- * @type {GlobalHider}
+ * @typedef {Object} HiddenObject
+ * @property {string} id
  */
-let instance;
 
 /**
+ * GlobalHider globally hides features existing within a layer of a {@link LayerCollection}.
+ * Features can be defined as hidden by {@link VcsAppConfig} or {@link LayerOptions}.
+ * Hiding will be performed, when a {@link Context} is loaded, a {@link Layer} is activated or GlobalHider API is called.
+ * A feature can be hidden multiple times by different actors, e.g. contexts, layers, which is handled by this class.
+ * A feature will be shown again, when a {@link Context} is removed, a {@link Layer} is deactivated or GlobalHider API is called.
  * @class
  */
 class GlobalHider {
@@ -123,24 +128,6 @@ class GlobalHider {
     this._hiddenObjectFeatures = {};
     this.changed.destroy();
   }
-
-  static destroy() {
-    if (instance) {
-      instance.destroy();
-    }
-    instance = undefined;
-  }
-}
-
-/**
- * @returns {GlobalHider}
- * @api
- */
-export function getGlobalHider() {
-  if (!instance) {
-    instance = new GlobalHider();
-  }
-  return instance;
 }
 
 export default GlobalHider;

package/src/layer/layer.js

@@ -1,13 +1,13 @@
-import { check } from '@vcsuite/check';
+import { check, checkMaybe } from '@vcsuite/check';
 import { parseBoolean, parseInteger } from '@vcsuite/parsers';
 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 '../vcsEvent.js';
 import { getCurrentLocale, getLocaleChangedEvent } from '../util/locale.js';
 import { layerClassRegistry } from '../classRegistry.js';
+import GlobalHider from './globalHider.js';
 
 /**
  * @typedef {Object} GenericFeature
@@ -213,12 +213,19 @@ 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) ?
+    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
@@ -234,9 +241,6 @@ class Layer extends VcsObject {
      */
     this.exclusiveGroupsChanged = new VcsEvent();
 
-    /** @type {import("@vcmap/core").GlobalHider} */
-    this.globalHider = getGlobalHider();
-
     /**
      * @type {CopyrightOptions|undefined}
      */
@@ -352,6 +356,42 @@ 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
@@ -616,7 +656,9 @@ class Layer extends VcsObject {
     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);
@@ -666,7 +708,9 @@ 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);

package/src/layer/oblique/vectorObliqueImpl.js

@@ -5,7 +5,6 @@ import Feature from 'ol/Feature.js';
 
 import { mercatorProjection } from '../../util/projection.js';
 import { mercatorGeometryToImageGeometry, imageGeometryToMercatorGeometry, getPolygonizedGeometry, setNewGeometry } from './obliqueHelpers.js';
-import { getGlobalHider } from '../globalHider.js';
 import {
   actuallyIsCircle,
   alreadyTransformedToImage,
@@ -74,7 +73,7 @@ class VectorObliqueImpl extends LayerObliqueImpl {
     /**
      * @type {import("@vcmap/core").GlobalHider}
      */
-    this.globalHider = getGlobalHider();
+    this.globalHider = options.globalHider;
     /**
      * @type {import("ol/source").Vector<import("ol/geom/Geometry").default>}
      */

package/src/layer/openlayers/vectorOpenlayersImpl.js

@@ -1,7 +1,6 @@
 import OLVectorLayer from 'ol/layer/Vector.js';
 import LayerOpenlayersImpl from './layerOpenlayersImpl.js';
 import { synchronizeFeatureVisibilityWithSource } from '../vectorHelpers.js';
-import { getGlobalHider } from '../globalHider.js';
 
 /**
  * represents a specific vectorlayer for openlayers.
@@ -35,7 +34,8 @@ class VectorOpenlayersImpl extends LayerOpenlayersImpl {
     this._featureVisibilityListeners = [];
     /** @type {import("ol/layer/Vector").default<import("ol/source").Vector<import("ol/geom/Geometry").default>>|null} */
     this.olLayer = null;
-    this.globalHider = getGlobalHider();
+    /** @type {import("@vcmap/core").GlobalHider} */
+    this.globalHider = options.globalHider;
   }
 
   /**

package/src/layer/vectorTileLayer.js

@@ -155,7 +155,7 @@ class VectorTileLayer extends FeatureLayer {
      * @type {Array<Function>}
      * @private
      */
-    this._featureVisibilityListener = [];
+    this._featureVisibilityListeners = [];
 
     /**
      * @type {Function}
@@ -254,15 +254,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) => {
@@ -289,8 +298,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);
@@ -311,8 +322,8 @@ class VectorTileLayer extends FeatureLayer {
           }
         });
         this.updateTiles([...tileIdsChanged]);
-      }),
-    ];
+      }));
+    }
   }
 
   /**
@@ -400,8 +411,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);
       });
@@ -414,7 +425,7 @@ class VectorTileLayer extends FeatureLayer {
    */
   deactivate() {
     super.deactivate();
-    this._featureVisibilityListener.forEach((cb) => { cb(); });
+    this._featureVisibilityListeners.forEach((cb) => { cb(); });
   }
 
   /**
@@ -422,7 +433,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/util/layerCollection.js

@@ -1,7 +1,9 @@
+import { check } from '@vcsuite/check';
 import IndexedCollection from './indexedCollection.js';
 import ExclusiveManager from './exclusiveManager.js';
 import LayerState from '../layer/layerState.js';
 import VcsEvent from '../vcsEvent.js';
+import GlobalHider from '../layer/globalHider.js';
 
 /**
  * A collection of layers. Manages rendering order and layer exclusivity. Emits state changes for convenience. Passed to
@@ -61,6 +63,13 @@ class LayerCollection extends IndexedCollection {
      * @api
      */
     this.exclusiveManager = new ExclusiveManager();
+
+    /**
+     * The global hider for this collection.
+     * @type {GlobalHider}
+     * @private
+     */
+    this._globalHider = new GlobalHider();
   }
 
   /**
@@ -72,6 +81,27 @@ class LayerCollection extends IndexedCollection {
    */
   get zIndexSymbol() { return this._zIndexSymbol; }
 
+  /**
+   * The current global hider
+   * @type {GlobalHider}
+   */
+  get globalHider() {
+    return this._globalHider;
+  }
+
+  /**
+   * Set global hider for these maps.
+   * @param {GlobalHider} globalHider
+   */
+  set globalHider(globalHider) {
+    check(globalHider, GlobalHider);
+
+    this._globalHider = globalHider;
+    this._array.forEach((layer) => {
+      layer.setGlobalHider(this._globalHider);
+    });
+  }
+
   /**
    * @param {import("@vcmap/core").Layer} layer
    * @private
@@ -171,6 +201,7 @@ class LayerCollection extends IndexedCollection {
     const insertedAt = super.add(layer, usedIndex);
     if (insertedAt != null) {
       layer[this._zIndexSymbol] = layer.zIndex;
+      layer.setGlobalHider(this._globalHider);
       this._ensureLocalZIndex(layer);
       this._listenToLayerEvents(layer);
       this.exclusiveManager.registerLayer(layer);
@@ -189,6 +220,7 @@ class LayerCollection extends IndexedCollection {
       delete this._layerEventListeners[layer.name];
     }
     delete layer[this._zIndexSymbol];
+    layer.setGlobalHider(null);
     this.exclusiveManager.unregisterLayer(layer);
     return super._remove(layer);
   }
@@ -213,6 +245,7 @@ class LayerCollection extends IndexedCollection {
 
     this._layerEventListeners = {};
     this.exclusiveManager.destroy();
+    this._globalHider.destroy();
     super.destroy();
   }
 }