npm - @open-pioneer/map - Versions diffs - 1.3.0-dev.20260310142705 → 1.3.0-dev.20260408130821 - Mend

@open-pioneer/map 1.3.0-dev.20260310142705 → 1.3.0-dev.20260408130821

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

package/model/Overlays.d.ts CHANGED Viewed

@@ -12,63 +12,73 @@ export declare const UNREGISTER_OVERLAY: unique symbol;
  * @group Map Model
  */
 export declare class Overlays {
-    private olMap;
-    private overlays;
+    #private;
     constructor(map: MapModel);
     [REGISTER_OVERLAY](overlay: Overlay): void;
     [UNREGISTER_OVERLAY](overlay: Overlay): void;
     /**
      * Add new overlay to the map. Returns the newly created overlay instance.
      */
-    add(properties: OverlayProperties): Overlay;
+    add(options: OverlayOptions): Overlay;
     /**
-     * Returns list of all current overlays.
+     * Returns the list of all current overlays.
      */
     getAll(): Overlay[];
+    /**
+     * Destroys all overlays.
+     */
+    clear(): void;
 }
 /**
- * Properties that define the initial state of an overlay.
+ * Options that define the initial state of an overlay.
  *
  * @group Map Model
  */
-export interface OverlayProperties {
+export interface OverlayOptions {
     /**
-     * Optional, readonly tag that helps identifying the overlay instance
+     * Optional, readonly tag that helps identifying the overlay instance.
      */
     tag?: string;
     /**
      * Displayed content of the overlay.
+     *
+     * @see {@link Overlay.setContent}.
      */
     content?: ReactNode;
     /**
-     * CSS classes of the HTMLDivElement that wraps the overlay's content.
+     * CSS classes of the HTML element that wraps the overlay's content.
      */
     className?: string;
     /**
-     * Role of the HTMLDivElement that wraps the overlay's content.
+     * Role of the HTML element that wraps the overlay's content.
      */
     ariaRole?: string;
     /**
-     * If mode is `set-position` the overlay remains at the provided position. The position can be changed manually by calling `setPosition` on the overlay instance.
-     * If mode is `follow-pointer` the position is automatically updated to pointer position (coordinates) on the map.
+     * Configures the position of the overlay.
+     * The overlay is not rendered if position is `undefined` (the default).
      *
-     * By default the mode is `set-position`.
-     */
-    mode?: "set-position" | "follow-pointer";
-    /**
-     * Initial position of the overlay. Overlay is not rendered if position is `undefined`.
-     * Can be overridden immediately if `mode` is `follow-pointer`
+     * See {@link OverlayPosition} for all supported position options.
+     *
+     * The following shorthands are available:
+     * - A plain `Coordinate` array can be used to specify a static coordinate on the map.
+     * - `undefined` hides the overlay.
+     * - `"follow-pointer"` can be used as a shorthand to follow the user's cursor.
      *
-     * ToDo: Makes no sense to provide coordinate if mode is follow-pointer, How to model this with Typescript? (also setPosition of Overlay)
+     * @see {@link Overlay.setPosition} to reconfigure the position.
+     * @see {@link Overlay.currentCoordinate} to retrieve the actual position on the map.
      */
-    position?: Coordinate;
+    position?: Coordinate | "follow-pointer" | OverlayPosition;
     /**
-     * Positioning of an overlay relative to its position (coordinates).
+     * Positioning of an overlay relative to its coordinates on the map.
+     *
+     * @see {@link Overlay.setPositioning}
      */
     positioning?: OverlayPositioning;
     /**
-     * Offsets in pixels relative to the overlay`s position (coordinates).
+     * Offsets in _pixels_ relative to the overlay`s coordinates on the map.
      * The first element in the array is the horizontal offset.
+     *
+     * @see {@link Overlay.setOffset}
      */
     offset?: number[];
     /**
@@ -78,14 +88,55 @@ export interface OverlayProperties {
      */
     stopEvent?: boolean;
     /**
-     * Raw OpenLayers overlay properties. `OlOverlayOptions` override corresponding `OverlayProperties` except id and element.
+     * Raw OpenLayers overlay properties. `OlOverlayOptions` override corresponding `OverlayProperties`, except for id and element.
      *
-     * **warning** Using OpenLayers options can create inconsistencies that lead to errors. The OpenLayers API can change with updates of OpenLayers.
+     * **warning** Using OpenLayers options can create inconsistencies that lead to errors.
+     * The OpenLayers API can change with updates of OpenLayers.
      */
     advanced?: OlOverlayOptions;
 }
 /**
- * Positioning of an overlay relative to its position (coordinates).
+ * The configured position of an overlay.
+ *
+ * @group Map Model
+ */
+export type OverlayPosition =
+/** Explicit (static) coordinates on the map. */
+OverlayPositionCoordinate
+/** Update coordinates based on pointer movements on the map, useful for tooltips. */
+ | OverlayPositionFollowPointer;
+/**
+ * Automatically positions the overlay on the mouse cursor's coordinates.
+ *
+ * This can be used, for example, to implement tooltips for map interactions.
+ *
+ * @group Map Model
+ */
+export interface OverlayPositionFollowPointer {
+    kind: "follow-pointer";
+    /**
+     * The initial coordinates.
+     *
+     * Use `undefined` (the default) to hide until the first mouse event on the map.
+     */
+    initial?: Coordinate;
+}
+/**
+ * Places the overlay at the given coordinates.
+ *
+ * @group Map Model
+ */
+export interface OverlayPositionCoordinate {
+    kind: "coordinate";
+    /**
+     * The explicit coordinates of the overlay on the map.
+     *
+     * Using `undefined` hides the overlay.
+     */
+    coordinate?: Coordinate;
+}
+/**
+ * Positioning of an overlay relative to its coordinates on the map.
  *
  * @group Map Model
  */
@@ -117,9 +168,11 @@ export declare class Overlay {
      * Raw, corresponding OpenLayers overlay object.
      *
      * **warning** Manipulation of the OpenLayers object can create inconsistencies that lead to errors. The OpenLayers API can change with updates of OpenLayers.
+     *
+     * @see https://openlayers.org/en/latest/apidoc/module-ol_Overlay-Overlay.html
      */
     readonly olOverlay: OlOverlay;
-    constructor(internalTag: InternalConstructorTag, properties: OverlayProperties, parent: Overlays);
+    constructor(internalTag: InternalConstructorTag, options: OverlayOptions, parent: Overlays);
     /**
      * Destroys the overlay and removes it from the map.
      * An overlay that is destroyed cannot be added to the map again.
@@ -130,23 +183,41 @@ export declare class Overlay {
      */
     get isDestroyed(): boolean;
     /**
-     * The content of the overlay that is currently rendered.
+     * Current coordinates of the overlay on the map.
+     *
+     * The coordinates on the map are configured via {@link OverlayOptions.position} or {@link setPosition}.
+     *
+     * - If configured with static coordinates (i.e. `position.kind === "coordinate"`), this is
+     *   the same as `position.coordinate`.
+     * - If configured with `"follow-pointer"` position, this is the result of the user's pointer movements.
      */
-    get content(): ReactNode;
+    get currentCoordinate(): Coordinate | undefined;
     /**
-     * Current position (coordinates) of the overlay.
+     * The content of the overlay that is currently rendered.
      */
-    get position(): Coordinate | undefined;
+    get content(): ReactNode;
     /**
-     * The HTMLDivElement that that wraps the overlay's content.
+     * The HTML element that that wraps the overlay's content.
      */
     get element(): HTMLElement;
     /**
-     * Offsets in pixels relative to the overlay`s position. The first element in the array is the horizontal offset.
+     * Offset in _pixels_ relative to the overlay`s coordinates.
+     *
+     * The first element in the array is the horizontal offset.
      */
     get offset(): number[];
     /**
-     * Positioning of an overlay relative to its position (coordinates).
+     * The configured position of the overlay on the map.
+     *
+     * See also {@link currentCoordinate} to get the coordinate
+     * that are the result of this configuration.
+     *
+     * > NOTE: The return value of the getter may not be the same
+     * > as the input to the setter (or constructor) due to normalization.
+     */
+    get position(): OverlayPosition;
+    /**
+     * Positioning of an overlay relative to its coordinates on the map.
      */
     get positioning(): OverlayPositioning;
     /**
@@ -154,17 +225,24 @@ export declare class Overlay {
      */
     setContent(content: ReactNode): void;
     /**
-     * Set the coordinates of the overlay. The overlay is not rendered if the position is `undefined`.
+     * Set the position of the overlay.
+     *
+     * This controls the coordinates of the map.
+     * The overlay is not rendered if the coordinates are `undefined`.
      *
-     * Can be overridden immediately if the overlay's `mode` is `follow-pointer` (see {@link OverlayProperties}).
+     * See also {@link currentCoordinate} to get the coordinates
+     * that are the result of this configuration.
+     *
+     * @see {@link OverlayPosition}
      */
-    setPosition(position: Coordinate | undefined): void;
+    setPosition(position: OverlayOptions["position"]): void;
     /**
-     * Set offset in pixels relative to the overlay`s position. The first element in the array is the horizontal offset.
+     * Set offset in _pixels_ relative to the overlay`s coordinates on the map.
+     * The first element in the array is the horizontal offset.
      */
     setOffset(offset: number[]): void;
     /**
-     * Set positioning of an overlay relative to its position (coordinates)
+     * Set positioning of an overlay relative to its coordinates on the map.
      */
     setPositioning(positioning: OverlayPositioning): void;
 }

package/model/Overlays.js CHANGED Viewed

@@ -1,5 +1,5 @@
 import { Overlay as Overlay$1 } from 'ol';
-import { reactiveSet, reactive, synchronized, batch } from '@conterra/reactivity-core';
+import { reactiveSet, reactive, synchronized, watchValue, batch } from '@conterra/reactivity-core';
 import { v4 } from 'uuid';
 import { createLogger, destroyResources } from '@open-pioneer/core';
 import { unByKey } from 'ol/Observable.js';
@@ -10,37 +10,45 @@ const REGISTER_OVERLAY = /* @__PURE__ */ Symbol("REGISTER_OVERLAY");
 const UNREGISTER_OVERLAY = /* @__PURE__ */ Symbol("UNREGISTER_OVERLAY");
 const LOG = createLogger(sourceId);
 class Overlays {
-  olMap;
-  overlays = reactiveSet();
+  #olMap;
+  #overlays = reactiveSet();
   constructor(map) {
-    this.olMap = map.olMap;
+    this.#olMap = map.olMap;
   }
   [REGISTER_OVERLAY](overlay) {
-    if (this.overlays.has(overlay)) {
+    if (this.#overlays.has(overlay)) {
       throw new Error("Internal error: overlay is already registered");
     }
-    this.overlays.add(overlay);
-    this.olMap.addOverlay(overlay.olOverlay);
+    this.#overlays.add(overlay);
+    this.#olMap.addOverlay(overlay.olOverlay);
   }
   [UNREGISTER_OVERLAY](overlay) {
-    if (!this.overlays.has(overlay)) {
+    if (!this.#overlays.has(overlay)) {
       throw new Error("Internal error: overlay was not registered");
     }
-    this.overlays.delete(overlay);
-    this.olMap.removeOverlay(overlay.olOverlay);
+    this.#overlays.delete(overlay);
+    this.#olMap.removeOverlay(overlay.olOverlay);
   }
   /**
    * Add new overlay to the map. Returns the newly created overlay instance.
    */
-  add(properties) {
-    const newModel = new Overlay(INTERNAL_CONSTRUCTOR_TAG, properties, this);
+  add(options) {
+    const newModel = new Overlay(INTERNAL_CONSTRUCTOR_TAG, options, this);
     return newModel;
   }
   /**
-   * Returns list of all current overlays.
+   * Returns the list of all current overlays.
    */
   getAll() {
-    return Array.from(this.overlays);
+    return Array.from(this.#overlays);
+  }
+  /**
+   * Destroys all overlays.
+   */
+  clear() {
+    for (const overlay of this.#overlays) {
+      overlay.destroy();
+    }
   }
 }
 class Overlay {
@@ -58,14 +66,17 @@ class Overlay {
    * Raw, corresponding OpenLayers overlay object.
    *
    * **warning** Manipulation of the OpenLayers object can create inconsistencies that lead to errors. The OpenLayers API can change with updates of OpenLayers.
+   *
+   * @see https://openlayers.org/en/latest/apidoc/module-ol_Overlay-Overlay.html
    */
   olOverlay;
   #parent;
   #isDestroyed = reactive(false);
+  #position = reactive({ kind: "coordinate" });
   #content;
-  #resources;
   #overlayDiv;
-  #position = synchronized(
+  #resources = [];
+  #coordinate = synchronized(
     () => this.olOverlay.getPosition(),
     (cb) => {
       const key = this.olOverlay.on("change:position", cb);
@@ -86,40 +97,61 @@ class Overlay {
       return () => unByKey(key);
     }
   );
-  constructor(internalTag, properties, parent) {
+  constructor(internalTag, options, parent) {
     if (internalTag !== INTERNAL_CONSTRUCTOR_TAG) {
       throw new Error("The overlay constructor is private.");
     }
-    const { className, ariaRole, mode, ...copyProperties } = properties;
+    const {
+      className,
+      ariaRole,
+      position,
+      tag,
+      content,
+      offset,
+      positioning,
+      stopEvent,
+      advanced
+    } = options;
     this.id = v4();
-    this.tag = properties.tag;
+    this.tag = tag;
     this.#overlayDiv = createElement(ariaRole, className);
-    if (!properties.mode) {
-      properties.mode = "set-position";
-    }
-    const mergedProperties = !copyProperties.advanced ? copyProperties : { ...copyProperties, ...copyProperties.advanced };
     this.olOverlay = new Overlay$1({
       element: this.#overlayDiv,
       id: this.id,
-      ...mergedProperties
+      offset,
+      positioning,
+      stopEvent,
+      //simply override with advanced OL Options if set
+      ...advanced
     });
     this.#parent = parent;
-    this.#content = reactive(properties.content);
-    this.#resources = [];
+    this.#content = reactive(content);
+    this.setPosition(position);
     parent[REGISTER_OVERLAY](this);
-    if (mode === "follow-pointer") {
-      const olMap = this.olOverlay.getMap();
-      if (!olMap) {
-        LOG.error(`Error: Overlay ${this.olOverlay.getId()} is not registered at a map.`);
-        return;
-      }
-      const pointerMoveKey = olMap.on("pointermove", (e) => {
-        this.setPosition(e.coordinate);
-      });
-      this.#resources.push({
-        destroy: () => unByKey(pointerMoveKey)
-      });
-    }
+    this.#resources.push(
+      // Update coordinate based on pointer movements when configured.
+      // Automatically subscribes and unsubscribes on changes.
+      watchValue(
+        () => this.#position.value?.kind === "follow-pointer",
+        (followPointer) => {
+          if (!followPointer) {
+            return;
+          }
+          const olMap = this.olOverlay.getMap();
+          if (!olMap) {
+            LOG.error(
+              `Overlay ${this.olOverlay.getId()} is not registered with a map.`
+            );
+            return;
+          }
+          const pointerMoveKey = olMap.on("pointermove", (e) => {
+            this.olOverlay.setPosition(e.coordinate);
+          });
+          return () => unByKey(pointerMoveKey);
+        },
+        { immediate: true, dispatch: "sync" }
+      )
+    );
   }
   /**
    * Destroys the overlay and removes it from the map.
@@ -143,31 +175,51 @@ class Overlay {
     return this.#isDestroyed.value;
   }
   /**
-   * The content of the overlay that is currently rendered.
+   * Current coordinates of the overlay on the map.
+   *
+   * The coordinates on the map are configured via {@link OverlayOptions.position} or {@link setPosition}.
+   *
+   * - If configured with static coordinates (i.e. `position.kind === "coordinate"`), this is
+   *   the same as `position.coordinate`.
+   * - If configured with `"follow-pointer"` position, this is the result of the user's pointer movements.
    */
-  get content() {
-    return this.#content.value;
+  get currentCoordinate() {
+    return this.#coordinate.value;
   }
   /**
-   * Current position (coordinates) of the overlay.
+   * The content of the overlay that is currently rendered.
    */
-  get position() {
-    return this.#position.value;
+  get content() {
+    return this.#content.value;
   }
   /**
-   * The HTMLDivElement that that wraps the overlay's content.
+   * The HTML element that that wraps the overlay's content.
    */
   get element() {
     return this.#overlayDiv;
   }
   /**
-   * Offsets in pixels relative to the overlay`s position. The first element in the array is the horizontal offset.
+   * Offset in _pixels_ relative to the overlay`s coordinates.
+   *
+   * The first element in the array is the horizontal offset.
    */
   get offset() {
     return this.#offset.value;
   }
   /**
-   * Positioning of an overlay relative to its position (coordinates).
+   * The configured position of the overlay on the map.
+   *
+   * See also {@link currentCoordinate} to get the coordinate
+   * that are the result of this configuration.
+   *
+   * > NOTE: The return value of the getter may not be the same
+   * > as the input to the setter (or constructor) due to normalization.
+   */
+  get position() {
+    return this.#position.value;
+  }
+  /**
+   * Positioning of an overlay relative to its coordinates on the map.
    */
   get positioning() {
     return this.#positioning.value;
@@ -179,26 +231,57 @@ class Overlay {
     this.#content.value = content;
   }
   /**
-   * Set the coordinates of the overlay. The overlay is not rendered if the position is `undefined`.
+   * Set the position of the overlay.
+   *
+   * This controls the coordinates of the map.
+   * The overlay is not rendered if the coordinates are `undefined`.
    *
-   * Can be overridden immediately if the overlay's `mode` is `follow-pointer` (see {@link OverlayProperties}).
+   * See also {@link currentCoordinate} to get the coordinates
+   * that are the result of this configuration.
+   *
+   * @see {@link OverlayPosition}
    */
   setPosition(position) {
-    this.olOverlay.setPosition(position);
+    const normalized = normalizePosition(position);
+    let newCoordinate;
+    if (normalized) {
+      if (normalized.kind === "coordinate") {
+        newCoordinate = normalized.coordinate;
+      } else {
+        newCoordinate = normalized.initial;
+      }
+    }
+    batch(() => {
+      this.#position.value = normalized;
+      this.olOverlay.setPosition(newCoordinate);
+    });
   }
   /**
-   * Set offset in pixels relative to the overlay`s position. The first element in the array is the horizontal offset.
+   * Set offset in _pixels_ relative to the overlay`s coordinates on the map.
+   * The first element in the array is the horizontal offset.
    */
   setOffset(offset) {
     this.olOverlay.setOffset(offset);
   }
   /**
-   * Set positioning of an overlay relative to its position (coordinates)
+   * Set positioning of an overlay relative to its coordinates on the map.
    */
   setPositioning(positioning) {
     this.olOverlay.setPositioning(positioning);
   }
 }
+function normalizePosition(position) {
+  if (!position || Array.isArray(position)) {
+    return { kind: "coordinate", coordinate: position };
+  }
+  if (position === "follow-pointer") {
+    return { kind: "follow-pointer" };
+  }
+  if (typeof position !== "object") {
+    throw new Error("Unexpected position: " + position);
+  }
+  return position;
+}
 function createElement(ariaRole, classNameProp) {
   const overlayDiv = document.createElement("div");
   if (ariaRole) {

package/model/Overlays.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"Overlays.js","sources":["Overlays.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\n\nimport { Map as OlMap, Overlay as OlOverlay } from \"ol\";\nimport { MapModel } from \"./MapModel\";\nimport { Coordinate } from \"ol/coordinate\";\nimport { ReactNode } from \"react\";\nimport { batch, reactive, Reactive, reactiveSet, synchronized } from \"@conterra/reactivity-core\";\nimport { v4 as uuid4v } from \"uuid\";\nimport { createLogger, destroyResources, Resource } from \"@open-pioneer/core\";\nimport { EventsKey } from \"ol/events\";\nimport { unByKey } from \"ol/Observable\";\nimport { Options } from \"ol/Overlay\";\nimport { sourceId } from \"open-pioneer:source-info\";\nimport { INTERNAL_CONSTRUCTOR_TAG, InternalConstructorTag } from \"../utils/InternalConstructorTag\";\n\nexport const REGISTER_OVERLAY = Symbol(\"REGISTER_OVERLAY\");\nexport const UNREGISTER_OVERLAY = Symbol(\"UNREGISTER_OVERLAY\");\n\nconst LOG = createLogger(sourceId);\n\n/*\n Manages active overlays on the map.\n \n @group Map Model\n /\nexport class Overlays {\n private olMap: OlMap;\n private overlays = reactiveSet<Overlay>();\n\n constructor(map: MapModel) {\n this.olMap = map.olMap;\n }\n\n [REGISTER_OVERLAY](overlay: Overlay) {\n if (this.overlays.has(overlay)) {\n throw new Error(\"Internal error: overlay is already registered\");\n }\n this.overlays.add(overlay);\n this.olMap.addOverlay(overlay.olOverlay);\n }\n\n [UNREGISTER_OVERLAY](overlay: Overlay) {\n if (!this.overlays.has(overlay)) {\n throw new Error(\"Internal error: overlay was not registered\");\n }\n this.overlays.delete(overlay);\n this.olMap.removeOverlay(overlay.olOverlay);\n }\n\n /\n Add new overlay to the map. Returns the newly created overlay instance.\n /\n add(properties: OverlayProperties): Overlay {\n const newModel = new Overlay(INTERNAL_CONSTRUCTOR_TAG, properties, this);\n return newModel;\n }\n\n /\n Returns list of all current overlays.\n /\n getAll(): Overlay[] {\n return Array.from(this.overlays);\n }\n}\n\n/\n Properties that define the initial state of an overlay.\n \n @group Map Model\n /\nexport interface OverlayProperties {\n /\n Optional, readonly tag that helps identifying the overlay instance\n /\n tag?: string;\n\n /\n Displayed content of the overlay.\n /\n content?: ReactNode;\n\n /\n CSS classes of the HTMLDivElement that wraps the overlay's content.\n /\n className?: string;\n\n /\n Role of the HTMLDivElement that wraps the overlay's content.\n /\n ariaRole?: string;\n\n /\n If mode is `set-position` the overlay remains at the provided position. The position can be changed manually by calling `setPosition` on the overlay instance.\n * If mode is `follow-pointer` the position is automatically updated to pointer position (coordinates) on the map.\n \n By default the mode is `set-position`.\n /\n mode?: \"set-position\" \| \"follow-pointer\"; //ToDo there might be a better name instead of set-position\n\n /\n Initial position of the overlay. Overlay is not rendered if position is `undefined`.\n * Can be overridden immediately if `mode` is `follow-pointer`\n \n ToDo: Makes no sense to provide coordinate if mode is follow-pointer, How to model this with Typescript? (also setPosition of Overlay)\n /\n position?: Coordinate;\n\n /\n Positioning of an overlay relative to its position (coordinates).\n /\n positioning?: OverlayPositioning;\n\n /\n Offsets in pixels relative to the overlay`s position (coordinates).\n * The first element in the array is the horizontal offset.\n /\n offset?: number[];\n\n /\n Determines if event propagation to the map viewport should be stopped.\n \n By default `stopEvent` is `true`.\n /\n stopEvent?: boolean;\n\n /\n Raw OpenLayers overlay properties. `OlOverlayOptions` override corresponding `OverlayProperties` except id and element.\n \n warning Using OpenLayers options can create inconsistencies that lead to errors. The OpenLayers API can change with updates of OpenLayers.\n /\n advanced?: OlOverlayOptions; //raw OL properties, overrides mutual properties from outer OverlayProperties (except id and element?)\n}\n\n/\n Positioning of an overlay relative to its position (coordinates).\n \n @group Map Model\n /\nexport type OverlayPositioning =\n \| \"bottom-left\"\n \| \"bottom-center\"\n \| \"bottom-right\"\n \| \"center-left\"\n \| \"center-center\"\n \| \"center-right\"\n \| \"top-left\"\n \| \"top-center\"\n \| \"top-right\";\n\n/* @group Map Model /\nexport interface OlOverlayOptions extends Omit<Partial<Options>, \"id\" \| \"element\"> {}\n\n/\n An overlay is an UI element that is displayed over the map.\n \n Overlays are tied to coordinates on the map and not to a position on the screen.\n * The overlay renders a react node at the specified coordinates.\n \n @group Map Model\n /\nexport class Overlay {\n /\n Unique, readonly id of the overlay.\n \n Automatically assigned when the overlay is created. Use the `tag` property for custom identifiers.\n /\n readonly id: string;\n\n /\n Optional, readonly tag that helps identifying the overlay instance.\n /\n readonly tag: string \| undefined;\n\n /\n Raw, corresponding OpenLayers overlay object.\n \n warning Manipulation of the OpenLayers object can create inconsistencies that lead to errors. The OpenLayers API can change with updates of OpenLayers.\n /\n readonly olOverlay: OlOverlay;\n\n #parent: Overlays;\n #isDestroyed = reactive(false);\n #content: Reactive<ReactNode>;\n #resources: Resource[];\n #overlayDiv: HTMLDivElement;\n\n #position = synchronized(\n () => this.olOverlay.getPosition(),\n (cb) => {\n const key = this.olOverlay.on(\"change:position\", cb);\n return () => unByKey(key);\n }\n );\n #positioning = synchronized(\n () => this.olOverlay.getPositioning(),\n (cb) => {\n const key = this.olOverlay.on(\"change:positioning\", cb);\n return () => unByKey(key);\n }\n );\n #offset = synchronized(\n () => this.olOverlay.getOffset(),\n (cb) => {\n const key = this.olOverlay.on(\"change:offset\", cb);\n return () => unByKey(key);\n }\n );\n\n constructor(\n internalTag: InternalConstructorTag,\n properties: OverlayProperties,\n parent: Overlays\n ) {\n if (internalTag !== INTERNAL_CONSTRUCTOR_TAG) {\n throw new Error(\"The overlay constructor is private.\");\n }\n\n const { className, ariaRole, mode, ...copyProperties } = properties;\n this.id = uuid4v();\n this.tag = properties.tag;\n this.#overlayDiv = createElement(ariaRole, className);\n\n if (!properties.mode) {\n properties.mode = \"set-position\";\n }\n\n //simply override with advanced OL Options if set\n const mergedProperties = !copyProperties.advanced\n ? copyProperties\n : { ...copyProperties, ...copyProperties.advanced };\n\n this.olOverlay = new OlOverlay({\n element: this.#overlayDiv,\n id: this.id,\n ...mergedProperties\n });\n this.#parent = parent;\n this.#content = reactive(properties.content);\n this.#resources = [];\n\n parent[REGISTER_OVERLAY](this);\n\n if (mode === \"follow-pointer\") {\n //olMap is set after registration\n const olMap = this.olOverlay.getMap();\n if (!olMap) {\n LOG.error(`Error: Overlay ${this.olOverlay.getId()} is not registered at a map.`);\n return;\n }\n\n const pointerMoveKey: EventsKey = olMap.on(\"pointermove\", (e) => {\n this.setPosition(e.coordinate);\n });\n this.#resources.push({\n destroy: () => unByKey(pointerMoveKey)\n });\n }\n }\n\n /\n Destroys the overlay and removes it from the map.\n * An overlay that is destroyed cannot be added to the map again.\n /\n destroy(): void {\n if (this.isDestroyed) {\n return;\n }\n\n batch(() => {\n this.#isDestroyed.value = true;\n this.#parent[UNREGISTER_OVERLAY](this);\n this.olOverlay.dispose();\n destroyResources(this.#resources);\n });\n }\n\n /\n Indicates if the overlay instance has been destroyed.\n /\n get isDestroyed(): boolean {\n return this.#isDestroyed.value;\n }\n\n /\n The content of the overlay that is currently rendered.\n /\n get content(): ReactNode {\n return this.#content.value;\n }\n\n /\n Current position (coordinates) of the overlay.\n /\n get position(): Coordinate \| undefined {\n return this.#position.value;\n }\n\n /\n The HTMLDivElement that that wraps the overlay's content.\n /\n get element(): HTMLElement {\n return this.#overlayDiv;\n }\n\n /\n Offsets in pixels relative to the overlay`s position. The first element in the array is the horizontal offset.\n /\n get offset(): number[] {\n return this.#offset.value;\n }\n\n /\n Positioning of an overlay relative to its position (coordinates).\n /\n get positioning(): OverlayPositioning {\n return this.#positioning.value;\n }\n\n /\n Set new content that is rendered on the overlay.\n /\n setContent(content: ReactNode): void {\n this.#content.value = content;\n }\n\n /\n Set the coordinates of the overlay. The overlay is not rendered if the position is `undefined`.\n \n Can be overridden immediately if the overlay's `mode` is `follow-pointer` (see {@link OverlayProperties}).\n /\n setPosition(position: Coordinate \| undefined) {\n this.olOverlay.setPosition(position);\n }\n\n /\n Set offset in pixels relative to the overlay`s position. The first element in the array is the horizontal offset.\n /\n setOffset(offset: number[]) {\n this.olOverlay.setOffset(offset);\n }\n\n /\n Set positioning of an overlay relative to its position (coordinates)\n */\n setPositioning(positioning: OverlayPositioning) {\n this.olOverlay.setPositioning(positioning);\n }\n}\n\nfunction createElement(ariaRole: string \| undefined, classNameProp: string \| undefined) {\n const overlayDiv = document.createElement(\"div\");\n if (ariaRole) {\n overlayDiv.role = ariaRole;\n }\n\n let className = \"map-overlay\";\n if (classNameProp) {\n className += ` ${classNameProp}`;\n }\n overlayDiv.className = className;\n return overlayDiv;\n}\n"],"names":["uuid4v","OlOverlay"],"mappings":";;;;;;;;AAgBO,MAAM,gBAAA,0BAA0B,kBAAkB,CAAA;AAClD,MAAM,kBAAA,0BAA4B,oBAAoB,CAAA;AAE7D,MAAM,GAAA,GAAM,aAAa,QAAQ,CAAA;AAO1B,MAAM,QAAA,CAAS;AAAA,EACV,KAAA;AAAA,EACA,WAAW,WAAA,EAAqB;AAAA,EAExC,YAAY,GAAA,EAAe;AACvB,IAAA,IAAA,CAAK,QAAQ,GAAA,CAAI,KAAA;AAAA,EACrB;AAAA,EAEA,CAAC,gBAAgB,CAAA,CAAE,OAAA,EAAkB;AACjC,IAAA,IAAI,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,OAAO,CAAA,EAAG;AAC5B,MAAA,MAAM,IAAI,MAAM,+CAA+C,CAAA;AAAA,IACnE;AACA,IAAA,IAAA,CAAK,QAAA,CAAS,IAAI,OAAO,CAAA;AACzB,IAAA,IAAA,CAAK,KAAA,CAAM,UAAA,CAAW,OAAA,CAAQ,SAAS,CAAA;AAAA,EAC3C;AAAA,EAEA,CAAC,kBAAkB,CAAA,CAAE,OAAA,EAAkB;AACnC,IAAA,IAAI,CAAC,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,OAAO,CAAA,EAAG;AAC7B,MAAA,MAAM,IAAI,MAAM,4CAA4C,CAAA;AAAA,IAChE;AACA,IAAA,IAAA,CAAK,QAAA,CAAS,OAAO,OAAO,CAAA;AAC5B,IAAA,IAAA,CAAK,KAAA,CAAM,aAAA,CAAc,OAAA,CAAQ,SAAS,CAAA;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,UAAA,EAAwC;AACxC,IAAA,MAAM,QAAA,GAAW,IAAI,OAAA,CAAQ,wBAAA,EAA0B,YAAY,IAAI,CAAA;AACvE,IAAA,OAAO,QAAA;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAKA,MAAA,GAAoB;AAChB,IAAA,OAAO,KAAA,CAAM,IAAA,CAAK,IAAA,CAAK,QAAQ,CAAA;AAAA,EACnC;AACJ;AAiGO,MAAM,OAAA,CAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMR,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA,EAET,OAAA;AAAA,EACA,YAAA,GAAe,SAAS,KAAK,CAAA;AAAA,EAC7B,QAAA;AAAA,EACA,UAAA;AAAA,EACA,WAAA;AAAA,EAEA,SAAA,GAAY,YAAA;AAAA,IACR,MAAM,IAAA,CAAK,SAAA,CAAU,WAAA,EAAY;AAAA,IACjC,CAAC,EAAA,KAAO;AACJ,MAAA,MAAM,GAAA,GAAM,IAAA,CAAK,SAAA,CAAU,EAAA,CAAG,mBAAmB,EAAE,CAAA;AACnD,MAAA,OAAO,MAAM,QAAQ,GAAG,CAAA;AAAA,IAC5B;AAAA,GACJ;AAAA,EACA,YAAA,GAAe,YAAA;AAAA,IACX,MAAM,IAAA,CAAK,SAAA,CAAU,cAAA,EAAe;AAAA,IACpC,CAAC,EAAA,KAAO;AACJ,MAAA,MAAM,GAAA,GAAM,IAAA,CAAK,SAAA,CAAU,EAAA,CAAG,sBAAsB,EAAE,CAAA;AACtD,MAAA,OAAO,MAAM,QAAQ,GAAG,CAAA;AAAA,IAC5B;AAAA,GACJ;AAAA,EACA,OAAA,GAAU,YAAA;AAAA,IACN,MAAM,IAAA,CAAK,SAAA,CAAU,SAAA,EAAU;AAAA,IAC/B,CAAC,EAAA,KAAO;AACJ,MAAA,MAAM,GAAA,GAAM,IAAA,CAAK,SAAA,CAAU,EAAA,CAAG,iBAAiB,EAAE,CAAA;AACjD,MAAA,OAAO,MAAM,QAAQ,GAAG,CAAA;AAAA,IAC5B;AAAA,GACJ;AAAA,EAEA,WAAA,CACI,WAAA,EACA,UAAA,EACA,MAAA,EACF;AACE,IAAA,IAAI,gBAAgB,wBAAA,EAA0B;AAC1C,MAAA,MAAM,IAAI,MAAM,qCAAqC,CAAA;AAAA,IACzD;AAEA,IAAA,MAAM,EAAE,SAAA,EAAW,QAAA,EAAU,IAAA,EAAM,GAAG,gBAAe,GAAI,UAAA;AACzD,IAAA,IAAA,CAAK,KAAKA,EAAA,EAAO;AACjB,IAAA,IAAA,CAAK,MAAM,UAAA,CAAW,GAAA;AACtB,IAAA,IAAA,CAAK,WAAA,GAAc,aAAA,CAAc,QAAA,EAAU,SAAS,CAAA;AAEpD,IAAA,IAAI,CAAC,WAAW,IAAA,EAAM;AAClB,MAAA,UAAA,CAAW,IAAA,GAAO,cAAA;AAAA,IACtB;AAGA,IAAA,MAAM,gBAAA,GAAmB,CAAC,cAAA,CAAe,QAAA,GACnC,cAAA,GACA,EAAE,GAAG,cAAA,EAAgB,GAAG,cAAA,CAAe,QAAA,EAAS;AAEtD,IAAA,IAAA,CAAK,SAAA,GAAY,IAAIC,SAAA,CAAU;AAAA,MAC3B,SAAS,IAAA,CAAK,WAAA;AAAA,MACd,IAAI,IAAA,CAAK,EAAA;AAAA,MACT,GAAG;AAAA,KACN,CAAA;AACD,IAAA,IAAA,CAAK,OAAA,GAAU,MAAA;AACf,IAAA,IAAA,CAAK,QAAA,GAAW,QAAA,CAAS,UAAA,CAAW,OAAO,CAAA;AAC3C,IAAA,IAAA,CAAK,aAAa,EAAC;AAEnB,IAAA,MAAA,CAAO,gBAAgB,EAAE,IAAI,CAAA;AAE7B,IAAA,IAAI,SAAS,gBAAA,EAAkB;AAE3B,MAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,SAAA,CAAU,MAAA,EAAO;AACpC,MAAA,IAAI,CAAC,KAAA,EAAO;AACR,QAAA,GAAA,CAAI,MAAM,CAAA,eAAA,EAAkB,IAAA,CAAK,SAAA,CAAU,KAAA,EAAO,CAAA,4BAAA,CAA8B,CAAA;AAChF,QAAA;AAAA,MACJ;AAEA,MAAA,MAAM,cAAA,GAA4B,KAAA,CAAM,EAAA,CAAG,aAAA,EAAe,CAAC,CAAA,KAAM;AAC7D,QAAA,IAAA,CAAK,WAAA,CAAY,EAAE,UAAU,CAAA;AAAA,MACjC,CAAC,CAAA;AACD,MAAA,IAAA,CAAK,WAAW,IAAA,CAAK;AAAA,QACjB,OAAA,EAAS,MAAM,OAAA,CAAQ,cAAc;AAAA,OACxC,CAAA;AAAA,IACL;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAA,GAAgB;AACZ,IAAA,IAAI,KAAK,WAAA,EAAa;AAClB,MAAA;AAAA,IACJ;AAEA,IAAA,KAAA,CAAM,MAAM;AACR,MAAA,IAAA,CAAK,aAAa,KAAA,GAAQ,IAAA;AAC1B,MAAA,IAAA,CAAK,OAAA,CAAQ,kBAAkB,CAAA,CAAE,IAAI,CAAA;AACrC,MAAA,IAAA,CAAK,UAAU,OAAA,EAAQ;AACvB,MAAA,gBAAA,CAAiB,KAAK,UAAU,CAAA;AAAA,IACpC,CAAC,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,WAAA,GAAuB;AACvB,IAAA,OAAO,KAAK,YAAA,CAAa,KAAA;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,OAAA,GAAqB;AACrB,IAAA,OAAO,KAAK,QAAA,CAAS,KAAA;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,QAAA,GAAmC;AACnC,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,OAAA,GAAuB;AACvB,IAAA,OAAO,IAAA,CAAK,WAAA;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,MAAA,GAAmB;AACnB,IAAA,OAAO,KAAK,OAAA,CAAQ,KAAA;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,WAAA,GAAkC;AAClC,IAAA,OAAO,KAAK,YAAA,CAAa,KAAA;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA,EAKA,WAAW,OAAA,EAA0B;AACjC,IAAA,IAAA,CAAK,SAAS,KAAA,GAAQ,OAAA;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,YAAY,QAAA,EAAkC;AAC1C,IAAA,IAAA,CAAK,SAAA,CAAU,YAAY,QAAQ,CAAA;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA,EAKA,UAAU,MAAA,EAAkB;AACxB,IAAA,IAAA,CAAK,SAAA,CAAU,UAAU,MAAM,CAAA;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA,EAKA,eAAe,WAAA,EAAiC;AAC5C,IAAA,IAAA,CAAK,SAAA,CAAU,eAAe,WAAW,CAAA;AAAA,EAC7C;AACJ;AAEA,SAAS,aAAA,CAAc,UAA8B,aAAA,EAAmC;AACpF,EAAA,MAAM,UAAA,GAAa,QAAA,CAAS,aAAA,CAAc,KAAK,CAAA;AAC/C,EAAA,IAAI,QAAA,EAAU;AACV,IAAA,UAAA,CAAW,IAAA,GAAO,QAAA;AAAA,EACtB;AAEA,EAAA,IAAI,SAAA,GAAY,aAAA;AAChB,EAAA,IAAI,aAAA,EAAe;AACf,IAAA,SAAA,IAAa,IAAI,aAAa,CAAA,CAAA;AAAA,EAClC;AACA,EAAA,UAAA,CAAW,SAAA,GAAY,SAAA;AACvB,EAAA,OAAO,UAAA;AACX;;;;"}
1	+ {"version":3,"file":"Overlays.js","sources":["Overlays.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\n\nimport { Map as OlMap, Overlay as OlOverlay } from \"ol\";\nimport { MapModel } from \"./MapModel\";\nimport { Coordinate } from \"ol/coordinate\";\nimport { ReactNode } from \"react\";\nimport {\n batch,\n reactive,\n Reactive,\n reactiveSet,\n synchronized,\n watchValue\n} from \"@conterra/reactivity-core\";\nimport { v4 as uuid4v } from \"uuid\";\nimport { createLogger, destroyResources, Resource } from \"@open-pioneer/core\";\nimport { EventsKey } from \"ol/events\";\nimport { unByKey } from \"ol/Observable\";\nimport { Options } from \"ol/Overlay\";\nimport { sourceId } from \"open-pioneer:source-info\";\nimport { INTERNAL_CONSTRUCTOR_TAG, InternalConstructorTag } from \"../utils/InternalConstructorTag\";\n\nexport const REGISTER_OVERLAY = Symbol(\"REGISTER_OVERLAY\");\nexport const UNREGISTER_OVERLAY = Symbol(\"UNREGISTER_OVERLAY\");\n\nconst LOG = createLogger(sourceId);\n\n/*\n Manages active overlays on the map.\n \n @group Map Model\n /\nexport class Overlays {\n #olMap: OlMap;\n #overlays = reactiveSet<Overlay>();\n\n constructor(map: MapModel) {\n this.#olMap = map.olMap;\n }\n\n [REGISTER_OVERLAY](overlay: Overlay) {\n if (this.#overlays.has(overlay)) {\n throw new Error(\"Internal error: overlay is already registered\");\n }\n this.#overlays.add(overlay);\n this.#olMap.addOverlay(overlay.olOverlay);\n }\n\n [UNREGISTER_OVERLAY](overlay: Overlay) {\n if (!this.#overlays.has(overlay)) {\n throw new Error(\"Internal error: overlay was not registered\");\n }\n this.#overlays.delete(overlay);\n this.#olMap.removeOverlay(overlay.olOverlay);\n }\n\n /\n Add new overlay to the map. Returns the newly created overlay instance.\n /\n add(options: OverlayOptions): Overlay {\n const newModel = new Overlay(INTERNAL_CONSTRUCTOR_TAG, options, this);\n return newModel;\n }\n\n /\n Returns the list of all current overlays.\n /\n getAll(): Overlay[] {\n return Array.from(this.#overlays);\n }\n\n /\n Destroys all overlays.\n /\n clear(): void {\n for (const overlay of this.#overlays) {\n overlay.destroy();\n }\n }\n}\n\n/\n Options that define the initial state of an overlay.\n \n @group Map Model\n /\nexport interface OverlayOptions {\n /\n Optional, readonly tag that helps identifying the overlay instance.\n /\n tag?: string;\n\n /\n Displayed content of the overlay.\n \n @see {@link Overlay.setContent}.\n /\n content?: ReactNode;\n\n /\n CSS classes of the HTML element that wraps the overlay's content.\n /\n className?: string;\n\n /\n Role of the HTML element that wraps the overlay's content.\n /\n ariaRole?: string;\n\n /\n Configures the position of the overlay.\n * The overlay is not rendered if position is `undefined` (the default).\n \n See {@link OverlayPosition} for all supported position options.\n \n The following shorthands are available:\n * - A plain `Coordinate` array can be used to specify a static coordinate on the map.\n * - `undefined` hides the overlay.\n * - `\"follow-pointer\"` can be used as a shorthand to follow the user's cursor.\n \n @see {@link Overlay.setPosition} to reconfigure the position.\n * @see {@link Overlay.currentCoordinate} to retrieve the actual position on the map.\n /\n position?: Coordinate \| \"follow-pointer\" \| OverlayPosition;\n\n /\n Positioning of an overlay relative to its coordinates on the map.\n \n @see {@link Overlay.setPositioning}\n /\n positioning?: OverlayPositioning;\n\n /\n Offsets in _pixels_ relative to the overlay`s coordinates on the map.\n * The first element in the array is the horizontal offset.\n \n @see {@link Overlay.setOffset}\n /\n offset?: number[];\n\n /\n Determines if event propagation to the map viewport should be stopped.\n \n By default `stopEvent` is `true`.\n /\n stopEvent?: boolean;\n\n /\n Raw OpenLayers overlay properties. `OlOverlayOptions` override corresponding `OverlayProperties`, except for id and element.\n \n warning Using OpenLayers options can create inconsistencies that lead to errors.\n * The OpenLayers API can change with updates of OpenLayers.\n /\n advanced?: OlOverlayOptions;\n}\n\n/\n The configured position of an overlay.\n \n @group Map Model\n /\nexport type OverlayPosition =\n /* Explicit (static) coordinates on the map. /\n \| OverlayPositionCoordinate\n /* Update coordinates based on pointer movements on the map, useful for tooltips. /\n \| OverlayPositionFollowPointer;\n\n/\n Automatically positions the overlay on the mouse cursor's coordinates.\n \n This can be used, for example, to implement tooltips for map interactions.\n \n @group Map Model\n /\nexport interface OverlayPositionFollowPointer {\n kind: \"follow-pointer\";\n\n /\n The initial coordinates.\n \n Use `undefined` (the default) to hide until the first mouse event on the map.\n /\n initial?: Coordinate;\n}\n\n/\n Places the overlay at the given coordinates.\n \n @group Map Model\n /\nexport interface OverlayPositionCoordinate {\n kind: \"coordinate\";\n\n /\n The explicit coordinates of the overlay on the map.\n \n Using `undefined` hides the overlay.\n /\n coordinate?: Coordinate;\n}\n\n/\n Positioning of an overlay relative to its coordinates on the map.\n \n @group Map Model\n /\nexport type OverlayPositioning =\n \| \"bottom-left\"\n \| \"bottom-center\"\n \| \"bottom-right\"\n \| \"center-left\"\n \| \"center-center\"\n \| \"center-right\"\n \| \"top-left\"\n \| \"top-center\"\n \| \"top-right\";\n\n/* @group Map Model /\nexport interface OlOverlayOptions extends Omit<Partial<Options>, \"id\" \| \"element\"> {}\n\n/\n An overlay is an UI element that is displayed over the map.\n \n Overlays are tied to coordinates on the map and not to a position on the screen.\n * The overlay renders a react node at the specified coordinates.\n \n @group Map Model\n /\nexport class Overlay {\n /\n Unique, readonly id of the overlay.\n \n Automatically assigned when the overlay is created. Use the `tag` property for custom identifiers.\n /\n readonly id: string;\n\n /\n Optional, readonly tag that helps identifying the overlay instance.\n /\n readonly tag: string \| undefined;\n\n /\n Raw, corresponding OpenLayers overlay object.\n \n warning Manipulation of the OpenLayers object can create inconsistencies that lead to errors. The OpenLayers API can change with updates of OpenLayers.\n \n @see https://openlayers.org/en/latest/apidoc/module-ol_Overlay-Overlay.html\n /\n readonly olOverlay: OlOverlay;\n\n #parent: Overlays;\n #isDestroyed = reactive(false);\n #position = reactive<OverlayPosition>({ kind: \"coordinate\" });\n #content: Reactive<ReactNode>;\n #overlayDiv: HTMLDivElement;\n #resources: Resource[] = [];\n\n #coordinate = synchronized(\n () => this.olOverlay.getPosition(),\n (cb) => {\n const key = this.olOverlay.on(\"change:position\", cb);\n return () => unByKey(key);\n }\n );\n #positioning = synchronized(\n () => this.olOverlay.getPositioning(),\n (cb) => {\n const key = this.olOverlay.on(\"change:positioning\", cb);\n return () => unByKey(key);\n }\n );\n #offset = synchronized(\n () => this.olOverlay.getOffset(),\n (cb) => {\n const key = this.olOverlay.on(\"change:offset\", cb);\n return () => unByKey(key);\n }\n );\n\n constructor(internalTag: InternalConstructorTag, options: OverlayOptions, parent: Overlays) {\n if (internalTag !== INTERNAL_CONSTRUCTOR_TAG) {\n throw new Error(\"The overlay constructor is private.\");\n }\n const {\n className,\n ariaRole,\n position,\n tag,\n content,\n offset,\n positioning,\n stopEvent,\n advanced\n } = options;\n this.id = uuid4v();\n this.tag = tag;\n this.#overlayDiv = createElement(ariaRole, className);\n\n this.olOverlay = new OlOverlay({\n element: this.#overlayDiv,\n id: this.id,\n offset,\n positioning,\n stopEvent,\n //simply override with advanced OL Options if set\n ...advanced\n });\n this.#parent = parent;\n this.#content = reactive(content);\n this.setPosition(position);\n\n parent[REGISTER_OVERLAY](this);\n\n this.#resources.push(\n // Update coordinate based on pointer movements when configured.\n // Automatically subscribes and unsubscribes on changes.\n watchValue(\n () => this.#position.value?.kind === \"follow-pointer\",\n (followPointer) => {\n if (!followPointer) {\n return;\n }\n\n // NOTE: If this turns out to be unstable we can also transport the map model reference here\n // to get our olMap.\n const olMap = this.olOverlay.getMap();\n if (!olMap) {\n LOG.error(\n `Overlay ${this.olOverlay.getId()} is not registered with a map.`\n );\n return;\n }\n\n const pointerMoveKey: EventsKey = olMap.on(\"pointermove\", (e) => {\n this.olOverlay.setPosition(e.coordinate);\n });\n return () => unByKey(pointerMoveKey);\n },\n { immediate: true, dispatch: \"sync\" }\n )\n );\n }\n\n /\n Destroys the overlay and removes it from the map.\n * An overlay that is destroyed cannot be added to the map again.\n /\n destroy(): void {\n if (this.isDestroyed) {\n return;\n }\n\n batch(() => {\n this.#isDestroyed.value = true;\n this.#parent[UNREGISTER_OVERLAY](this);\n this.olOverlay.dispose();\n destroyResources(this.#resources);\n });\n }\n\n /\n Indicates if the overlay instance has been destroyed.\n /\n get isDestroyed(): boolean {\n return this.#isDestroyed.value;\n }\n\n /\n Current coordinates of the overlay on the map.\n \n The coordinates on the map are configured via {@link OverlayOptions.position} or {@link setPosition}.\n \n - If configured with static coordinates (i.e. `position.kind === \"coordinate\"`), this is\n * the same as `position.coordinate`.\n * - If configured with `\"follow-pointer\"` position, this is the result of the user's pointer movements.\n /\n get currentCoordinate(): Coordinate \| undefined {\n return this.#coordinate.value;\n }\n\n /\n The content of the overlay that is currently rendered.\n /\n get content(): ReactNode {\n return this.#content.value;\n }\n\n /\n The HTML element that that wraps the overlay's content.\n /\n get element(): HTMLElement {\n return this.#overlayDiv;\n }\n\n /\n Offset in _pixels_ relative to the overlay`s coordinates.\n \n The first element in the array is the horizontal offset.\n /\n get offset(): number[] {\n return this.#offset.value;\n }\n\n /\n The configured position of the overlay on the map.\n \n See also {@link currentCoordinate} to get the coordinate\n * that are the result of this configuration.\n \n > NOTE: The return value of the getter may not be the same\n * > as the input to the setter (or constructor) due to normalization.\n /\n get position(): OverlayPosition {\n return this.#position.value;\n }\n\n /\n Positioning of an overlay relative to its coordinates on the map.\n /\n get positioning(): OverlayPositioning {\n return this.#positioning.value;\n }\n\n /\n Set new content that is rendered on the overlay.\n /\n setContent(content: ReactNode): void {\n this.#content.value = content;\n }\n\n /\n Set the position of the overlay.\n \n This controls the coordinates of the map.\n * The overlay is not rendered if the coordinates are `undefined`.\n \n See also {@link currentCoordinate} to get the coordinates\n * that are the result of this configuration.\n \n @see {@link OverlayPosition}\n /\n setPosition(position: OverlayOptions[\"position\"]) {\n const normalized = normalizePosition(position);\n\n let newCoordinate: Coordinate \| undefined;\n if (normalized) {\n if (normalized.kind === \"coordinate\") {\n newCoordinate = normalized.coordinate;\n } else {\n newCoordinate = normalized.initial;\n // mouse event handler will update this on its own\n }\n }\n\n batch(() => {\n this.#position.value = normalized;\n this.olOverlay.setPosition(newCoordinate);\n });\n }\n\n /\n Set offset in _pixels_ relative to the overlay`s coordinates on the map.\n * The first element in the array is the horizontal offset.\n /\n setOffset(offset: number[]) {\n this.olOverlay.setOffset(offset);\n }\n\n /\n Set positioning of an overlay relative to its coordinates on the map.\n */\n setPositioning(positioning: OverlayPositioning) {\n this.olOverlay.setPositioning(positioning);\n }\n}\n\nfunction normalizePosition(position: OverlayOptions[\"position\"]): OverlayPosition {\n if (!position \|\| Array.isArray(position)) {\n return { kind: \"coordinate\", coordinate: position };\n }\n if (position === \"follow-pointer\") {\n return { kind: \"follow-pointer\" };\n }\n if (typeof position !== \"object\") {\n throw new Error(\"Unexpected position: \" + position);\n }\n return position;\n}\n\nfunction createElement(ariaRole: string \| undefined, classNameProp: string \| undefined) {\n const overlayDiv = document.createElement(\"div\");\n if (ariaRole) {\n overlayDiv.role = ariaRole;\n }\n\n let className = \"map-overlay\";\n if (classNameProp) {\n className += ` ${classNameProp}`;\n }\n overlayDiv.className = className;\n return overlayDiv;\n}\n"],"names":["uuid4v","OlOverlay"],"mappings":";;;;;;;;AAuBO,MAAM,gBAAA,0BAA0B,kBAAkB,CAAA;AAClD,MAAM,kBAAA,0BAA4B,oBAAoB,CAAA;AAE7D,MAAM,GAAA,GAAM,aAAa,QAAQ,CAAA;AAO1B,MAAM,QAAA,CAAS;AAAA,EAClB,MAAA;AAAA,EACA,YAAY,WAAA,EAAqB;AAAA,EAEjC,YAAY,GAAA,EAAe;AACvB,IAAA,IAAA,CAAK,SAAS,GAAA,CAAI,KAAA;AAAA,EACtB;AAAA,EAEA,CAAC,gBAAgB,CAAA,CAAE,OAAA,EAAkB;AACjC,IAAA,IAAI,IAAA,CAAK,SAAA,CAAU,GAAA,CAAI,OAAO,CAAA,EAAG;AAC7B,MAAA,MAAM,IAAI,MAAM,+CAA+C,CAAA;AAAA,IACnE;AACA,IAAA,IAAA,CAAK,SAAA,CAAU,IAAI,OAAO,CAAA;AAC1B,IAAA,IAAA,CAAK,MAAA,CAAO,UAAA,CAAW,OAAA,CAAQ,SAAS,CAAA;AAAA,EAC5C;AAAA,EAEA,CAAC,kBAAkB,CAAA,CAAE,OAAA,EAAkB;AACnC,IAAA,IAAI,CAAC,IAAA,CAAK,SAAA,CAAU,GAAA,CAAI,OAAO,CAAA,EAAG;AAC9B,MAAA,MAAM,IAAI,MAAM,4CAA4C,CAAA;AAAA,IAChE;AACA,IAAA,IAAA,CAAK,SAAA,CAAU,OAAO,OAAO,CAAA;AAC7B,IAAA,IAAA,CAAK,MAAA,CAAO,aAAA,CAAc,OAAA,CAAQ,SAAS,CAAA;AAAA,EAC/C;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,OAAA,EAAkC;AAClC,IAAA,MAAM,QAAA,GAAW,IAAI,OAAA,CAAQ,wBAAA,EAA0B,SAAS,IAAI,CAAA;AACpE,IAAA,OAAO,QAAA;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAKA,MAAA,GAAoB;AAChB,IAAA,OAAO,KAAA,CAAM,IAAA,CAAK,IAAA,CAAK,SAAS,CAAA;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA,EAKA,KAAA,GAAc;AACV,IAAA,KAAA,MAAW,OAAA,IAAW,KAAK,SAAA,EAAW;AAClC,MAAA,OAAA,CAAQ,OAAA,EAAQ;AAAA,IACpB;AAAA,EACJ;AACJ;AAqJO,MAAM,OAAA,CAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMR,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,SAAA;AAAA,EAET,OAAA;AAAA,EACA,YAAA,GAAe,SAAS,KAAK,CAAA;AAAA,EAC7B,SAAA,GAAY,QAAA,CAA0B,EAAE,IAAA,EAAM,cAAc,CAAA;AAAA,EAC5D,QAAA;AAAA,EACA,WAAA;AAAA,EACA,aAAyB,EAAC;AAAA,EAE1B,WAAA,GAAc,YAAA;AAAA,IACV,MAAM,IAAA,CAAK,SAAA,CAAU,WAAA,EAAY;AAAA,IACjC,CAAC,EAAA,KAAO;AACJ,MAAA,MAAM,GAAA,GAAM,IAAA,CAAK,SAAA,CAAU,EAAA,CAAG,mBAAmB,EAAE,CAAA;AACnD,MAAA,OAAO,MAAM,QAAQ,GAAG,CAAA;AAAA,IAC5B;AAAA,GACJ;AAAA,EACA,YAAA,GAAe,YAAA;AAAA,IACX,MAAM,IAAA,CAAK,SAAA,CAAU,cAAA,EAAe;AAAA,IACpC,CAAC,EAAA,KAAO;AACJ,MAAA,MAAM,GAAA,GAAM,IAAA,CAAK,SAAA,CAAU,EAAA,CAAG,sBAAsB,EAAE,CAAA;AACtD,MAAA,OAAO,MAAM,QAAQ,GAAG,CAAA;AAAA,IAC5B;AAAA,GACJ;AAAA,EACA,OAAA,GAAU,YAAA;AAAA,IACN,MAAM,IAAA,CAAK,SAAA,CAAU,SAAA,EAAU;AAAA,IAC/B,CAAC,EAAA,KAAO;AACJ,MAAA,MAAM,GAAA,GAAM,IAAA,CAAK,SAAA,CAAU,EAAA,CAAG,iBAAiB,EAAE,CAAA;AACjD,MAAA,OAAO,MAAM,QAAQ,GAAG,CAAA;AAAA,IAC5B;AAAA,GACJ;AAAA,EAEA,WAAA,CAAY,WAAA,EAAqC,OAAA,EAAyB,MAAA,EAAkB;AACxF,IAAA,IAAI,gBAAgB,wBAAA,EAA0B;AAC1C,MAAA,MAAM,IAAI,MAAM,qCAAqC,CAAA;AAAA,IACzD;AACA,IAAA,MAAM;AAAA,MACF,SAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,MACA,GAAA;AAAA,MACA,OAAA;AAAA,MACA,MAAA;AAAA,MACA,WAAA;AAAA,MACA,SAAA;AAAA,MACA;AAAA,KACJ,GAAI,OAAA;AACJ,IAAA,IAAA,CAAK,KAAKA,EAAA,EAAO;AACjB,IAAA,IAAA,CAAK,GAAA,GAAM,GAAA;AACX,IAAA,IAAA,CAAK,WAAA,GAAc,aAAA,CAAc,QAAA,EAAU,SAAS,CAAA;AAEpD,IAAA,IAAA,CAAK,SAAA,GAAY,IAAIC,SAAA,CAAU;AAAA,MAC3B,SAAS,IAAA,CAAK,WAAA;AAAA,MACd,IAAI,IAAA,CAAK,EAAA;AAAA,MACT,MAAA;AAAA,MACA,WAAA;AAAA,MACA,SAAA;AAAA;AAAA,MAEA,GAAG;AAAA,KACN,CAAA;AACD,IAAA,IAAA,CAAK,OAAA,GAAU,MAAA;AACf,IAAA,IAAA,CAAK,QAAA,GAAW,SAAS,OAAO,CAAA;AAChC,IAAA,IAAA,CAAK,YAAY,QAAQ,CAAA;AAEzB,IAAA,MAAA,CAAO,gBAAgB,EAAE,IAAI,CAAA;AAE7B,IAAA,IAAA,CAAK,UAAA,CAAW,IAAA;AAAA;AAAA;AAAA,MAGZ,UAAA;AAAA,QACI,MAAM,IAAA,CAAK,SAAA,CAAU,KAAA,EAAO,IAAA,KAAS,gBAAA;AAAA,QACrC,CAAC,aAAA,KAAkB;AACf,UAAA,IAAI,CAAC,aAAA,EAAe;AAChB,YAAA;AAAA,UACJ;AAIA,UAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,SAAA,CAAU,MAAA,EAAO;AACpC,UAAA,IAAI,CAAC,KAAA,EAAO;AACR,YAAA,GAAA,CAAI,KAAA;AAAA,cACA,CAAA,QAAA,EAAW,IAAA,CAAK,SAAA,CAAU,KAAA,EAAO,CAAA,8BAAA;AAAA,aACrC;AACA,YAAA;AAAA,UACJ;AAEA,UAAA,MAAM,cAAA,GAA4B,KAAA,CAAM,EAAA,CAAG,aAAA,EAAe,CAAC,CAAA,KAAM;AAC7D,YAAA,IAAA,CAAK,SAAA,CAAU,WAAA,CAAY,CAAA,CAAE,UAAU,CAAA;AAAA,UAC3C,CAAC,CAAA;AACD,UAAA,OAAO,MAAM,QAAQ,cAAc,CAAA;AAAA,QACvC,CAAA;AAAA,QACA,EAAE,SAAA,EAAW,IAAA,EAAM,QAAA,EAAU,MAAA;AAAO;AACxC,KACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAA,GAAgB;AACZ,IAAA,IAAI,KAAK,WAAA,EAAa;AAClB,MAAA;AAAA,IACJ;AAEA,IAAA,KAAA,CAAM,MAAM;AACR,MAAA,IAAA,CAAK,aAAa,KAAA,GAAQ,IAAA;AAC1B,MAAA,IAAA,CAAK,OAAA,CAAQ,kBAAkB,CAAA,CAAE,IAAI,CAAA;AACrC,MAAA,IAAA,CAAK,UAAU,OAAA,EAAQ;AACvB,MAAA,gBAAA,CAAiB,KAAK,UAAU,CAAA;AAAA,IACpC,CAAC,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,WAAA,GAAuB;AACvB,IAAA,OAAO,KAAK,YAAA,CAAa,KAAA;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,IAAI,iBAAA,GAA4C;AAC5C,IAAA,OAAO,KAAK,WAAA,CAAY,KAAA;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,OAAA,GAAqB;AACrB,IAAA,OAAO,KAAK,QAAA,CAAS,KAAA;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,OAAA,GAAuB;AACvB,IAAA,OAAO,IAAA,CAAK,WAAA;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,MAAA,GAAmB;AACnB,IAAA,OAAO,KAAK,OAAA,CAAQ,KAAA;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,IAAI,QAAA,GAA4B;AAC5B,IAAA,OAAO,KAAK,SAAA,CAAU,KAAA;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,WAAA,GAAkC;AAClC,IAAA,OAAO,KAAK,YAAA,CAAa,KAAA;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA,EAKA,WAAW,OAAA,EAA0B;AACjC,IAAA,IAAA,CAAK,SAAS,KAAA,GAAQ,OAAA;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,YAAY,QAAA,EAAsC;AAC9C,IAAA,MAAM,UAAA,GAAa,kBAAkB,QAAQ,CAAA;AAE7C,IAAA,IAAI,aAAA;AACJ,IAAA,IAAI,UAAA,EAAY;AACZ,MAAA,IAAI,UAAA,CAAW,SAAS,YAAA,EAAc;AAClC,QAAA,aAAA,GAAgB,UAAA,CAAW,UAAA;AAAA,MAC/B,CAAA,MAAO;AACH,QAAA,aAAA,GAAgB,UAAA,CAAW,OAAA;AAAA,MAE/B;AAAA,IACJ;AAEA,IAAA,KAAA,CAAM,MAAM;AACR,MAAA,IAAA,CAAK,UAAU,KAAA,GAAQ,UAAA;AACvB,MAAA,IAAA,CAAK,SAAA,CAAU,YAAY,aAAa,CAAA;AAAA,IAC5C,CAAC,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAU,MAAA,EAAkB;AACxB,IAAA,IAAA,CAAK,SAAA,CAAU,UAAU,MAAM,CAAA;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA,EAKA,eAAe,WAAA,EAAiC;AAC5C,IAAA,IAAA,CAAK,SAAA,CAAU,eAAe,WAAW,CAAA;AAAA,EAC7C;AACJ;AAEA,SAAS,kBAAkB,QAAA,EAAuD;AAC9E,EAAA,IAAI,CAAC,QAAA,IAAY,KAAA,CAAM,OAAA,CAAQ,QAAQ,CAAA,EAAG;AACtC,IAAA,OAAO,EAAE,IAAA,EAAM,YAAA,EAAc,UAAA,EAAY,QAAA,EAAS;AAAA,EACtD;AACA,EAAA,IAAI,aAAa,gBAAA,EAAkB;AAC/B,IAAA,OAAO,EAAE,MAAM,gBAAA,EAAiB;AAAA,EACpC;AACA,EAAA,IAAI,OAAO,aAAa,QAAA,EAAU;AAC9B,IAAA,MAAM,IAAI,KAAA,CAAM,uBAAA,GAA0B,QAAQ,CAAA;AAAA,EACtD;AACA,EAAA,OAAO,QAAA;AACX;AAEA,SAAS,aAAA,CAAc,UAA8B,aAAA,EAAmC;AACpF,EAAA,MAAM,UAAA,GAAa,QAAA,CAAS,aAAA,CAAc,KAAK,CAAA;AAC/C,EAAA,IAAI,QAAA,EAAU;AACV,IAAA,UAAA,CAAW,IAAA,GAAO,QAAA;AAAA,EACtB;AAEA,EAAA,IAAI,SAAA,GAAY,aAAA;AAChB,EAAA,IAAI,aAAA,EAAe;AACf,IAAA,SAAA,IAAa,IAAI,aAAa,CAAA,CAAA;AAAA,EAClC;AACA,EAAA,UAAA,CAAW,SAAA,GAAY,SAAA;AACvB,EAAA,OAAO,UAAA;AACX;;;;"}