@vcmap/core 5.0.0-rc.8 → 5.0.0

package/dist/src/util/layerCollection.d.ts

@@ -0,0 +1,92 @@
+import IndexedCollection from './indexedCollection.js';
+import ExclusiveManager from './exclusiveManager.js';
+import VcsEvent from '../vcsEvent.js';
+import GlobalHider from '../layer/globalHider.js';
+import type { default as Layer } from '../layer/layer.js';
+/**
+ * The largest integer zindex which can be safely assigned to a layer (equal to Number.MAX_SAFE_INTEGER)
+ * You should use this to ensure layers are always rendered on top.
+ */
+export declare const maxZIndex: number;
+/**
+ * A collection of layers. Manages rendering order and layer exclusivity. Emits state changes for convenience. Passed to
+ * {@link Map} for layers available to said map. Layers must have unique names.
+ */
+declare class LayerCollection extends IndexedCollection<Layer> {
+    /**
+     * Creates a LayerCollection from an iterable of layers, such as an Array.
+     * @param  iterable
+     */
+    static from(iterable: Iterable<Layer>): LayerCollection;
+    private _layerEventListeners;
+    private _zIndexSymbol;
+    /**
+     * Event raised, when a layer of this collection changes its state. Passed the layer.
+     */
+    stateChanged: VcsEvent<Layer>;
+    /**
+     * The exclusive manager for this collection. Layers within this collection are automatically added and tracked.
+     */
+    exclusiveManager: ExclusiveManager;
+    /**
+     * The global hider for this collection.
+     */
+    private _globalHider;
+    /**
+     * Locale for this layerCollection, will be synchronized by the vcsApp, if part of an vcsApp.
+     * This Locale will be set on all Member Layers. On setting the Locale this will trigger a reload of all locale
+     * aware layers.
+     */
+    private _locale;
+    constructor();
+    /**
+     * A symbol to describe the local z index of a layer. The local z index must not equal the layers z index, but is
+     * always consistent in comparison to the neighbouring layers. If a layer is moved other then by z index, the collection
+     * ensures consistency by setting a new local z index if needed.
+     */
+    get zIndexSymbol(): symbol;
+    /**
+     * The current global hider of these layers
+     */
+    get globalHider(): GlobalHider;
+    /**
+     * The current global hider of these layers
+     * @param  globalHider
+     */
+    set globalHider(globalHider: GlobalHider);
+    get locale(): string;
+    set locale(value: string);
+    private _listenToLayerEvents;
+    /**
+     * Determines the location in the array before the first entry with a higher local z index or null if there is no such position
+     * @param  zIndex
+     * @private
+     */
+    private _findZIndexPosition;
+    /**
+     * This is callback for a layers zIndex changed. It reevaluates the array given the new zIndex
+     * an moves the specified layer to its new location determined by findeZIndexPosition or the end of the array failing that.
+     * @param  layer
+     * @private
+     */
+    private _zIndexChanged;
+    /**
+     * Ensures the local z index is consistent with the neighbours of a given layer.
+     * e.g. the layer on elower must have a lower or equal zIndex
+     * and the one higher a higher or equal zIndex.
+     */
+    private _ensureLocalZIndex;
+    /**
+     * 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.
+     * @param  layer
+     * @param  index
+     * @returns  returns the layer index or null, if the layers name is not unique
+     */
+    add(layer: Layer, index?: number): number | null;
+    protected _remove(layer: Layer): number;
+    clear(): void;
+    destroy(): void;
+}
+export default LayerCollection;

package/dist/src/util/layerCollection.js

@@ -0,0 +1,247 @@
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+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';
+/**
+ * The largest integer zindex which can be safely assigned to a layer (equal to Number.MAX_SAFE_INTEGER)
+ * You should use this to ensure layers are always rendered on top.
+ */
+export const maxZIndex = Number.MAX_SAFE_INTEGER;
+/**
+ * A collection of layers. Manages rendering order and layer exclusivity. Emits state changes for convenience. Passed to
+ * {@link Map} for layers available to said map. Layers must have unique names.
+ */
+// ignored do to static issues, see https://github.com/microsoft/TypeScript/issues/4628
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+class LayerCollection extends IndexedCollection {
+    /**
+     * Creates a LayerCollection from an iterable of layers, such as an Array.
+     * @param  iterable
+     */
+    static from(iterable) {
+        const collection = new LayerCollection();
+        if (iterable) {
+            // eslint-disable-next-line no-restricted-syntax
+            for (const layer of iterable) {
+                collection.add(layer);
+            }
+        }
+        return collection;
+    }
+    _layerEventListeners;
+    _zIndexSymbol;
+    /**
+     * Event raised, when a layer of this collection changes its state. Passed the layer.
+     */
+    stateChanged;
+    /**
+     * The exclusive manager for this collection. Layers within this collection are automatically added and tracked.
+     */
+    exclusiveManager;
+    /**
+     * The global hider for this collection.
+     */
+    _globalHider;
+    /**
+     * Locale for this layerCollection, will be synchronized by the vcsApp, if part of an vcsApp.
+     * This Locale will be set on all Member Layers. On setting the Locale this will trigger a reload of all locale
+     * aware layers.
+     */
+    _locale;
+    constructor() {
+        super();
+        this._layerEventListeners = {};
+        this._zIndexSymbol = Symbol('zIndex');
+        this.stateChanged = new VcsEvent();
+        this.exclusiveManager = new ExclusiveManager();
+        this._globalHider = new GlobalHider();
+        this._locale = 'en';
+    }
+    /**
+     * A symbol to describe the local z index of a layer. The local z index must not equal the layers z index, but is
+     * always consistent in comparison to the neighbouring layers. If a layer is moved other then by z index, the collection
+     * ensures consistency by setting a new local z index if needed.
+     */
+    get zIndexSymbol() {
+        return this._zIndexSymbol;
+    }
+    /**
+     * The current global hider of these layers
+     */
+    get globalHider() {
+        return this._globalHider;
+    }
+    /**
+     * The current global hider of these layers
+     * @param  globalHider
+     */
+    set globalHider(globalHider) {
+        check(globalHider, GlobalHider);
+        this._globalHider = globalHider;
+        this._array.forEach((layer) => {
+            layer.setGlobalHider(this._globalHider);
+        });
+    }
+    get locale() {
+        return this._locale;
+    }
+    set locale(value) {
+        check(value, String);
+        if (this._locale !== value) {
+            this._locale = value;
+            [...this].forEach((layer) => {
+                layer.locale = this._locale;
+            });
+        }
+    }
+    _listenToLayerEvents(layer) {
+        const stateListener = layer.stateChanged.addEventListener((state) => {
+            if (state === LayerState.ACTIVE) {
+                this.exclusiveManager.handleLayerActivated(layer);
+            }
+            this.stateChanged.raiseEvent(layer);
+        });
+        const zIndexListener = layer.zIndexChanged.addEventListener(() => {
+            this._zIndexChanged(layer);
+        });
+        const exclusiveGroupsListener = layer.exclusiveGroupsChanged.addEventListener(() => {
+            this.exclusiveManager.handleExclusiveGroupsChanged(layer);
+        });
+        const listeners = [stateListener, zIndexListener, exclusiveGroupsListener];
+        if (layer.splitDirectionChanged) {
+            listeners.push(layer.splitDirectionChanged.addEventListener(() => {
+                this.exclusiveManager.handleSplitDirectionChanged(layer);
+            }));
+        }
+        this._layerEventListeners[layer.name] = listeners;
+    }
+    /**
+     * Determines the location in the array before the first entry with a higher local z index or null if there is no such position
+     * @param  zIndex
+     * @private
+     */
+    _findZIndexPosition(zIndex) {
+        const usedIndex = this._array.findIndex(
+        // @ts-ignore
+        (l) => l[this._zIndexSymbol] > zIndex);
+        return usedIndex > -1 ? usedIndex : null;
+    }
+    /**
+     * This is callback for a layers zIndex changed. It reevaluates the array given the new zIndex
+     * an moves the specified layer to its new location determined by findeZIndexPosition or the end of the array failing that.
+     * @param  layer
+     * @private
+     */
+    _zIndexChanged(layer) {
+        const currentIndex = this.indexOf(layer);
+        if (currentIndex > -1) {
+            // @ts-ignore
+            layer[this._zIndexSymbol] = layer.zIndex;
+            let zIndexPosition = this._findZIndexPosition(layer.zIndex);
+            if (zIndexPosition != null &&
+                zIndexPosition > 0 &&
+                zIndexPosition > currentIndex) {
+                zIndexPosition -= 1; // remove self from count
+            }
+            zIndexPosition =
+                zIndexPosition != null ? zIndexPosition : this._array.length - 1;
+            this._move(layer, currentIndex, zIndexPosition);
+            this._ensureLocalZIndex(layer);
+        }
+    }
+    /**
+     * Ensures the local z index is consistent with the neighbours of a given layer.
+     * e.g. the layer on elower must have a lower or equal zIndex
+     * and the one higher a higher or equal zIndex.
+     */
+    _ensureLocalZIndex(layer) {
+        const currentIndex = this.indexOf(layer);
+        // @ts-ignore
+        const currentLayerZIndex = layer[this._zIndexSymbol];
+        if (currentIndex > 0) {
+            // @ts-ignore
+            const below = this._array[currentIndex - 1][this._zIndexSymbol];
+            if (below > currentLayerZIndex) {
+                // @ts-ignore
+                layer[this._zIndexSymbol] = below;
+            }
+        }
+        if (currentIndex < this._array.length - 1) {
+            // @ts-ignore
+            const above = this._array[currentIndex + 1][this._zIndexSymbol];
+            if (above < currentLayerZIndex) {
+                // @ts-ignore
+                layer[this._zIndexSymbol] = above;
+            }
+        }
+    }
+    /**
+     * 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.
+     * @param  layer
+     * @param  index
+     * @returns  returns the layer index or null, if the layers name is not unique
+     */
+    add(layer, index) {
+        let usedIndex = index;
+        if (index == null) {
+            usedIndex = this._findZIndexPosition(layer.zIndex);
+        }
+        const insertedAt = super.add(layer, usedIndex);
+        if (insertedAt != null) {
+            // @ts-ignore
+            layer[this._zIndexSymbol] = layer.zIndex;
+            layer.setGlobalHider(this._globalHider);
+            layer.locale = this.locale;
+            this._ensureLocalZIndex(layer);
+            this._listenToLayerEvents(layer);
+            this.exclusiveManager.registerLayer(layer);
+        }
+        return insertedAt;
+    }
+    _remove(layer) {
+        if (this._layerEventListeners[layer.name]) {
+            this._layerEventListeners[layer.name].forEach((cb) => {
+                cb();
+            });
+            delete this._layerEventListeners[layer.name];
+        }
+        // @ts-ignore
+        delete layer[this._zIndexSymbol];
+        layer.setGlobalHider();
+        this.exclusiveManager.unregisterLayer(layer);
+        return super._remove(layer);
+    }
+    clear() {
+        Object.values(this._layerEventListeners)
+            .flat()
+            .forEach((r) => {
+            r();
+        });
+        this._array.forEach((l) => {
+            // @ts-ignore
+            delete l[this._zIndexSymbol];
+        });
+        this.exclusiveManager.clear();
+        this._layerEventListeners = {};
+        super.clear();
+    }
+    destroy() {
+        Object.values(this._layerEventListeners)
+            .flat()
+            .forEach((r) => {
+            r();
+        });
+        this._layerEventListeners = {};
+        this.exclusiveManager.destroy();
+        this._globalHider.destroy();
+        super.destroy();
+    }
+}
+export default LayerCollection;
+//# sourceMappingURL=layerCollection.js.map

package/dist/src/util/layerCollection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"layerCollection.js","sourceRoot":"","sources":["../../../src/util/layerCollection.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,iBAAiB,MAAM,wBAAwB,CAAC;AACvD,OAAO,gBAAgB,MAAM,uBAAuB,CAAC;AACrD,OAAO,UAAU,MAAM,wBAAwB,CAAC;AAChD,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,WAAW,MAAM,yBAAyB,CAAC;AAIlD;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAEjD;;;GAGG;AACH,uFAAuF;AACvF,6DAA6D;AAC7D,aAAa;AACb,MAAM,eAAgB,SAAQ,iBAAwB;IACpD;;;OAGG;IACH,MAAM,CAAC,IAAI,CAAC,QAAyB;QACnC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QAEzC,IAAI,QAAQ,EAAE;YACZ,gDAAgD;YAChD,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE;gBAC5B,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;aACvB;SACF;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,oBAAoB,CAAiC;IAErD,aAAa,CAAS;IAE9B;;OAEG;IACH,YAAY,CAAkB;IAE9B;;OAEG;IACH,gBAAgB,CAAmB;IAEnC;;OAEG;IACK,YAAY,CAAc;IAElC;;;;OAIG;IACK,OAAO,CAAS;IAExB;QACE,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;QAC/B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,EAAE,CAAC;QACnC,IAAI,CAAC,gBAAgB,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC;QACtC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAI,WAAW,CAAC,WAAwB;QACtC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QAEhC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC5B,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,MAAM,CAAC,KAAa;QACtB,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAErB,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,EAAE;YAC1B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC1B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;YAC9B,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAEO,oBAAoB,CAAC,KAAY;QACvC,MAAM,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC,gBAAgB,CACvD,CAAC,KAAiB,EAAE,EAAE;YACpB,IAAI,KAAK,KAAK,UAAU,CAAC,MAAM,EAAE;gBAC/B,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;aACnD;YACD,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC,CACF,CAAC;QAEF,MAAM,cAAc,GAAG,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,GAAG,EAAE;YAC/D,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,MAAM,uBAAuB,GAC3B,KAAK,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,GAAG,EAAE;YACjD,IAAI,CAAC,gBAAgB,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEL,MAAM,SAAS,GAAG,CAAC,aAAa,EAAE,cAAc,EAAE,uBAAuB,CAAC,CAAC;QAC3E,IAAK,KAA4B,CAAC,qBAAqB,EAAE;YACvD,SAAS,CAAC,IAAI,CACX,KAA4B,CAAC,qBAAqB,CAAC,gBAAgB,CAClE,GAAG,EAAE;gBACH,IAAI,CAAC,gBAAgB,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;YAC3D,CAAC,CACF,CACF,CAAC;SACH;QACD,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACK,mBAAmB,CAAC,MAAc;QACxC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS;QACrC,aAAa;QACb,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,MAAM,CACtC,CAAC;QACF,OAAO,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACK,cAAc,CAAC,KAAY;QACjC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,YAAY,GAAG,CAAC,CAAC,EAAE;YACrB,aAAa;YACb,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;YACzC,IAAI,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC5D,IACE,cAAc,IAAI,IAAI;gBACtB,cAAc,GAAG,CAAC;gBAClB,cAAc,GAAG,YAAY,EAC7B;gBACA,cAAc,IAAI,CAAC,CAAC,CAAC,yBAAyB;aAC/C;YACD,cAAc;gBACZ,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YACnE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;YAChD,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;SAChC;IACH,CAAC;IAED;;;;OAIG;IACK,kBAAkB,CAAC,KAAY;QACrC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzC,aAAa;QACb,MAAM,kBAAkB,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAW,CAAC;QAC/D,IAAI,YAAY,GAAG,CAAC,EAAE;YACpB,aAAa;YACb,MAAM,KAAK,GAAW,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,CACjD,IAAI,CAAC,aAAa,CACT,CAAC;YACZ,IAAI,KAAK,GAAG,kBAAkB,EAAE;gBAC9B,aAAa;gBACb,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;aACnC;SACF;QAED,IAAI,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACzC,aAAa;YACb,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAW,CAAC;YAC1E,IAAI,KAAK,GAAG,kBAAkB,EAAE;gBAC9B,aAAa;gBACb,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;aACnC;SACF;IACH,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,KAAY,EAAE,KAAc;QAC9B,IAAI,SAAS,GAA8B,KAAK,CAAC;QACjD,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;SACpD;QACD,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC/C,IAAI,UAAU,IAAI,IAAI,EAAE;YACtB,aAAa;YACb,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;YACzC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACxC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAC3B,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC/B,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;YACjC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAC5C;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAES,OAAO,CAAC,KAAY;QAC5B,IAAI,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YACzC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;gBACnD,EAAE,EAAE,CAAC;YACP,CAAC,CAAC,CAAC;YACH,OAAO,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAC9C;QACD,aAAa;QACb,OAAO,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACjC,KAAK,CAAC,cAAc,EAAE,CAAC;QACvB,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC7C,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK;QACH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC;aACrC,IAAI,EAAE;aACN,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACb,CAAC,EAAE,CAAC;QACN,CAAC,CAAC,CAAC;QACL,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACxB,aAAa;YACb,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;QAC/B,KAAK,CAAC,KAAK,EAAE,CAAC;IAChB,CAAC;IAED,OAAO;QACL,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC;aACrC,IAAI,EAAE;aACN,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACb,CAAC,EAAE,CAAC;QACN,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;QAC/B,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAChC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;QAC5B,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;CACF;AAED,eAAe,eAAe,CAAC"}

package/dist/src/util/locale.d.ts

@@ -0,0 +1,4 @@
+/**
+ * returns the default browserLocale, if not possible 'en'
+ */
+export declare function detectBrowserLocale(): string;

package/dist/src/util/locale.js

@@ -0,0 +1,12 @@
+/* eslint-disable import/prefer-default-export */
+/**
+ * returns the default browserLocale, if not possible 'en'
+ */
+export function detectBrowserLocale() {
+    if (navigator.language) {
+        const lang = navigator.language;
+        return lang.substring(0, 2);
+    }
+    return 'en';
+}
+//# sourceMappingURL=locale.js.map

package/dist/src/util/locale.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"locale.js","sourceRoot":"","sources":["../../../src/util/locale.ts"],"names":[],"mappings":"AAAA,iDAAiD;AACjD;;GAEG;AACH,MAAM,UAAU,mBAAmB;IACjC,IAAI,SAAS,CAAC,QAAQ,EAAE;QACtB,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC;QAChC,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KAC7B;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/src/util/mapCollection.d.ts

@@ -0,0 +1,112 @@
+import VcsEvent from '../vcsEvent.js';
+import Collection from './collection.js';
+import EventHandler from '../interaction/eventHandler.js';
+import LayerCollection from './layerCollection.js';
+import ClippingObjectManager from './clipping/clippingObjectManager.js';
+import type { default as VcsMap, VcsMapRenderEvent } from '../map/vcsMap.js';
+import { VisualisationType } from '../map/vcsMap.js';
+export type MapCollectionInitializationError = {
+    error: Error;
+    map: VcsMap;
+};
+declare class MapCollection extends Collection<VcsMap> {
+    /**
+     * Creates a MapCollection from an iterable of maps, such as an Array.
+     */
+    static from(iterable: Iterable<VcsMap>): MapCollection;
+    private _activeMap;
+    private _target;
+    /**
+     * if the active map is removed the last viewpoint is cached for the next mapActivation.
+     */
+    private _cachedViewpoint;
+    /**
+     * The map pointer event handler. The EventHandler is shared amongst all maps within the collection.
+     */
+    eventHandler: EventHandler;
+    /**
+     * Collection of layers shared amongst the maps within this collection,
+     * layers will be rendered if supported on the currently active map.
+     */
+    private _layerCollection;
+    /**
+     * Called, if a map fails to initialize. The map causing the error will be removed from the collection.
+     */
+    initializeError: VcsEvent<MapCollectionInitializationError>;
+    /**
+     * Called, when a map (typically an oblique map) cannot show the current viewpoint. Is passed
+     * the map which cannot show the current viewpoint.
+     */
+    fallbackMapActivated: VcsEvent<VcsMap>;
+    /**
+     * Called, when a map is activated. Is passed the activated map.
+     */
+    mapActivated: VcsEvent<VcsMap>;
+    /**
+     * Manages the clipping object for the maps in this collection.
+     */
+    clippingObjectManager: ClippingObjectManager;
+    private _mapPointerListeners;
+    private _splitPosition;
+    /**
+     * Event raised when the maps split position changes. It passed the position as its only argument.
+     */
+    splitPositionChanged: VcsEvent<number>;
+    private _postRender;
+    private _postRenderListener;
+    constructor();
+    /**
+     * The currently active map
+     */
+    get activeMap(): VcsMap | null;
+    /**
+     * The currently set HTML element in which to render the maps
+     */
+    get target(): HTMLElement | null;
+    /**
+     * The current layer collection
+     */
+    get layerCollection(): LayerCollection;
+    /**
+     * Set the layer collection for these maps.
+     */
+    set layerCollection(layerCollection: LayerCollection);
+    /**
+     * The current splitPosition
+     */
+    get splitPosition(): number;
+    /**
+     * Set the splitPosition for these maps.
+     */
+    set splitPosition(position: number);
+    /**
+     * Raised on the active maps post render event
+     */
+    get postRender(): VcsEvent<VcsMapRenderEvent<VisualisationType>>;
+    /**
+     * Adds a map to the collection. This will set the collections target
+     * and the collections  on the map.
+     * It will add map event listeners and pass them to the event handler of this collection.
+     */
+    add(map: VcsMap): number | null;
+    protected _remove(map: VcsMap): number;
+    private _setActiveMapCSSClass;
+    /**
+     * Set the target for these maps.
+     */
+    setTarget(target: string | HTMLElement): void;
+    private _getFallbackMap;
+    private _getFallbackMapOrDefault;
+    /**
+     * Sets the active map. This will 1. get the current viewpoint of an acitve map (if one is set) 2.
+     * determine that the map to be activated can show this viewpoint or has no fallback map set and 3.
+     * activates the map 4. calls gotoViewpoint with the previous maps viewpoint
+     */
+    setActiveMap(mapName: string): Promise<void>;
+    /**
+     * Returns all maps of a specified type
+     */
+    getByType(type: string): VcsMap[];
+    destroy(): void;
+}
+export default MapCollection;