@artstesh/maps 6.1.1 → 6.1.3

package/dist/map/map-plate/layers/feature-layer/feature-layer.settings.d.ts

@@ -28,6 +28,21 @@ export declare class FeatureLayerSettings {
      * The styling definition of layer's features. The easiest way is to use {@link PolygonStyleHelper},{@link MarkerStyleHelper}
      */
     style?: Style | StyleFunction;
+    /**
+     * 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?: Style | StyleFunction;
     /**
      * Copies the given FeatureLayerSettings object
      *
@@ -71,6 +86,13 @@ export declare class FeatureLayerSettings {
      * @return {FeatureLayerSettings} - The updated FeatureLayerSettings object with the new style.
      */
     setStyle(style: Style | StyleFunction): FeatureLayerSettings;
+    /**
+     * 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: Style | StyleFunction): FeatureLayerSettings;
     /**
      * Checks if the given FeatureLayerSettings object is identical to the current object.
      *

package/dist/map/messages/events/map-feature-hovered.event.d.ts

@@ -0,0 +1,19 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+import { Feature } from 'ol';
+/**
+ * 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.
+ */
+export declare class MapFeatureHoveredEvent extends PostboyGenericMessage {
+    feature: Feature | null;
+    layer: string | null;
+    static readonly 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: Feature | null, layer: string | null);
+}

package/dist/map/messages/events/map-pointer-move.event.d.ts

@@ -0,0 +1,17 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+/**
+ * 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.
+ */
+export declare class MapPointerMoveEvent extends PostboyGenericMessage {
+    point: Array<number>;
+    static readonly 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: Array<number>);
+}

package/dist/map/messages/index.d.ts

@@ -11,6 +11,8 @@ export * from './commands/fit-to-polygons.command';
 export * from './events/map-rendered.event';
 export * from './events/map-click.event';
 export * from './events/map-move-end.event';
+export * from './events/map-pointer-move.event';
+export * from './events/map-feature-hovered.event';
 export * from './executors/filter-features-in-point.executor';
 export * from './executors/filter-features-in-area.executor';
 export * from './executors/calculate-area.executor';

package/dist/map/models/map.constants.d.ts

@@ -1,4 +1,5 @@
 export declare class MapConstants {
     static FeatureInfo: string;
     static DrawingLayerId: string;
+    static FeatureLayerName: string;
 }

package/dist/map/services/map-feature.service.d.ts

@@ -8,6 +8,7 @@ export declare class MapFeatureService implements IPostboyDependingService {
     constructor(postboy: MapPostboyService);
     up(): void;
     private observeMapRender;
+    private observePointerMove;
     private observeFitToFeatures;
     private observeFitToPolygons;
     private fitToGeometries;

package/dist/src/map/map-plate/layers/feature-layer/feature-layer.settings.d.ts

@@ -28,6 +28,21 @@ export declare class FeatureLayerSettings {
      * The styling definition of layer's features. The easiest way is to use {@link PolygonStyleHelper},{@link MarkerStyleHelper}
      */
     style?: Style | StyleFunction;
+    /**
+     * 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?: Style | StyleFunction;
     /**
      * Copies the given FeatureLayerSettings object
      *
@@ -71,6 +86,13 @@ export declare class FeatureLayerSettings {
      * @return {FeatureLayerSettings} - The updated FeatureLayerSettings object with the new style.
      */
     setStyle(style: Style | StyleFunction): FeatureLayerSettings;
+    /**
+     * 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: Style | StyleFunction): FeatureLayerSettings;
     /**
      * Checks if the given FeatureLayerSettings object is identical to the current object.
      *

package/dist/src/map/messages/events/map-feature-hovered.event.d.ts

@@ -0,0 +1,19 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+import { Feature } from 'ol';
+/**
+ * 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.
+ */
+export declare class MapFeatureHoveredEvent extends PostboyGenericMessage {
+    feature: Feature | null;
+    layer: string | null;
+    static readonly 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: Feature | null, layer: string | null);
+}

package/dist/src/map/messages/events/map-pointer-move.event.d.ts

@@ -0,0 +1,17 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+/**
+ * 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.
+ */
+export declare class MapPointerMoveEvent extends PostboyGenericMessage {
+    point: Array<number>;
+    static readonly 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: Array<number>);
+}

package/dist/src/map/messages/index.d.ts

@@ -11,6 +11,8 @@ export * from './commands/fit-to-polygons.command';
 export * from './events/map-rendered.event';
 export * from './events/map-click.event';
 export * from './events/map-move-end.event';
+export * from './events/map-pointer-move.event';
+export * from './events/map-feature-hovered.event';
 export * from './executors/filter-features-in-point.executor';
 export * from './executors/filter-features-in-area.executor';
 export * from './executors/calculate-area.executor';

package/dist/src/map/models/map.constants.d.ts

@@ -1,4 +1,5 @@
 export declare class MapConstants {
     static FeatureInfo: string;
     static DrawingLayerId: string;
+    static FeatureLayerName: string;
 }

package/dist/src/map/services/map-feature.service.d.ts

@@ -8,6 +8,7 @@ export declare class MapFeatureService implements IPostboyDependingService {
     constructor(postboy: MapPostboyService);
     up(): void;
     private observeMapRender;
+    private observePointerMove;
     private observeFitToFeatures;
     private observeFitToPolygons;
     private fitToGeometries;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artstesh/maps",
-  "version": "6.1.1",
+  "version": "6.1.3",
   "author": "artstesh",
   "license": "MIT",
   "description": "Let's draw a map ;)",