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

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}.
@@ -677,7 +681,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;
@@ -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>;
     /**
@@ -1147,19 +1153,15 @@ export class CesiumTilesetLayer extends FeatureLayer implements SplitLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +1183,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
      */
@@ -1190,6 +1194,10 @@ export class CesiumTilesetLayer extends FeatureLayer implements SplitLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -1238,19 +1246,15 @@ export class CzmlLayer extends DataSourceLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +1276,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
      */
@@ -1281,6 +1287,10 @@ export class CzmlLayer extends DataSourceLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -1354,19 +1364,15 @@ export class DataSourceLayer extends Layer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +1394,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
      */
@@ -1397,6 +1405,10 @@ export class DataSourceLayer extends Layer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -1421,6 +1433,7 @@ export interface FeatureLayerOptions extends LayerOptions {
 }
 
 export interface FeatureLayerImplementationOptions extends LayerImplementationOptions {
+    globalHider: GlobalHider;
     featureVisibility: FeatureVisibility;
     style: StyleItem;
 }
@@ -1496,19 +1509,15 @@ export class FeatureLayer extends Layer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +1539,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
      */
@@ -1539,6 +1550,10 @@ export class FeatureLayer extends Layer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -1713,19 +1728,15 @@ export class FeatureStoreLayer extends VectorLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +1757,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
      */
@@ -1755,6 +1768,10 @@ export class FeatureStoreLayer extends VectorLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -1904,6 +1921,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>;
@@ -2117,19 +2139,15 @@ export class GeoJSONLayer extends VectorLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +2168,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
      */
@@ -2159,6 +2179,10 @@ export class GeoJSONLayer extends VectorLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -2167,6 +2191,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 +2224,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;
@@ -2311,19 +2344,15 @@ export class Layer extends VcsObject {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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,12 +2371,19 @@ 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
      */
     readonly exclusive: boolean;
     exclusiveGroups: any;
     zIndex: any;
+    /**
+     * sets the locale and reloads the layer the if the URL is a locale aware Object.
+     */
+    locale: any;
     /**
      * creates an array of layer implementations for the given map.
      * @param map - Map
@@ -2608,19 +2644,15 @@ export class OpenStreetMapLayer extends Layer implements SplitLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +2674,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
      */
@@ -2651,6 +2685,10 @@ export class OpenStreetMapLayer extends Layer implements SplitLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -2753,6 +2791,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;
 }
@@ -2917,19 +2956,15 @@ export class PointCloudLayer extends CesiumTilesetLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +2986,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
      */
@@ -2960,6 +2997,10 @@ export class PointCloudLayer extends CesiumTilesetLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -3061,19 +3102,15 @@ export class RasterLayer extends Layer implements SplitLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +3132,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
      */
@@ -3104,6 +3143,10 @@ export class RasterLayer extends Layer implements SplitLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -3172,19 +3215,15 @@ export class SingleImageLayer extends RasterLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +3245,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
      */
@@ -3215,6 +3256,10 @@ export class SingleImageLayer extends RasterLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -3290,19 +3335,15 @@ export class TerrainLayer extends Layer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +3365,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
      */
@@ -3333,6 +3376,10 @@ export class TerrainLayer extends Layer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -3367,6 +3414,10 @@ export class MVTTileProvider extends TileProvider {
     static getDefaultOptions(): MVTTileProviderOptions;
     url: string;
     idProperty: string | undefined;
+    /**
+     * sets the locale and clears the Cache if the URL is a locale aware Object.
+     */
+    locale: any;
     /**
      * Cesium Webmercator TilingScheme
      */
@@ -3452,6 +3503,7 @@ export class StaticGeoJSONTileProvider extends TileProvider {
      * use setTileCacheSize to change
      */
     readonly tileCacheSize: number;
+    locale: string;
     /**
      * unique Name
      */
@@ -3551,6 +3603,10 @@ export class TileProvider extends VcsObject {
      * use setTileCacheSize to change
      */
     readonly tileCacheSize: number;
+    /**
+     * sets the locale and reloads the layer the if the URL is a locale aware Object.
+     */
+    locale: any;
     setTileCacheSize(value: number): Promise<any>;
     /**
      * returns the closest baseLevel for the given resolution
@@ -3631,9 +3687,9 @@ export interface URLTemplateTileProviderOptions extends TileProviderOptions {
 /**
  * replaces {x}, {y}, {z} with the x, y, z tiling coordinates
  * replaces {minx}, {miny}, {maxx}, {maxy} with extent of the tile if tilingExtent is provided
- * replaces {locale} with the current locale
+ * replaces {locale} with the given locale
  */
-export function getURL(url: string, x: number, y: number, z: number, tilingExtent?: import("@vcmap/cesium").Rectangle): string;
+export function getURL(url: string, x: number, y: number, z: number, tilingExtent?: import("@vcmap/cesium").Rectangle, locale?: string): string;
 
 /**
  * TileProvider loads GeojsonLayer from the provided URL. The URL has placeholders:
@@ -3646,6 +3702,10 @@ export class URLTemplateTileProvider extends TileProvider {
     static readonly className: any;
     static getDefaultOptions(): URLTemplateTileProviderOptions;
     url: string;
+    /**
+     * sets the locale and clears the Cache if the URL is a locale aware Object.
+     */
+    locale: any;
     /**
      * Cesium Webmercator TilingScheme
      */
@@ -3738,19 +3798,15 @@ export class TMSLayer extends RasterLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +3828,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
      */
@@ -3781,6 +3839,10 @@ export class TMSLayer extends RasterLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -3997,19 +4059,15 @@ export class VectorLayer extends FeatureLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +4088,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
      */
@@ -4039,6 +4099,10 @@ export class VectorLayer extends FeatureLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -4315,6 +4379,10 @@ export class VectorTileLayer extends FeatureLayer {
      */
     vectorProperties: VectorProperties;
     tileProvider: TileProvider;
+    /**
+     * sets the locale and reloads the layer the if the URL is a locale aware Object.
+     */
+    locale: any;
     /**
      * rerenders the specified tiles
      * rendering happens async
@@ -4361,19 +4429,15 @@ export class VectorTileLayer extends FeatureLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +4459,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
      */
@@ -4507,19 +4573,15 @@ export class WFSLayer extends VectorLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +4602,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
      */
@@ -4549,6 +4613,10 @@ export class WFSLayer extends VectorLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -4671,19 +4739,15 @@ export class WMSLayer extends RasterLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +4769,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
      */
@@ -4714,6 +4780,10 @@ export class WMSLayer extends RasterLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -4799,19 +4869,15 @@ export class WMTSLayer extends RasterLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * 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 +4899,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
      */
@@ -4842,6 +4910,10 @@ export class WMTSLayer extends RasterLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -6242,6 +6314,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 +6826,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
      */
@@ -6773,16 +6853,6 @@ export class Collection<T extends any> {
     destroy(): void;
 }
 
-export function getShortLocaleDate(date: Date, locale?: string): string;
-
-export function getShortLocaleTime(date: Date, locale?: string): string;
-
-export function getISODateString(date: Date): string;
-
-export function getDayOfYear(date: Date): number;
-
-export function isLeapYear(date: Date): boolean;
-
 /**
  * Tracks layer exclusivity, added to every {@link LayerCollection}.
  */
@@ -7026,28 +7096,26 @@ 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;
+    locale: any;
     /**
      * Adds a layer to the collection. Can optionally be passed an index at which to insert the layer.
+     * The layer locale will be set to the same locale of the layerCollection. This will trigger a forceRedraw
+     * of the layer if the layer locale is different and the layer is locale aware.
      * @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>;
-
 /**
  * returns the default browserLocale, if not possible 'en'
  */
 export function detectBrowserLocale(): string;
 
-export function getCurrentLocale(): string;
-
-export function setCurrentLocale(value: string): void;
-
 export interface MapCollectionInitializationError {
     error: Error;
     map: VcsMap;
@@ -7102,11 +7170,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 +7221,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 +7258,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);
@@ -7419,6 +7489,12 @@ export class ViewPoint extends VcsObject {
 
 export class VcsApp {
     readonly id: string;
+    /**
+     * sets the locale of the vcsApp and the linked layerCollection.
+     * This will trigger the localeChanged Event.
+     */
+    locale: any;
+    readonly localeChanged: VcsEvent<string>;
     readonly maps: OverrideMapCollection;
     readonly layers: OverrideLayerCollection;
     readonly obliqueCollections: OverrideCollection<ObliqueCollection>;