@emuanalytics/flow-rdf-core 4.0.4 → 4.0.5

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

@@ -1,8 +1,8 @@
-import { a8 as MapEvent, K as FlowCoreMap, I as MapSourceIdentifier, a9 as MapFeatureId, aa as MapPluginBase, ab as PluginManager, ac as MapSourceEvent, ad as MapMouseEvent, ae as MapFeatureStream, af as PartialBy, x as MapAnimationOptions, ag as MapStyleChangeEvent, M as MapStyleSpecification, S as StateStore, E as MapFeatureIdentifier, z as MapFeature } from '../../../shared/flow-rdf-core.4dde996e.mjs';
-export { ak as EventHandlers, aj as PluginConstructor, ai as PluginEventsType, ah as PluginOptionsType } from '../../../shared/flow-rdf-core.4dde996e.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.8b5acf14.mjs';
+export { aC as EventHandlers, aB as PluginConstructor, aA as PluginEventsType, az as PluginOptionsType } from '../../../shared/flow-rdf-core.8b5acf14.mjs';
 import { F as Func } from '../../../shared/flow-rdf-core.63162669.mjs';
-import EventEmitter from 'eventemitter3';
-import * as lit from 'lit-html';
+import 'eventemitter3';
+import 'lit-html';
 import '@emuanalytics/flow-engine-client';
 import 'mobx-utils';
 import '@emuanalytics/maplibre-gl';
@@ -195,6 +195,12 @@ declare class DataJoin {
     private doDataJoin;
     private loadData;
 }
+/**
+ *  dfsffd
+ *
+ *  @noInheritDoc
+ *
+ */
 declare class DataJoinPlugin extends MapPluginBase {
     private _joins;
     readonly name = "DataJoinPlugin";
@@ -242,6 +248,33 @@ declare class ExportPlugin extends MapPluginBase<ExportPluginOptions> {
     exportMap(options: FlowMapExportOptions): Promise<string>;
 }
 
+/**
+ * This plugin supports adding hover styling 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.
+ *
+ * The plugin exposes no additional API methods or properties.
+ *
+ * @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()
+  });
+```
+ *
+ */
 declare class HoverEffectPlugin extends MapPluginBase {
     private hoveredFeature;
     readonly name = "HoverEffectPlugin";
@@ -253,74 +286,6 @@ declare class HoverEffectPlugin extends MapPluginBase {
     private clearHover;
 }
 
-type MapPopupTemplateFn<TState extends StateStore = StateStore> = (feature: MapFeature | null, state: TState) => string | Node | lit.TemplateResult;
-interface MapPopupEvents {
-    closed: (popup: MapPopup) => void;
-}
-/**
- * [[MapPopup]] options.
- */
-interface MapPopupOptions {
-    /** Specify a CSS class to add to the popup. */
-    class?: string;
-    /** Enable 'close' button. */
-    closeButton?: boolean;
-    /** Enable closing popup on click on map. */
-    closeOnClick?: boolean;
-    /** Enable closing pop when map is moved. */
-    closeOnMove?: boolean;
-    /** Specify popup content as HTML string or HTML node. */
-    content: string | Node | MapPopupTemplateFn;
-    /** Maximum width of popup in CSS units. */
-    maxWidth?: string;
-    trackFeature?: boolean;
-}
-/**
- * Core functionality for Flo.w map popups.
- *
- * @noInheritDoc
- */
-declare class MapPopup extends EventEmitter<MapPopupEvents> {
-    readonly map: FlowCoreMap;
-    readonly options: MapPopupOptions;
-    private _feature?;
-    private _contentContainer;
-    private _featureStream;
-    private _maplibrePopup;
-    private _featureStreamDisposer?;
-    /**
-     * Constructs a new `MapPopup` instance.
-     *
-     * This is called by the `FlowMap::openPopup` method.
-     *
-     * @param map Parent Flo.w map.
-     * @param options Popup options.
-     */
-    constructor(map: FlowCoreMap, options: MapPopupOptions);
-    get feature(): MapFeatureIdentifier | undefined;
-    /**
-     * Close the popup.
-     */
-    close(): void;
-    /**
-     * Move the popup to a new location.
-     *
-     * @param lngLat New location.
-     */
-    moveTo(lngLat: [number, number]): void;
-    /**
-     * Open the popup at the specified location.
-     *
-     * @param lngLat Popup location.
-     */
-    open(event: MapMouseEvent): void;
-    open(lngLat: [number, number], feature?: MapFeatureIdentifier): void;
-    private cssClasses;
-    private handleFeatureUpdate;
-    private popupCloseHandler;
-    private renderContent;
-}
-
 declare class PopupPlugin extends MapPluginBase {
     private _popupTemplates;
     private _popups;

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

@@ -1,8 +1,8 @@
-import { a8 as MapEvent, K as FlowCoreMap, I as MapSourceIdentifier, a9 as MapFeatureId, aa as MapPluginBase, ab as PluginManager, ac as MapSourceEvent, ad as MapMouseEvent, ae as MapFeatureStream, af as PartialBy, x as MapAnimationOptions, ag as MapStyleChangeEvent, M as MapStyleSpecification, S as StateStore, E as MapFeatureIdentifier, z as MapFeature } from '../../../shared/flow-rdf-core.4dde996e.js';
-export { ak as EventHandlers, aj as PluginConstructor, ai as PluginEventsType, ah as PluginOptionsType } from '../../../shared/flow-rdf-core.4dde996e.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.8b5acf14.js';
+export { aC as EventHandlers, aB as PluginConstructor, aA as PluginEventsType, az as PluginOptionsType } from '../../../shared/flow-rdf-core.8b5acf14.js';
 import { F as Func } from '../../../shared/flow-rdf-core.63162669.js';
-import EventEmitter from 'eventemitter3';
-import * as lit from 'lit-html';
+import 'eventemitter3';
+import 'lit-html';
 import '@emuanalytics/flow-engine-client';
 import 'mobx-utils';
 import '@emuanalytics/maplibre-gl';
@@ -195,6 +195,12 @@ declare class DataJoin {
     private doDataJoin;
     private loadData;
 }
+/**
+ *  dfsffd
+ *
+ *  @noInheritDoc
+ *
+ */
 declare class DataJoinPlugin extends MapPluginBase {
     private _joins;
     readonly name = "DataJoinPlugin";
@@ -242,6 +248,33 @@ declare class ExportPlugin extends MapPluginBase<ExportPluginOptions> {
     exportMap(options: FlowMapExportOptions): Promise<string>;
 }
 
+/**
+ * This plugin supports adding hover styling 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.
+ *
+ * The plugin exposes no additional API methods or properties.
+ *
+ * @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()
+  });
+```
+ *
+ */
 declare class HoverEffectPlugin extends MapPluginBase {
     private hoveredFeature;
     readonly name = "HoverEffectPlugin";
@@ -253,74 +286,6 @@ declare class HoverEffectPlugin extends MapPluginBase {
     private clearHover;
 }
 
-type MapPopupTemplateFn<TState extends StateStore = StateStore> = (feature: MapFeature | null, state: TState) => string | Node | lit.TemplateResult;
-interface MapPopupEvents {
-    closed: (popup: MapPopup) => void;
-}
-/**
- * [[MapPopup]] options.
- */
-interface MapPopupOptions {
-    /** Specify a CSS class to add to the popup. */
-    class?: string;
-    /** Enable 'close' button. */
-    closeButton?: boolean;
-    /** Enable closing popup on click on map. */
-    closeOnClick?: boolean;
-    /** Enable closing pop when map is moved. */
-    closeOnMove?: boolean;
-    /** Specify popup content as HTML string or HTML node. */
-    content: string | Node | MapPopupTemplateFn;
-    /** Maximum width of popup in CSS units. */
-    maxWidth?: string;
-    trackFeature?: boolean;
-}
-/**
- * Core functionality for Flo.w map popups.
- *
- * @noInheritDoc
- */
-declare class MapPopup extends EventEmitter<MapPopupEvents> {
-    readonly map: FlowCoreMap;
-    readonly options: MapPopupOptions;
-    private _feature?;
-    private _contentContainer;
-    private _featureStream;
-    private _maplibrePopup;
-    private _featureStreamDisposer?;
-    /**
-     * Constructs a new `MapPopup` instance.
-     *
-     * This is called by the `FlowMap::openPopup` method.
-     *
-     * @param map Parent Flo.w map.
-     * @param options Popup options.
-     */
-    constructor(map: FlowCoreMap, options: MapPopupOptions);
-    get feature(): MapFeatureIdentifier | undefined;
-    /**
-     * Close the popup.
-     */
-    close(): void;
-    /**
-     * Move the popup to a new location.
-     *
-     * @param lngLat New location.
-     */
-    moveTo(lngLat: [number, number]): void;
-    /**
-     * Open the popup at the specified location.
-     *
-     * @param lngLat Popup location.
-     */
-    open(event: MapMouseEvent): void;
-    open(lngLat: [number, number], feature?: MapFeatureIdentifier): void;
-    private cssClasses;
-    private handleFeatureUpdate;
-    private popupCloseHandler;
-    private renderContent;
-}
-
 declare class PopupPlugin extends MapPluginBase {
     private _popupTemplates;
     private _popups;