@artstesh/maps 6.1.1 → 6.1.2

package/dist/fesm2022/maps-components.mjs

@@ -13,15 +13,15 @@ import { PostboyGenericMessage, PostboyCallbackMessage, PostboyExecutor, Postboy
 import { Draw, Modify, Translate, defaults } from 'ol/interaction';
 import { createRegularPolygon, createBox } from 'ol/interaction/Draw';
 import * as Sphere from 'ol/sphere';
+import { Subject, combineLatest } from 'rxjs';
+import { first, debounceTime, filter, auditTime } from 'rxjs/operators';
 import { Dictionary } from '@artstesh/collections';
-import { first, filter, auditTime } from 'rxjs/operators';
 import { Vector, XYZ } from 'ol/source';
 import TileLayer from 'ol/layer/Tile';
 import OSM from 'ol/source/OSM';
 import { Vector as Vector$1 } from 'ol/layer';
 import { bbox } from 'ol/loadingstrategy';
 import Cluster from 'ol/source/Cluster';
-import { combineLatest } from 'rxjs';
 import Map from 'ol/Map';
 import View from 'ol/View';
 import Overlay from 'ol/Overlay';
@@ -191,6 +191,7 @@ class IdGenerator {
 class MapConstants {
     static FeatureInfo = 'f-info';
     static DrawingLayerId = '93a981756ec7';
+    static FeatureLayerName = 'L-253';
 }
 
 class MarkerModel {
@@ -547,6 +548,48 @@ class MapMoveEndEvent extends PostboyGenericMessage {
     }
 }
 
+/**
+ * Represents an event that is triggered when the pointer moves on a map.
+ * This class extends PostboyGenericMessage.
+ *
+ * It contains information about the coordinates of the pointer when the event occurs.
+ */
+class MapPointerMoveEvent extends PostboyGenericMessage {
+    point;
+    static ID = '193cb41d-2489-45cc-b349-59c3ec18ed72';
+    /**
+     * Constructor for initializing an instance with a given point.
+     *
+     * @param {Array<number>} point - An array representing the coordinates of the point.
+     */
+    constructor(point) {
+        super();
+        this.point = point;
+    }
+}
+
+/**
+ * Represents an event triggered when a map feature is hovered over.
+ * This event contains information about the hovered feature and its associated layer.
+ * Extends the PostboyGenericMessage class.
+ */
+class MapFeatureHoveredEvent extends PostboyGenericMessage {
+    feature;
+    layer;
+    static ID = 'eb9b032a-1616-4823-a628-0fd8ffc3b57a';
+    /**
+     * Constructs an instance of the class.
+     *
+     * @param {Feature|null} feature - The feature associated with this instance. Can be null.
+     * @param {string|null} layer - The layer associated with this instance. Can be null.
+     */
+    constructor(feature, layer) {
+        super();
+        this.feature = feature;
+        this.layer = layer;
+    }
+}
+
 /**
  * A class responsible for executing filtering of geographical features
  * based on a specific geographical point (latitude and longitude).
@@ -987,6 +1030,7 @@ class MapFeatureService {
         this.observeMapRender();
         this.observeFitToFeatures();
         this.observeFitToPolygons();
+        this.observePointerMove();
     }
     observeMapRender() {
         this.postboy.sub(MapRenderedEvent).subscribe((m) => {
@@ -995,6 +1039,22 @@ class MapFeatureService {
                 this.postboy.fire(this.fitPolygonsWaiting);
         });
     }
+    observePointerMove() {
+        this.postboy.sub(MapPointerMoveEvent).subscribe((ev) => {
+            if (!this.map)
+                return;
+            let featureFound = false;
+            this.map.forEachFeatureAtPixel(ev.point, (f) => {
+                if (f instanceof Feature) {
+                    this.postboy.fire(new MapFeatureHoveredEvent(f, f.get(MapConstants.FeatureLayerName)));
+                    featureFound = true;
+                }
+                return true;
+            });
+            if (!featureFound)
+                this.postboy.fire(new MapFeatureHoveredEvent(null, null));
+        });
+    }
     observeFitToFeatures() {
         this.postboy.sub(FitToFeaturesCommand).subscribe((cmd) => {
             this.fitToGeometries(cmd.features.map((f) => f.getGeometry()), cmd.zoomAfter);
@@ -1303,6 +1363,8 @@ class MessageRegistratorService extends PostboyAbstractRegistrator {
         this.recordSubject(CancelDrawingCommand);
         this.recordSubject(StartDrawingCommand);
         this.recordSubject(GetLayerQuery);
+        this.recordSubject(MapFeatureHoveredEvent);
+        this.recordWithPipe(MapPointerMoveEvent, new Subject(), (s) => s.pipe(debounceTime(150)));
         this.recordSubject(DrawingFinishedEvent);
         this.recordSubject(GetFeaturesInAreaQuery);
         this.recordSubject(DrawSelectionAreaCommand);
@@ -1651,6 +1713,21 @@ class FeatureLayerSettings {
      * The styling definition of layer's features. The easiest way is to use {@link PolygonStyleHelper},{@link MarkerStyleHelper}
      */
     style;
+    /**
+     * Defines the style applied to a feature when it is hovered over.
+     *
+     * This property can accept either a static style object or a dynamic style function.
+     * When a `StyleFunction` is provided, it will determine the style dynamically
+     * based on the feature being hovered.
+     *
+     * The style is applied temporarily, specifically for the hovered feature,
+     * and overrides any default or predefined styles for that feature.
+     *
+     * Optional property.
+     *
+     * @type {(Style | StyleFunction)}
+     */
+    featureHoverStyle;
     /**
      * Copies the given FeatureLayerSettings object
      *
@@ -1664,6 +1741,7 @@ class FeatureLayerSettings {
         result.minZoom = model.minZoom;
         result.zIndex = model.zIndex;
         result.style = model.style;
+        result.featureHoverStyle = model.featureHoverStyle;
         return result;
     }
     /**
@@ -1712,6 +1790,15 @@ class FeatureLayerSettings {
     setStyle(style) {
         return FeatureLayerSettings.copy({ ...this, style });
     }
+    /**
+     * Sets the style to apply to features when they are hovered over.
+     *
+     * @param {Style | StyleFunction} featureHoverStyle - The style or style function to use for hovered features.
+     * @return {FeatureLayerSettings} A new instance of FeatureLayerSettings with the updated hover style.
+     */
+    setFeatureHoverStyle(featureHoverStyle) {
+        return FeatureLayerSettings.copy({ ...this, featureHoverStyle });
+    }
     /**
      * Checks if the given FeatureLayerSettings object is identical to the current object.
      *
@@ -1729,6 +1816,8 @@ class FeatureLayerSettings {
             return false;
         if (this.style !== model.style)
             return false;
+        if (this.featureHoverStyle !== model.featureHoverStyle)
+            return false;
         return true;
     }
 }
@@ -2134,6 +2223,9 @@ class MapPlateComponent extends DestructibleComponent {
             this.map.updateSize();
             this.postboy.fire(new MapRenderedEvent(this.map));
         });
+        this.map.on('pointermove', (ev) => {
+            this.postboy.fire(new MapPointerMoveEvent(ev.pixel));
+        });
         this.setOsm();
     }
     onDestroy = () => {
@@ -2793,5 +2885,5 @@ class StringifyFeatureHelper {
  * Generated bundle index. Do not edit.
  */
 
-export { AddControlCommand, CalculateAreaExecutor, CancelDrawingCommand, CancelFeatureModificationCommand, CloseTooltipCommand, ClusterLayerComponent, ClusterLayerSettings, DrawSelectionAreaCommand, DrawingType, FeatureLayerComponent, FeatureLayerSettings, FeatureOutputFormat, FilterFeaturesInAreaExecutor, FilterFeaturesInPointExecutor, FitToFeaturesCommand, FitToPolygonsCommand, GetFeaturesInAreaQuery, GetFeaturesInPointQuery, GetMapPositionExecutor, MapClickEvent, MapConstants, MapControl, MapControlZoomComponent, MapLyrs, MapLyrsLabel, MapModule, MapMoveEndEvent, MapPlateComponent, MapPostboyService, MapRenderedEvent, MapSettings, MarkerModel, MarkerStyleHelper, MarkersComponent, MessageRegistratorService, ModifyFeatureCommand, OsmTileLayerComponent, PolygonModel, PolygonStyleHelper, PolygonsComponent, RemoveControlCommand, SetMapCenterCommand, StartDrawingCommand, StringifyFeatureHelper, TextStyleHelper, TileLayerComponent, TileLayerSettings, TooltipComponent, TooltipSettings, ZoomControlSettings };
+export { AddControlCommand, CalculateAreaExecutor, CancelDrawingCommand, CancelFeatureModificationCommand, CloseTooltipCommand, ClusterLayerComponent, ClusterLayerSettings, DrawSelectionAreaCommand, DrawingType, FeatureLayerComponent, FeatureLayerSettings, FeatureOutputFormat, FilterFeaturesInAreaExecutor, FilterFeaturesInPointExecutor, FitToFeaturesCommand, FitToPolygonsCommand, GetFeaturesInAreaQuery, GetFeaturesInPointQuery, GetMapPositionExecutor, MapClickEvent, MapConstants, MapControl, MapControlZoomComponent, MapFeatureHoveredEvent, MapLyrs, MapLyrsLabel, MapModule, MapMoveEndEvent, MapPlateComponent, MapPointerMoveEvent, MapPostboyService, MapRenderedEvent, MapSettings, MarkerModel, MarkerStyleHelper, MarkersComponent, MessageRegistratorService, ModifyFeatureCommand, OsmTileLayerComponent, PolygonModel, PolygonStyleHelper, PolygonsComponent, RemoveControlCommand, SetMapCenterCommand, StartDrawingCommand, StringifyFeatureHelper, TextStyleHelper, TileLayerComponent, TileLayerSettings, TooltipComponent, TooltipSettings, ZoomControlSettings };
 //# sourceMappingURL=maps-components.mjs.map