@emuanalytics/flow-rdf-core 4.0.15 → 4.0.16

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { A as Annotation, M as MapStyleSpecification, S as StateStore, a as MapDataSource, b as MapLayer, F as FlowContextOptions, c as FlowContext } from './shared/flow-rdf-core.3da5bd49.mjs';
-export { B as BackgroundLayerStyleBuilder, C as CircleLayerStyleBuilder, D as DEFAULT_CONTEXT_ID, _ as FeatureStreamOptions, s as FillExtrusionLayerStyleBuilder, q as FillLayerStyleBuilder, d as FlowCoreError, h as FlowCoreExpressionCustomFunction, i as FlowCoreExpressionCustomFunctionSignature, j as FlowCoreExpressionCustomFunctions, e as FlowCoreExpressionError, a0 as FlowCoreMap, o as FlowEngineEndpoint, f as FlowMapError, H as HeatmapLayerStyleBuilder, u as HillshadeLayerStyleBuilder, L as LineLayerStyleBuilder, T as MapAnimationOptions, U as MapCenterOptions, K as MapDataSourceOptions, N as MapDataSourceSpecification, J as MapDataSourceType, a3 as MapEvent, a2 as MapEventType, a1 as MapEventTypes, V as MapFeature, W as MapFeatureIdentifier, Z as MapFeatureStream, O as MapGeojsonData, E as MapLayerExpression, z as MapLayerOptions, I as MapLayerPropertyMetadataIndex, G as MapLayerSpecification, w as MapLayerStyleBuilder, p as MapLayerType, a6 as MapLoadingEvent, a4 as MapMouseEvent, $ as MapOptions, X as MapPaddingOptions, aa as MapPopup, a9 as MapPopupOptions, a8 as MapPopupTemplateFn, g as MapRegistry, a5 as MapSourceEvent, Y as MapSourceIdentifier, a7 as MapStyleChangeEvent, P as ParserExpression, k as ParserExpressionWithIndex, l as ParserFunctionExpression, m as ParserIndex, n as ParserProgram, aq as Path, ar as PathValue, ab as Query, ag as QueryAttribute, al as QueryDefinition, an as QueryDefinitionFn, ai as QueryExtraParams, am as QueryOptions, aj as QueryOrderClause, Q as QueryRegistry, af as QueryResultFormat, ao as QueryResultTransformFn, ak as QuerySampleOptions, ah as QueryWhereClauses, t as RasterLayerStyleBuilder, R as ReactiveExpression, au as SerializationFormat, at as StoreAnnotations, as as StoreConstructor, x as StyleExpression, r as SymbolLayerStyleBuilder, y as expr, v as layerStyle, ac as query, ad as queryMany, ae as queryOne, ap as traceReaction } from './shared/flow-rdf-core.3da5bd49.mjs';
+import { A as Annotation, M as MapStyleSpecification, S as StateStore, a as MapDataSource, b as MapLayer, F as FlowContextOptions, c as FlowContext } from './shared/flow-rdf-core.09a21889.mjs';
+export { B as BackgroundLayerStyleBuilder, C as CircleLayerStyleBuilder, D as DEFAULT_CONTEXT_ID, _ as FeatureStreamOptions, s as FillExtrusionLayerStyleBuilder, q as FillLayerStyleBuilder, d as FlowCoreError, h as FlowCoreExpressionCustomFunction, i as FlowCoreExpressionCustomFunctionSignature, j as FlowCoreExpressionCustomFunctions, e as FlowCoreExpressionError, a0 as FlowCoreMap, o as FlowEngineEndpoint, f as FlowMapError, H as HeatmapLayerStyleBuilder, u as HillshadeLayerStyleBuilder, L as LineLayerStyleBuilder, T as MapAnimationOptions, U as MapCenterOptions, K as MapDataSourceOptions, N as MapDataSourceSpecification, J as MapDataSourceType, a3 as MapEvent, a2 as MapEventType, a1 as MapEventTypes, V as MapFeature, W as MapFeatureIdentifier, Z as MapFeatureStream, O as MapGeojsonData, E as MapLayerExpression, z as MapLayerOptions, I as MapLayerPropertyMetadataIndex, G as MapLayerSpecification, w as MapLayerStyleBuilder, p as MapLayerType, a6 as MapLoadingEvent, a4 as MapMouseEvent, $ as MapOptions, X as MapPaddingOptions, aa as MapPopup, a9 as MapPopupOptions, a8 as MapPopupTemplateFn, g as MapRegistry, a5 as MapSourceEvent, Y as MapSourceIdentifier, a7 as MapStyleChangeEvent, P as ParserExpression, k as ParserExpressionWithIndex, l as ParserFunctionExpression, m as ParserIndex, n as ParserProgram, aq as Path, ar as PathValue, ab as Query, ag as QueryAttribute, al as QueryDefinition, an as QueryDefinitionFn, ai as QueryExtraParams, am as QueryOptions, aj as QueryOrderClause, Q as QueryRegistry, af as QueryResultFormat, ao as QueryResultTransformFn, ak as QuerySampleOptions, ah as QueryWhereClauses, t as RasterLayerStyleBuilder, R as ReactiveExpression, au as SerializationFormat, at as StoreAnnotations, as as StoreConstructor, x as StyleExpression, r as SymbolLayerStyleBuilder, y as expr, v as layerStyle, ac as query, ad as queryMany, ae as queryOne, ap as traceReaction } from './shared/flow-rdf-core.09a21889.mjs';
 export { IDisposer, IObservableStream, ISubscription } from 'mobx-utils';
 export { makeAutoObservable, makeObservable } from 'mobx';
 import 'eventemitter3';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { A as Annotation, M as MapStyleSpecification, S as StateStore, a as MapDataSource, b as MapLayer, F as FlowContextOptions, c as FlowContext } from './shared/flow-rdf-core.3da5bd49.js';
-export { B as BackgroundLayerStyleBuilder, C as CircleLayerStyleBuilder, D as DEFAULT_CONTEXT_ID, _ as FeatureStreamOptions, s as FillExtrusionLayerStyleBuilder, q as FillLayerStyleBuilder, d as FlowCoreError, h as FlowCoreExpressionCustomFunction, i as FlowCoreExpressionCustomFunctionSignature, j as FlowCoreExpressionCustomFunctions, e as FlowCoreExpressionError, a0 as FlowCoreMap, o as FlowEngineEndpoint, f as FlowMapError, H as HeatmapLayerStyleBuilder, u as HillshadeLayerStyleBuilder, L as LineLayerStyleBuilder, T as MapAnimationOptions, U as MapCenterOptions, K as MapDataSourceOptions, N as MapDataSourceSpecification, J as MapDataSourceType, a3 as MapEvent, a2 as MapEventType, a1 as MapEventTypes, V as MapFeature, W as MapFeatureIdentifier, Z as MapFeatureStream, O as MapGeojsonData, E as MapLayerExpression, z as MapLayerOptions, I as MapLayerPropertyMetadataIndex, G as MapLayerSpecification, w as MapLayerStyleBuilder, p as MapLayerType, a6 as MapLoadingEvent, a4 as MapMouseEvent, $ as MapOptions, X as MapPaddingOptions, aa as MapPopup, a9 as MapPopupOptions, a8 as MapPopupTemplateFn, g as MapRegistry, a5 as MapSourceEvent, Y as MapSourceIdentifier, a7 as MapStyleChangeEvent, P as ParserExpression, k as ParserExpressionWithIndex, l as ParserFunctionExpression, m as ParserIndex, n as ParserProgram, aq as Path, ar as PathValue, ab as Query, ag as QueryAttribute, al as QueryDefinition, an as QueryDefinitionFn, ai as QueryExtraParams, am as QueryOptions, aj as QueryOrderClause, Q as QueryRegistry, af as QueryResultFormat, ao as QueryResultTransformFn, ak as QuerySampleOptions, ah as QueryWhereClauses, t as RasterLayerStyleBuilder, R as ReactiveExpression, au as SerializationFormat, at as StoreAnnotations, as as StoreConstructor, x as StyleExpression, r as SymbolLayerStyleBuilder, y as expr, v as layerStyle, ac as query, ad as queryMany, ae as queryOne, ap as traceReaction } from './shared/flow-rdf-core.3da5bd49.js';
+import { A as Annotation, M as MapStyleSpecification, S as StateStore, a as MapDataSource, b as MapLayer, F as FlowContextOptions, c as FlowContext } from './shared/flow-rdf-core.09a21889.js';
+export { B as BackgroundLayerStyleBuilder, C as CircleLayerStyleBuilder, D as DEFAULT_CONTEXT_ID, _ as FeatureStreamOptions, s as FillExtrusionLayerStyleBuilder, q as FillLayerStyleBuilder, d as FlowCoreError, h as FlowCoreExpressionCustomFunction, i as FlowCoreExpressionCustomFunctionSignature, j as FlowCoreExpressionCustomFunctions, e as FlowCoreExpressionError, a0 as FlowCoreMap, o as FlowEngineEndpoint, f as FlowMapError, H as HeatmapLayerStyleBuilder, u as HillshadeLayerStyleBuilder, L as LineLayerStyleBuilder, T as MapAnimationOptions, U as MapCenterOptions, K as MapDataSourceOptions, N as MapDataSourceSpecification, J as MapDataSourceType, a3 as MapEvent, a2 as MapEventType, a1 as MapEventTypes, V as MapFeature, W as MapFeatureIdentifier, Z as MapFeatureStream, O as MapGeojsonData, E as MapLayerExpression, z as MapLayerOptions, I as MapLayerPropertyMetadataIndex, G as MapLayerSpecification, w as MapLayerStyleBuilder, p as MapLayerType, a6 as MapLoadingEvent, a4 as MapMouseEvent, $ as MapOptions, X as MapPaddingOptions, aa as MapPopup, a9 as MapPopupOptions, a8 as MapPopupTemplateFn, g as MapRegistry, a5 as MapSourceEvent, Y as MapSourceIdentifier, a7 as MapStyleChangeEvent, P as ParserExpression, k as ParserExpressionWithIndex, l as ParserFunctionExpression, m as ParserIndex, n as ParserProgram, aq as Path, ar as PathValue, ab as Query, ag as QueryAttribute, al as QueryDefinition, an as QueryDefinitionFn, ai as QueryExtraParams, am as QueryOptions, aj as QueryOrderClause, Q as QueryRegistry, af as QueryResultFormat, ao as QueryResultTransformFn, ak as QuerySampleOptions, ah as QueryWhereClauses, t as RasterLayerStyleBuilder, R as ReactiveExpression, au as SerializationFormat, at as StoreAnnotations, as as StoreConstructor, x as StyleExpression, r as SymbolLayerStyleBuilder, y as expr, v as layerStyle, ac as query, ad as queryMany, ae as queryOne, ap as traceReaction } from './shared/flow-rdf-core.09a21889.js';
 export { IDisposer, IObservableStream, ISubscription } from 'mobx-utils';
 export { makeAutoObservable, makeObservable } from 'mobx';
 import 'eventemitter3';

package/dist/lib/map/plugins/hover/hover.plugin.mjs

@@ -0,0 +1,122 @@
+import Debug from 'debug';
+import { MapPluginBase } from '../map-plugin-base.mjs';
+import { PopupPlugin } from '../popup.plugin.mjs';
+import { SourceHover } from './source-hover.mjs';
+import { FlowMapError } from '../../../errors/flow-map-error.mjs';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+const debug = Debug("flow:HoverPlugin");
+class HoverPlugin extends MapPluginBase {
+  /**
+   * Constructs a new HoverEffectPlugin instance. This is called automatically when the plugin is added to a {@link FlowCoreMap} instance
+   * using {@link FlowCoreMap.usePlugin} method.
+   *
+   * @param pluginManager The plugin manager instance associated with the map
+   */
+  constructor(pluginManager) {
+    super(pluginManager);
+    __publicField(this, "_sourceHovers", /* @__PURE__ */ new Map());
+    __publicField(this, "_enablePopups", true);
+    __publicField(this, "_compatibilityMode", true);
+    __publicField(this, "name", "HoverPlugin");
+    try {
+      pluginManager.getPlugin("HoverEffectPlugin");
+      console.warn(
+        "[HoverPlugin] Warning: HoverEffectPlugin is also loaded. It has been deprecated and should be removed to avoid conflicts."
+      );
+    } catch {
+    }
+  }
+  /**
+   * Enable hover popup support for the specified map data source.
+   *
+   * @param source Map data source ID
+   * @param options Selection options
+   */
+  enableHover(source, options = {}) {
+    this._compatibilityMode = false;
+    if (options.popup) {
+      try {
+        this.map.getPlugin(PopupPlugin);
+      } catch (e) {
+        throw new FlowMapError(`enableHover(): Popup plugin is required for automatic hover popups`);
+      }
+    }
+    this.disableHover(source);
+    this._sourceHovers.set(source, new SourceHover(this, source, options));
+  }
+  /**
+   * Disable hover for the specified map data source.
+   *
+   * @param source Map data source ID
+   */
+  disableHover(source) {
+    this._compatibilityMode = false;
+    if (this._sourceHovers.has(source)) {
+      this._sourceHovers.get(source).destroy();
+      this._sourceHovers.delete(source);
+    }
+  }
+  /**
+   * Enable display of popups when a feature is hovered and an associated popup has been registered with the map data source.
+   * See {@link PopupPlugin} for more details of how to define and register popups.
+   *
+   * Note that popups are enabled by default.
+   */
+  enablePopups() {
+    this._enablePopups = true;
+  }
+  /**
+   * Disable display of popups when a feature is hovered. This will also close any currently open popups.
+   */
+  disablePopups() {
+    if (this._enablePopups) {
+      this.map.getPlugin(PopupPlugin).closeAllPopups();
+      this._enablePopups = false;
+    }
+  }
+  /** @internal MapPluginBase handler */
+  handleMouseMove(event) {
+    if (this._compatibilityMode) {
+      const sourceId = event.features[0]?.source;
+      if (sourceId && !this._sourceHovers.has(sourceId)) {
+        debug(`Enabling implicit hover support for source '${sourceId}' in compatibility mode`);
+        this._sourceHovers.set(sourceId, new SourceHover(this, sourceId, {}));
+      }
+    }
+    const hoveredFeature = event.features[0];
+    this._sourceHovers.forEach((hover) => hover.handleMouseMove(event.lngLat, hoveredFeature, this._enablePopups));
+    const isFeatureHovered = Array.from(this._sourceHovers.values()).some((hover) => !!hover.hoveredFeature);
+    if (isFeatureHovered) {
+      this.map.maplibreMap._container.classList.add("feature-hovered");
+    } else {
+      this.map.maplibreMap._container.classList.remove("feature-hovered");
+    }
+  }
+  /** @internal MapPluginBase handler */
+  handleClick(event) {
+    const hoveredFeature = event.features[0];
+    this._sourceHovers.forEach((hover) => hover.handleClick(event, hoveredFeature));
+  }
+  /** @internal MapPluginBase handler */
+  handleMouseOut(_event) {
+    this.clearHover();
+  }
+  /** @internal MapPluginBase handler */
+  handleSetExclusivePlugin(exclusivePlugins) {
+    if (exclusivePlugins.length) {
+      this.clearHover();
+    }
+  }
+  clearHover() {
+    this._sourceHovers.forEach((hover) => hover.clearHover());
+    this.map.maplibreMap._container.classList.remove("feature-hovered");
+  }
+}
+
+export { HoverPlugin };

package/dist/lib/map/plugins/hover/source-hover.mjs

@@ -0,0 +1,119 @@
+import Debug from 'debug';
+import { assert } from '../../../utils/assert.mjs';
+import { isObject } from '../../../utils/type-checks.mjs';
+import { isFeatureWithId } from '../../types.mjs';
+import { PopupPlugin } from '../popup.plugin.mjs';
+import { SelectionPlugin } from '../selection/selection.plugin.mjs';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+Debug("flow:SourceHover");
+class SourceHover {
+  /** Constructs a SourceHover to handle hover for the specified map data source. */
+  constructor(plugin, source, options) {
+    __publicField(this, "_map");
+    __publicField(this, "_options");
+    __publicField(this, "_plugin");
+    __publicField(this, "_popup");
+    __publicField(this, "_hoveredFeature", null);
+    __publicField(this, "_sourceId");
+    __publicField(this, "_featuresSubscription", null);
+    this._plugin = plugin;
+    this._map = plugin.map;
+    this._options = options;
+    const sourceType = plugin.map.getSource(source).type;
+    this._sourceId = {
+      source,
+      sourceLayer: sourceType === "vector" ? options.sourceLayer ?? "geometry" : void 0
+    };
+  }
+  get options() {
+    return this._options;
+  }
+  get hoveredFeature() {
+    return this._hoveredFeature;
+  }
+  /** Plugin destroy handler */
+  destroy() {
+    this.clearHover();
+    this._featuresSubscription?.unsubscribe();
+  }
+  /** Plugin click handler */
+  handleMouseMove(lngLat, feature, enablePopups = true) {
+    const hoveredSource = !!(feature && feature.source === this._sourceId.source);
+    if (feature && hoveredSource) {
+      if (!this.compareFeatures(feature, this._hoveredFeature)) {
+        this.clearHover(false);
+        this.showHover(feature, lngLat, enablePopups);
+      }
+      if (this._popup && !this._popup.options.trackFeature) {
+        this._popup.moveTo(lngLat);
+      }
+    } else {
+      this.clearHover();
+    }
+  }
+  handleClick(event, feature) {
+    const hoveredSource = !!(feature && feature.source === this._sourceId.source);
+    if (hoveredSource && this._popup) {
+      this._popup.close();
+      this._popup = void 0;
+    }
+  }
+  handleMouseOut() {
+    this.clearHover();
+  }
+  showHover(feature, lngLat, enablePopups) {
+    assert(isFeatureWithId(feature));
+    this._map.setFeatureState(feature, { hover: true }, false);
+    let selected = false;
+    try {
+      const selectionPlugin = this._map.getPlugin(SelectionPlugin);
+      selected = selectionPlugin.featureHasPopup(feature.source, feature.id);
+    } catch {
+    }
+    if (this._popup && selected) {
+      this._popup.close();
+      this._popup = void 0;
+    } else if (this._popup && !this.compareFeatures(feature, this._hoveredFeature)) {
+      this._popup.moveTo(lngLat);
+      this._popup.feature = feature;
+    } else if (!selected && enablePopups) {
+      if (this.options.popup) {
+        const popup = this._map.getPlugin(PopupPlugin).openPopup(this._options.popup, lngLat, feature);
+        if (popup) {
+          popup.on("closed", () => {
+            this._popup = void 0;
+          });
+          this._popup = popup;
+        }
+      }
+    }
+    this._hoveredFeature = feature;
+  }
+  clearHover(closePopup = true) {
+    if (this._hoveredFeature) {
+      this._map.removeFeatureState(this._hoveredFeature, "hover", false);
+      this._hoveredFeature = null;
+    }
+    if (closePopup && this._popup) {
+      this._popup.close();
+      this._popup = void 0;
+    }
+  }
+  compareFeatures(f1, f2) {
+    if (f1 === f2) {
+      return true;
+    }
+    if (isObject(f1) && isObject(f2)) {
+      return f1.id == f2.id && f1.source === f2.source && f1.sourceLayer == f2.sourceLayer;
+    }
+    return false;
+  }
+}
+
+export { SourceHover };

package/dist/lib/map/plugins/hover-effect.plugin.mjs

@@ -18,7 +18,15 @@ class HoverEffectPlugin extends MapPluginBase {
   constructor(pluginManager) {
     super(pluginManager);
     __publicField(this, "hoveredFeature", null);
+    __publicField(this, "_popups", /* @__PURE__ */ new Map());
     __publicField(this, "name", "HoverEffectPlugin");
+    try {
+      pluginManager.getPlugin("HoverPlugin");
+      console.warn(
+        "[HoverEffectPlugin] Warning: HoverEffectPlugin has been deprecated and should be removed to avoid conflicts with HoverPlugin."
+      );
+    } catch {
+    }
   }
   /** @internal MapPluginBase handler */
   handleMouseMove(event) {

package/dist/lib/map/plugins/index.d.mts

@@ -1,5 +1,5 @@
-import { a3 as MapEvent, a0 as FlowCoreMap, Y as MapSourceIdentifier, av as MapFeatureId, aw as MapPluginBase, ax as PluginManager, a5 as MapSourceEvent, a4 as MapMouseEvent, Z as MapFeatureStream, ay as PartialBy, T as MapAnimationOptions, a7 as MapStyleChangeEvent, M as MapStyleSpecification, S as StateStore, a9 as MapPopupOptions, aa as MapPopup, W as MapFeatureIdentifier } from '../../../shared/flow-rdf-core.3da5bd49.mjs';
-export { aC as EventHandlers, aB as PluginConstructor, aA as PluginEventsType, az as PluginOptionsType } from '../../../shared/flow-rdf-core.3da5bd49.mjs';
+import { a3 as MapEvent, a0 as FlowCoreMap, Y as MapSourceIdentifier, av as MapFeatureId, aw as MapPluginBase, ax as PluginManager, a5 as MapSourceEvent, a4 as MapMouseEvent, Z as MapFeatureStream, ay as PartialBy, T as MapAnimationOptions, a7 as MapStyleChangeEvent, M as MapStyleSpecification, S as StateStore, a9 as MapPopupOptions, aa as MapPopup, W as MapFeatureIdentifier } from '../../../shared/flow-rdf-core.09a21889.mjs';
+export { aC as EventHandlers, aB as PluginConstructor, aA as PluginEventsType, az as PluginOptionsType } from '../../../shared/flow-rdf-core.09a21889.mjs';
 import { F as Func } from '../../../shared/flow-rdf-core.63162669.mjs';
 import 'eventemitter3';
 import 'lit-html';
@@ -316,6 +316,7 @@ declare class SelectionPlugin extends MapPluginBase<undefined, SelectionEventTyp
      * Disable display of popups when a feature is clicked. This will also close any currently open popups.
      */
     disablePopups(): void;
+    featureHasPopup(source: string, featureId: MapFeatureId): boolean;
 }
 
 /**
@@ -894,6 +895,8 @@ declare class ExportPlugin extends MapPluginBase<ExportPluginOptions> {
 }
 
 /**
+ * @deprecated HoverEffectPlugin has been deprecated. Use {@link HoverPlugin} instead.
+ *
  * This plugin adds hover styling support to map features.
  *
  * When active, features that are hovered over will have their `hover`
@@ -922,6 +925,7 @@ declare class ExportPlugin extends MapPluginBase<ExportPluginOptions> {
  */
 declare class HoverEffectPlugin extends MapPluginBase {
     private hoveredFeature;
+    private _popups;
     readonly name = "HoverEffectPlugin";
     /**
      * Constructs a new HoverEffectPlugin instance. This is called automatically when the plugin is added to a {@link FlowCoreMap} instance
@@ -940,6 +944,128 @@ declare class HoverEffectPlugin extends MapPluginBase {
     private clearHover;
 }
 
+interface HoverOptions {
+    /** ID of popup to display when hovering over a feature. */
+    popup?: string;
+    /** Map data source layer. Note that this is only required for custom vector data sources. */
+    sourceLayer?: string;
+}
+/**
+ * This plugin adds hover styling and hover popup support to map features.
+ *
+ * When active, features that are hovered over will have their `hover`
+ * feature state property set to `true`. This can be referenced in map layer
+ * style expressions to apply hover effects.
+ *
+ * To enable hover support for a specific map data source, use the {@link enableHover} method.
+ * This method accepts a {@link HoverOptions} object that can be used to configure hover behavior
+ * and add a hover popup.
+ *
+ * :::warning
+ * This plugin supersedes the deprecated {@link HoverEffectPlugin}. To preserve the
+ * behavior of the {@link HoverEffectPlugin}, the {@link HoverPlugin} initially operates
+ * in 'compatibility mode' and implicitly enables hover for **all** map data sources.
+ * The first call to {@link enableHover} will disable compatibility mode and hover effects
+ * for other data sources must be explicitly enabled.
+ * :::
+ *
+ * ## Hover Popups
+ *
+ * This plugin can automatically display a popup when a feature is hovered over.
+ * The popup specified (if any) should be previously registered with the map data source
+ * using the {@link PopupPlugin}.
+ *
+ * Hover popups should be designed to be non-intrusive, as they will appear
+ * and disappear frequently as the user moves the mouse over the map. They should be
+ * configured with `closeButton: false` and not support any other user interaction.
+ * If `trackFeature` is enabled when registering the popup, the popup will snap to the
+ * feature centroid. If `trackFeature` is not enabled, the popup will move with the mouse
+ * cursor. For point-type features, it is recommended to enable `trackFeature` for a
+ * cleaner user experience. For polygon and line features, it is recommended to set
+ * `trackFeature` to `false` so that the popup follows the mouse cursor.
+ *
+ * This plugin interacts with the {@link SelectionPlugin} (if used) to coordinate display
+ * of hover and selection popups. A selection popup will take precedence over
+ * a hover popup when both are applicable ensuring that hover popups do not obscure
+ * selection popups.
+ *
+ * @noInheritDoc
+ *
+ * @example
+ * This map layer definition applies a hover effect using the `circleStrokeWidth` property:
+```js{7}
+  const circleLayer = new MapLayer({
+    id: "circle-layer",
+    type: "circle",
+    source: "airquality",
+    style: layerStyle("circle")
+      .circleColor(expr(`@no2 ? from-palette('YlOrRd', @no2, 0, 100) : gray`))
+      .circleStrokeWidth(expr("@@hover ? 5 : 0"))
+      .circleRadius(expr(`@no2 ? @no2 / 5 : 5`))
+      .build()
+  });
+
+  // Register a popup to use on hover for the data source
+  map.getPlugin(PopupPlugin).registerPopup('hoverPopup', {
+    trackFeature: true,
+    closeButton: false,
+    content: (feature) =>
+      html` Hover popup: ${feature?.id}`
+  });
+
+  map.getPlugin(HoverPlugin).enableHover('airquality', {
+    popup: 'hoverPopup'
+  });
+```
+ *
+ */
+declare class HoverPlugin extends MapPluginBase {
+    private _sourceHovers;
+    private _enablePopups;
+    private _compatibilityMode;
+    readonly name = "HoverPlugin";
+    /**
+     * Constructs a new HoverEffectPlugin instance. This is called automatically when the plugin is added to a {@link FlowCoreMap} instance
+     * using {@link FlowCoreMap.usePlugin} method.
+     *
+     * @param pluginManager The plugin manager instance associated with the map
+     */
+    constructor(pluginManager: PluginManager);
+    /**
+     * Enable hover popup support for the specified map data source.
+     *
+     * @param source Map data source ID
+     * @param options Selection options
+     */
+    enableHover(source: string, options?: HoverOptions): void;
+    /**
+     * Disable hover for the specified map data source.
+     *
+     * @param source Map data source ID
+     */
+    disableHover(source: string): void;
+    /**
+     * Enable display of popups when a feature is hovered and an associated popup has been registered with the map data source.
+     * See {@link PopupPlugin} for more details of how to define and register popups.
+     *
+     * Note that popups are enabled by default.
+     */
+    enablePopups(): void;
+    /**
+     * Disable display of popups when a feature is hovered. This will also close any currently open popups.
+     */
+    disablePopups(): void;
+    /** @internal MapPluginBase handler */
+    handleMouseMove(event: MapMouseEvent): void;
+    /** @internal MapPluginBase handler */
+    handleClick(event: MapMouseEvent): void;
+    /** @internal MapPluginBase handler */
+    handleMouseOut(_event: MapEvent): void;
+    /** @internal MapPluginBase handler */
+    handleSetExclusivePlugin(exclusivePlugins: MapPluginBase[]): void;
+    private clearHover;
+}
+
 /**
  * @noInheritDoc
  *
@@ -1016,4 +1142,4 @@ declare class PopupPlugin extends MapPluginBase {
     closePopupsForSources(sources: string | string[]): void;
 }
 
-export { AnnotationEvent, type AnnotationEventData, type AnnotationEventType, type AnnotationEventTypes, type AnnotationFeature, type AnnotationFeatureProps, type AnnotationFeatureType, type AnnotationMode, type AnnotationOperation, AnnotationPlugin, type AnnotationPluginOptions, type AnnotationStyle, DataJoin, type DataJoinOptions, DataJoinPlugin, type DrawOverlayCallback, type DrawOverlayFn, ExportPlugin, type ExportPluginOptions, type FlowMapExportOptions, HoverEffectPlugin, MapPluginBase, PluginManager, PopupPlugin, SelectionEvent, type SelectionEventType, type SelectionEventTypes, type SelectionMode, type SelectionOptions, SelectionPlugin };
+export { AnnotationEvent, type AnnotationEventData, type AnnotationEventType, type AnnotationEventTypes, type AnnotationFeature, type AnnotationFeatureProps, type AnnotationFeatureType, type AnnotationMode, type AnnotationOperation, AnnotationPlugin, type AnnotationPluginOptions, type AnnotationStyle, DataJoin, type DataJoinOptions, DataJoinPlugin, type DrawOverlayCallback, type DrawOverlayFn, ExportPlugin, type ExportPluginOptions, type FlowMapExportOptions, HoverEffectPlugin, type HoverOptions, HoverPlugin, MapPluginBase, PluginManager, PopupPlugin, SelectionEvent, type SelectionEventType, type SelectionEventTypes, type SelectionMode, type SelectionOptions, SelectionPlugin };

package/dist/lib/map/plugins/index.d.ts

@@ -1,5 +1,5 @@
-import { a3 as MapEvent, a0 as FlowCoreMap, Y as MapSourceIdentifier, av as MapFeatureId, aw as MapPluginBase, ax as PluginManager, a5 as MapSourceEvent, a4 as MapMouseEvent, Z as MapFeatureStream, ay as PartialBy, T as MapAnimationOptions, a7 as MapStyleChangeEvent, M as MapStyleSpecification, S as StateStore, a9 as MapPopupOptions, aa as MapPopup, W as MapFeatureIdentifier } from '../../../shared/flow-rdf-core.3da5bd49.js';
-export { aC as EventHandlers, aB as PluginConstructor, aA as PluginEventsType, az as PluginOptionsType } from '../../../shared/flow-rdf-core.3da5bd49.js';
+import { a3 as MapEvent, a0 as FlowCoreMap, Y as MapSourceIdentifier, av as MapFeatureId, aw as MapPluginBase, ax as PluginManager, a5 as MapSourceEvent, a4 as MapMouseEvent, Z as MapFeatureStream, ay as PartialBy, T as MapAnimationOptions, a7 as MapStyleChangeEvent, M as MapStyleSpecification, S as StateStore, a9 as MapPopupOptions, aa as MapPopup, W as MapFeatureIdentifier } from '../../../shared/flow-rdf-core.09a21889.js';
+export { aC as EventHandlers, aB as PluginConstructor, aA as PluginEventsType, az as PluginOptionsType } from '../../../shared/flow-rdf-core.09a21889.js';
 import { F as Func } from '../../../shared/flow-rdf-core.63162669.js';
 import 'eventemitter3';
 import 'lit-html';
@@ -316,6 +316,7 @@ declare class SelectionPlugin extends MapPluginBase<undefined, SelectionEventTyp
      * Disable display of popups when a feature is clicked. This will also close any currently open popups.
      */
     disablePopups(): void;
+    featureHasPopup(source: string, featureId: MapFeatureId): boolean;
 }
 
 /**
@@ -894,6 +895,8 @@ declare class ExportPlugin extends MapPluginBase<ExportPluginOptions> {
 }
 
 /**
+ * @deprecated HoverEffectPlugin has been deprecated. Use {@link HoverPlugin} instead.
+ *
  * This plugin adds hover styling support to map features.
  *
  * When active, features that are hovered over will have their `hover`
@@ -922,6 +925,7 @@ declare class ExportPlugin extends MapPluginBase<ExportPluginOptions> {
  */
 declare class HoverEffectPlugin extends MapPluginBase {
     private hoveredFeature;
+    private _popups;
     readonly name = "HoverEffectPlugin";
     /**
      * Constructs a new HoverEffectPlugin instance. This is called automatically when the plugin is added to a {@link FlowCoreMap} instance
@@ -940,6 +944,128 @@ declare class HoverEffectPlugin extends MapPluginBase {
     private clearHover;
 }
 
+interface HoverOptions {
+    /** ID of popup to display when hovering over a feature. */
+    popup?: string;
+    /** Map data source layer. Note that this is only required for custom vector data sources. */
+    sourceLayer?: string;
+}
+/**
+ * This plugin adds hover styling and hover popup support to map features.
+ *
+ * When active, features that are hovered over will have their `hover`
+ * feature state property set to `true`. This can be referenced in map layer
+ * style expressions to apply hover effects.
+ *
+ * To enable hover support for a specific map data source, use the {@link enableHover} method.
+ * This method accepts a {@link HoverOptions} object that can be used to configure hover behavior
+ * and add a hover popup.
+ *
+ * :::warning
+ * This plugin supersedes the deprecated {@link HoverEffectPlugin}. To preserve the
+ * behavior of the {@link HoverEffectPlugin}, the {@link HoverPlugin} initially operates
+ * in 'compatibility mode' and implicitly enables hover for **all** map data sources.
+ * The first call to {@link enableHover} will disable compatibility mode and hover effects
+ * for other data sources must be explicitly enabled.
+ * :::
+ *
+ * ## Hover Popups
+ *
+ * This plugin can automatically display a popup when a feature is hovered over.
+ * The popup specified (if any) should be previously registered with the map data source
+ * using the {@link PopupPlugin}.
+ *
+ * Hover popups should be designed to be non-intrusive, as they will appear
+ * and disappear frequently as the user moves the mouse over the map. They should be
+ * configured with `closeButton: false` and not support any other user interaction.
+ * If `trackFeature` is enabled when registering the popup, the popup will snap to the
+ * feature centroid. If `trackFeature` is not enabled, the popup will move with the mouse
+ * cursor. For point-type features, it is recommended to enable `trackFeature` for a
+ * cleaner user experience. For polygon and line features, it is recommended to set
+ * `trackFeature` to `false` so that the popup follows the mouse cursor.
+ *
+ * This plugin interacts with the {@link SelectionPlugin} (if used) to coordinate display
+ * of hover and selection popups. A selection popup will take precedence over
+ * a hover popup when both are applicable ensuring that hover popups do not obscure
+ * selection popups.
+ *
+ * @noInheritDoc
+ *
+ * @example
+ * This map layer definition applies a hover effect using the `circleStrokeWidth` property:
+```js{7}
+  const circleLayer = new MapLayer({
+    id: "circle-layer",
+    type: "circle",
+    source: "airquality",
+    style: layerStyle("circle")
+      .circleColor(expr(`@no2 ? from-palette('YlOrRd', @no2, 0, 100) : gray`))
+      .circleStrokeWidth(expr("@@hover ? 5 : 0"))
+      .circleRadius(expr(`@no2 ? @no2 / 5 : 5`))
+      .build()
+  });
+
+  // Register a popup to use on hover for the data source
+  map.getPlugin(PopupPlugin).registerPopup('hoverPopup', {
+    trackFeature: true,
+    closeButton: false,
+    content: (feature) =>
+      html` Hover popup: ${feature?.id}`
+  });
+
+  map.getPlugin(HoverPlugin).enableHover('airquality', {
+    popup: 'hoverPopup'
+  });
+```
+ *
+ */
+declare class HoverPlugin extends MapPluginBase {
+    private _sourceHovers;
+    private _enablePopups;
+    private _compatibilityMode;
+    readonly name = "HoverPlugin";
+    /**
+     * Constructs a new HoverEffectPlugin instance. This is called automatically when the plugin is added to a {@link FlowCoreMap} instance
+     * using {@link FlowCoreMap.usePlugin} method.
+     *
+     * @param pluginManager The plugin manager instance associated with the map
+     */
+    constructor(pluginManager: PluginManager);
+    /**
+     * Enable hover popup support for the specified map data source.
+     *
+     * @param source Map data source ID
+     * @param options Selection options
+     */
+    enableHover(source: string, options?: HoverOptions): void;
+    /**
+     * Disable hover for the specified map data source.
+     *
+     * @param source Map data source ID
+     */
+    disableHover(source: string): void;
+    /**
+     * Enable display of popups when a feature is hovered and an associated popup has been registered with the map data source.
+     * See {@link PopupPlugin} for more details of how to define and register popups.
+     *
+     * Note that popups are enabled by default.
+     */
+    enablePopups(): void;
+    /**
+     * Disable display of popups when a feature is hovered. This will also close any currently open popups.
+     */
+    disablePopups(): void;
+    /** @internal MapPluginBase handler */
+    handleMouseMove(event: MapMouseEvent): void;
+    /** @internal MapPluginBase handler */
+    handleClick(event: MapMouseEvent): void;
+    /** @internal MapPluginBase handler */
+    handleMouseOut(_event: MapEvent): void;
+    /** @internal MapPluginBase handler */
+    handleSetExclusivePlugin(exclusivePlugins: MapPluginBase[]): void;
+    private clearHover;
+}
+
 /**
  * @noInheritDoc
  *
@@ -1016,4 +1142,4 @@ declare class PopupPlugin extends MapPluginBase {
     closePopupsForSources(sources: string | string[]): void;
 }
 
-export { AnnotationEvent, type AnnotationEventData, type AnnotationEventType, type AnnotationEventTypes, type AnnotationFeature, type AnnotationFeatureProps, type AnnotationFeatureType, type AnnotationMode, type AnnotationOperation, AnnotationPlugin, type AnnotationPluginOptions, type AnnotationStyle, DataJoin, type DataJoinOptions, DataJoinPlugin, type DrawOverlayCallback, type DrawOverlayFn, ExportPlugin, type ExportPluginOptions, type FlowMapExportOptions, HoverEffectPlugin, MapPluginBase, PluginManager, PopupPlugin, SelectionEvent, type SelectionEventType, type SelectionEventTypes, type SelectionMode, type SelectionOptions, SelectionPlugin };
+export { AnnotationEvent, type AnnotationEventData, type AnnotationEventType, type AnnotationEventTypes, type AnnotationFeature, type AnnotationFeatureProps, type AnnotationFeatureType, type AnnotationMode, type AnnotationOperation, AnnotationPlugin, type AnnotationPluginOptions, type AnnotationStyle, DataJoin, type DataJoinOptions, DataJoinPlugin, type DrawOverlayCallback, type DrawOverlayFn, ExportPlugin, type ExportPluginOptions, type FlowMapExportOptions, HoverEffectPlugin, type HoverOptions, HoverPlugin, MapPluginBase, PluginManager, PopupPlugin, SelectionEvent, type SelectionEventType, type SelectionEventTypes, type SelectionMode, type SelectionOptions, SelectionPlugin };

package/dist/lib/map/plugins/index.mjs

@@ -3,6 +3,7 @@ export { AnnotationPlugin } from './annotations/annotation.plugin.mjs';
 export { DataJoin, DataJoinPlugin } from './data-join.plugin.mjs';
 export { ExportPlugin } from './export/export.plugin.mjs';
 export { HoverEffectPlugin } from './hover-effect.plugin.mjs';
+export { HoverPlugin } from './hover/hover.plugin.mjs';
 export { MapPluginBase } from './map-plugin-base.mjs';
 export { PluginManager } from './plugin-manager.mjs';
 export { PopupPlugin } from './popup.plugin.mjs';

package/dist/lib/map/plugins/selection/selection.plugin.mjs

@@ -202,6 +202,13 @@ class SelectionPlugin extends MapPluginBase {
       this._enablePopups = false;
     }
   }
+  featureHasPopup(source, featureId) {
+    const sourceSelection = this._sourceSelections.get(source);
+    if (!sourceSelection) {
+      return false;
+    }
+    return sourceSelection.featureHasPopup(featureId);
+  }
 }
 
 export { SelectionPlugin };

package/dist/lib/map/plugins/selection/source-selection.mjs

@@ -153,6 +153,9 @@ class SourceSelection {
     }
     this.showPendingPopups();
   }
+  featureHasPopup(featureId) {
+    return this._popups.has(featureId);
+  }
   areSetsEqual(a, b) {
     return a.size === b.size && [...a].every((value) => b.has(value));
   }

package/dist/lib/map/support/map-popup.mjs

@@ -50,6 +50,12 @@ class MapPopup extends EventEmitter {
   get feature() {
     return this._feature;
   }
+  set feature(feature) {
+    this._feature = feature;
+    if (this._featureStream) {
+      this._featureStream.featureIds = feature ? [feature.id] : [];
+    }
+  }
   /**
    * Close the popup.
    */
@@ -102,7 +108,7 @@ class MapPopup extends EventEmitter {
       this._featureStreamDisposer = this.map.context.state.autorun(() => {
         const data = this._featureStream?.featureData;
         if (data) {
-          this.handleFeatureUpdate(data[feature.id]);
+          this.handleFeatureUpdate(data[this._feature.id]);
         }
       });
     } else {

package/dist/package.json.mjs

@@ -1,3 +1,3 @@
-const version = "4.0.15";
+const version = "4.0.16";
 
 export { version };

package/dist/shared/{flow-rdf-core.3da5bd49.d.mts → flow-rdf-core.09a21889.d.mts}

@@ -3242,6 +3242,7 @@ declare class MapPopup extends EventEmitter$1<MapPopupEvents> {
      * Get the map feature associated with the popup.
      */
     get feature(): MapFeatureIdentifier | undefined;
+    set feature(feature: MapFeatureIdentifier | undefined);
     /**
      * Close the popup.
      */

package/dist/shared/{flow-rdf-core.3da5bd49.d.ts → flow-rdf-core.09a21889.d.ts}

@@ -3242,6 +3242,7 @@ declare class MapPopup extends EventEmitter$1<MapPopupEvents> {
      * Get the map feature associated with the popup.
      */
     get feature(): MapFeatureIdentifier | undefined;
+    set feature(feature: MapFeatureIdentifier | undefined);
     /**
      * Close the popup.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emuanalytics/flow-rdf-core",
-  "version": "4.0.15",
+  "version": "4.0.16",
   "description": "",
   "sideEffects": false,
   "type": "module",