@vcmap/core 5.0.0-rc.8 → 5.0.0

package/src/util/geometryHelpers.ts

@@ -0,0 +1,170 @@
+import { offset as offsetSphere } from 'ol/sphere.js';
+import type { Coordinate } from 'ol/coordinate.js';
+import { fromCircle } from 'ol/geom/Polygon.js';
+import {
+  SimpleGeometry,
+  type Geometry,
+  GeometryCollection,
+  MultiPolygon,
+  MultiLineString,
+  MultiPoint,
+  Point,
+  Circle,
+  Polygon,
+  LineString,
+} from 'ol/geom.js';
+import Projection from './projection.js';
+
+export function getFlatCoordinatesFromSimpleGeometry(
+  geometry: SimpleGeometry,
+): Coordinate[] {
+  const stride = geometry.getStride();
+  const flatCoordinates = geometry.getFlatCoordinates();
+  if (flatCoordinates.length > 0) {
+    const numberOfCoordinates = Math.floor(flatCoordinates.length / stride);
+    const coordinates: Coordinate[] = new Array(
+      numberOfCoordinates,
+    ) as Coordinate[];
+    for (let i = 0; i < numberOfCoordinates; i++) {
+      const flatIndex = i * stride;
+      coordinates[i] = new Array(stride) as Coordinate;
+      for (let j = 0; j < stride; j++) {
+        coordinates[i][j] = flatCoordinates[flatIndex + j];
+      }
+    }
+    return coordinates;
+  }
+  return [];
+}
+
+export function getFlatCoordinatesFromGeometry(
+  geometry: Geometry,
+  inputCoordinates?: any[],
+): Coordinate[] {
+  if (!inputCoordinates && geometry instanceof SimpleGeometry) {
+    return getFlatCoordinatesFromSimpleGeometry(geometry);
+  }
+  const coordinates: any[] | undefined = inputCoordinates;
+  let flattenCoordinates = null;
+  if (geometry instanceof Point) {
+    flattenCoordinates = [coordinates];
+  } else if (geometry instanceof LineString) {
+    flattenCoordinates = coordinates;
+  } else if (geometry instanceof Polygon) {
+    flattenCoordinates = coordinates!.reduce(
+      (current: Coordinate[], next: Coordinate[]) => current.concat(next),
+    ) as Coordinate[];
+  } else if (geometry instanceof MultiPoint) {
+    flattenCoordinates = coordinates;
+  } else if (geometry instanceof MultiLineString) {
+    flattenCoordinates = coordinates!.reduce(
+      (current: Coordinate[], next: Coordinate[]) => current.concat(next),
+    ) as Coordinate[];
+  } else if (geometry instanceof MultiPolygon) {
+    flattenCoordinates = (
+      coordinates!.reduce((current: Coordinate[][], next: Coordinate[][]) =>
+        current.concat(next),
+      ) as Coordinate[][]
+    ).reduce((current, next) => current.concat(next));
+  } else if (geometry instanceof Circle) {
+    flattenCoordinates = coordinates;
+  } else if (geometry instanceof GeometryCollection) {
+    flattenCoordinates = geometry
+      .getGeometries()
+      .map((g, i) =>
+        getFlatCoordinatesFromGeometry(g, coordinates?.[i] as any[]),
+      )
+      .reduce((current, next) => current.concat(next));
+  }
+  return flattenCoordinates as Coordinate[];
+}
+
+export function circleFromCenterRadius(
+  center: Coordinate,
+  radius: number,
+): Circle {
+  const offsetWGS84 = offsetSphere(
+    Projection.mercatorToWgs84(center),
+    radius,
+    Math.PI / 2,
+  );
+  const of = Projection.wgs84ToMercator(offsetWGS84);
+  const dx = center[0] - of[0];
+  const dy = center[1] - of[1];
+  const dx2 = dx * dx;
+  const dy2 = dy * dy;
+  const radiusProjected = Math.sqrt(dx2 + dy2);
+  return new Circle(center, radiusProjected, 'XYZ');
+}
+
+export function convertGeometryToPolygon(geometry: Geometry): Geometry {
+  if (geometry instanceof Circle) {
+    return fromCircle(geometry);
+  } else if (geometry instanceof Polygon) {
+    geometry.unset('_vcsGeomType');
+  }
+  return geometry;
+}
+
+export function enforceEndingVertex(linearRing: Coordinate[]): void {
+  const [lastX, lastY] = linearRing[linearRing.length - 1];
+  if (!(linearRing[0][0] === lastX && linearRing[0][1] === lastY)) {
+    linearRing.push(linearRing[0].slice());
+  }
+}
+
+export function removeEndingVertex(linearRing: Coordinate[]): void {
+  const [lastX, lastY] = linearRing[linearRing.length - 1];
+  if (linearRing[0][0] === lastX && linearRing[0][1] === lastY) {
+    linearRing.pop();
+  }
+}
+
+export function removeEndingVertexFromGeometry(geometry: Geometry): void {
+  if (geometry instanceof Polygon) {
+    const coordinates = geometry.getCoordinates();
+    coordinates.forEach((ring) => {
+      removeEndingVertex(ring);
+    });
+    geometry.setCoordinates(coordinates);
+  } else if (geometry instanceof MultiPolygon) {
+    const coordinates = geometry.getCoordinates();
+    coordinates.forEach((poly) => {
+      poly.forEach((ring) => {
+        removeEndingVertex(ring);
+      });
+    });
+    geometry.setCoordinates(coordinates);
+  }
+}
+
+/**
+ * from @mapbox/geojson-area
+ * @param ring
+ */
+function ringArea(ring: Coordinate[]): number {
+  let area = 0;
+  const positions = ring.length;
+
+  for (let i = 0; i <= positions - 2; i++) {
+    const p1 = ring[i];
+    const p2 = ring[i + 1];
+    area += p1[0] * p2[1] - p1[1] * p2[0];
+  }
+
+  area /= 2;
+  return area;
+}
+
+/**
+ * enforce a ring to be counter-clockwise
+ * @param  ring
+ */
+export function enforceRightHand(ring: Coordinate[]): Coordinate[] {
+  const area = ringArea(ring);
+  if (area < 0) {
+    ring.reverse();
+  }
+
+  return ring;
+}

package/src/util/indexedCollection.ts

@@ -0,0 +1,157 @@
+import VcsEvent from '../vcsEvent.js';
+import Collection from './collection.js';
+
+/**
+ * A generic array based collection. Implements the Symbol.iterator (e.g. [...collection])
+ */
+class IndexedCollection<T> extends Collection<T> {
+  static from<F>(
+    iterable: Iterable<F>,
+    uniqueKey?: keyof F | false,
+  ): IndexedCollection<F> {
+    const collection: IndexedCollection<F> = new IndexedCollection(uniqueKey);
+
+    if (iterable) {
+      for (const i of iterable) {
+        collection.add(i);
+      }
+    }
+    return collection;
+  }
+
+  /**
+   * Event raised if an item is relocated within the collection. Is passed the moved item.
+   */
+  moved: VcsEvent<T>;
+
+  private _previousIndexSymbol: symbol;
+
+  /**
+   * @param  [uniqueKey='name'] - a key to maintain uniquely within the collection. passing false disables uniqueness.
+   */
+  constructor(uniqueKey?: keyof T | false) {
+    super(uniqueKey);
+
+    this.moved = new VcsEvent();
+
+    this._previousIndexSymbol = Symbol('previousIndex');
+  }
+
+  /**
+   * Get the symbol which is attached to an item prior to its removal. If an item is removed, the current index of the item
+   * is set on the item with this symbol.
+   */
+  get previousIndexSymbol(): symbol {
+    return this._previousIndexSymbol;
+  }
+
+  /**
+   * Returns an item at index.
+   * @param  index
+   */
+  get(index: number): T {
+    return this._array[index];
+  }
+
+  /**
+   * Adds an item to the collection. Can optionally be passed an index at which to insert the item.
+   * @param  item - the item to be inserted
+   * @param  index - an optional index at which to insert the item. clipped to the last entry
+   * @returns  the index at which the item was inserted
+   */
+  add(item: T, index?: number | null): number | null {
+    if (this._checkUniqueness(item)) {
+      let actualIndex = this._array.length;
+      if (index != null && index < this._array.length) {
+        actualIndex = index >= 0 ? index : 0;
+        this._array.splice(actualIndex, 0, item);
+      } else {
+        this._array.push(item);
+      }
+      this.added.raiseEvent(item);
+      return actualIndex;
+    }
+    return null;
+  }
+
+  remove(item: T): void {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    item[this._previousIndexSymbol] = this._array.indexOf(item);
+    super.remove(item);
+  }
+
+  protected _move(item: T, itemIndex: number, targetIndex: number): number {
+    let target = targetIndex;
+    target = target >= 0 ? target : 0;
+    target = target < this._array.length ? target : this._array.length - 1;
+    if (itemIndex !== target) {
+      this._array.splice(itemIndex, 1);
+      this._array.splice(target, 0, item);
+      this.moved.raiseEvent(item);
+    }
+    return target;
+  }
+
+  /**
+   * Moves an item to a provided index
+   * @returns  the new index of the item
+   */
+  moveTo(item: T, targetIndex: number): number | null {
+    const index = this._array.indexOf(item);
+    if (index > -1) {
+      return this._move(item, index, targetIndex);
+    }
+    return null;
+  }
+
+  /**
+   * Lowers an item within the array
+   * @param  [steps=1] - an integer number to lower by
+   * @returns  the new index of the item
+   */
+  lower(item: T, steps = 1): number | null {
+    const index = this._array.indexOf(item);
+    if (index > -1) {
+      return this._move(item, index, index - Math.ceil(steps));
+    }
+    return null;
+  }
+
+  /**
+   * Raises an item within the array
+   * @param  [steps=1] - an integer number to lower by
+   * @returns  the new index of the item
+   */
+  raise(item: T, steps = 1): number | null {
+    const index = this._array.indexOf(item);
+    if (index > -1) {
+      return this._move(item, index, index + Math.ceil(steps));
+    }
+    return null;
+  }
+
+  /**
+   * Returns the index of an item or -1 if it is not part of this collection
+   */
+  indexOf(item: T): number {
+    return this._array.indexOf(item);
+  }
+
+  /**
+   * Returns the index of a key. Returns undefined, if there is no uniqueness constraint
+   */
+  indexOfKey(value: unknown): number | undefined {
+    if (!this.uniqueKey) {
+      return undefined;
+    }
+    return this._array.findIndex((e) => e[this.uniqueKey as keyof T] === value);
+  }
+
+  destroy(): void {
+    super.destroy();
+    this.moved.destroy();
+  }
+}
+
+export default IndexedCollection;

package/src/util/{isMobile.js → isMobile.ts}

@@ -1,12 +1,18 @@
 /**
  * returns true if we are on a mobile device including tablets
- * @returns {boolean}
- * @api
  */
 // eslint-disable-next-line import/prefer-default-export
-export function isMobile() {
+export function isMobile(): boolean {
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
-  const agent = navigator.userAgent || navigator.vendor || window.opera;
-  return /(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino|android|ipad|playbook|silk/i.test(agent) ||
-    /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw-(n|u)|c55\/|capi|ccwa|cdm-|cell|chtm|cldc|cmd-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc-s|devi|dica|dmob|do(c|p)o|ds(12|-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(-|_)|g1 u|g560|gene|gf-5|g-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd-(m|p|t)|hei-|hi(pt|ta)|hp( i|ip)|hs-c|ht(c(-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i-(20|go|ma)|i230|iac( |-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|-[a-w])|libw|lynx|m1-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|-([1-8]|c))|phil|pire|pl(ay|uc)|pn-2|po(ck|rt|se)|prox|psio|pt-g|qa-a|qc(07|12|21|32|60|-[2-7]|i-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h-|oo|p-)|sdk\/|se(c(-|0|1)|47|mc|nd|ri)|sgh-|shar|sie(-|m)|sk-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h-|v-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl-|tdg-|tel(i|m)|tim-|t-mo|to(pl|sh)|ts(70|m-|m3|m5)|tx-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas-|your|zeto|zte-/i.test(agent.substr(0, 4));
+  const agent =
+    navigator.userAgent || navigator.vendor || (window.opera as string);
+  return (
+    /(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino|android|ipad|playbook|silk/i.test(
+      agent,
+    ) ||
+    /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw-(n|u)|c55\/|capi|ccwa|cdm-|cell|chtm|cldc|cmd-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc-s|devi|dica|dmob|do(c|p)o|ds(12|-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(-|_)|g1 u|g560|gene|gf-5|g-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd-(m|p|t)|hei-|hi(pt|ta)|hp( i|ip)|hs-c|ht(c(-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i-(20|go|ma)|i230|iac( |-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|-[a-w])|libw|lynx|m1-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|-([1-8]|c))|phil|pire|pl(ay|uc)|pn-2|po(ck|rt|se)|prox|psio|pt-g|qa-a|qc(07|12|21|32|60|-[2-7]|i-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h-|oo|p-)|sdk\/|se(c(-|0|1)|47|mc|nd|ri)|sgh-|shar|sie(-|m)|sk-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h-|v-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl-|tdg-|tel(i|m)|tim-|t-mo|to(pl|sh)|ts(70|m-|m3|m5)|tx-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas-|your|zeto|zte-/i.test(
+      agent.substring(0, 4),
+    )
+  );
 }

package/src/util/layerCollection.ts

@@ -0,0 +1,293 @@
+/* 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';
+// eslint-disable-next-line import/no-named-default
+import type { default as Layer, SplitLayer } 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 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<Layer> {
+  /**
+   * Creates a LayerCollection from an iterable of layers, such as an Array.
+   * @param  iterable
+   */
+  static from(iterable: Iterable<Layer>): LayerCollection {
+    const collection = new LayerCollection();
+
+    if (iterable) {
+      // eslint-disable-next-line no-restricted-syntax
+      for (const layer of iterable) {
+        collection.add(layer);
+      }
+    }
+    return collection;
+  }
+
+  private _layerEventListeners: Record<string, (() => void)[]>;
+
+  private _zIndexSymbol: symbol;
+
+  /**
+   * 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: 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: string;
+
+  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(): symbol {
+    return this._zIndexSymbol;
+  }
+
+  /**
+   * The current global hider of these layers
+   */
+  get globalHider(): GlobalHider {
+    return this._globalHider;
+  }
+
+  /**
+   * The current global hider of these layers
+   * @param  globalHider
+   */
+  set globalHider(globalHider: GlobalHider) {
+    check(globalHider, GlobalHider);
+
+    this._globalHider = globalHider;
+    this._array.forEach((layer) => {
+      layer.setGlobalHider(this._globalHider);
+    });
+  }
+
+  get locale(): string {
+    return this._locale;
+  }
+
+  set locale(value: string) {
+    check(value, String);
+
+    if (this._locale !== value) {
+      this._locale = value;
+      [...this].forEach((layer) => {
+        layer.locale = this._locale;
+      });
+    }
+  }
+
+  private _listenToLayerEvents(layer: Layer): void {
+    const stateListener = layer.stateChanged.addEventListener(
+      (state: LayerState) => {
+        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 as Layer & SplitLayer).splitDirectionChanged) {
+      listeners.push(
+        (layer as Layer & SplitLayer).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
+   */
+  private _findZIndexPosition(zIndex: number): number | null {
+    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
+   */
+  private _zIndexChanged(layer: Layer): void {
+    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.
+   */
+  private _ensureLocalZIndex(layer: Layer): void {
+    const currentIndex = this.indexOf(layer);
+    // @ts-ignore
+    const currentLayerZIndex = layer[this._zIndexSymbol] as number;
+    if (currentIndex > 0) {
+      // @ts-ignore
+      const below: number = this._array[currentIndex - 1][
+        this._zIndexSymbol
+      ] as number;
+      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] as number;
+      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: Layer, index?: number): number | null {
+    let usedIndex: number | null | undefined = 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;
+  }
+
+  protected _remove(layer: Layer): number {
+    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(): void {
+    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(): void {
+    Object.values(this._layerEventListeners)
+      .flat()
+      .forEach((r) => {
+        r();
+      });
+
+    this._layerEventListeners = {};
+    this.exclusiveManager.destroy();
+    this._globalHider.destroy();
+    super.destroy();
+  }
+}
+
+export default LayerCollection;

package/src/util/locale.ts

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