@tomtom-org/maps-sdk 0.45.4 → 0.45.6

package/map/dist/index.d.ts

@@ -14,6 +14,7 @@ import { ExpressionFilterSpecification } from 'maplibre-gl';
 import { ExpressionSpecification } from 'maplibre-gl';
 import { Feature } from 'geojson';
 import { FeatureCollection } from 'geojson';
+import { GeoJsonProperties } from 'geojson';
 import { GeoJSONSource } from 'maplibre-gl';
 import { GeoJSONSourceSpecification } from 'maplibre-gl';
 import { GetPositionEntryPointOption } from '@tomtom-org/maps-sdk/core';
@@ -2983,6 +2984,24 @@ export declare class GeometriesModule extends AbstractMapModule<GeometrySourcesW
      * ```
      */
     clear(): Promise<void>;
+    /**
+     * Returns the currently shown geometries.
+     *
+     * @returns The geometries currently displayed on the map.
+     *
+     * @remarks
+     * Returns the exact data that was passed to the `show()` method.
+     *
+     * @example
+     * ```typescript
+     * const shown = geometriesModule.getShown();
+     * console.log(`Geometries: ${shown.geometry.features.length}`);
+     * ```
+     */
+    getShown(): {
+        geometry: PolygonFeatures;
+        geometryLabel: FeatureCollection<Point, GeoJsonProperties>;
+    };
     /**
      * Gets the events interface for handling user interactions with geometries.
      *
@@ -3611,8 +3630,11 @@ declare type HillshadeSourcesWithLayers = {
  * Subtype for hover events with timing distinction.
  *
  * @remarks
- * - `hover`: Immediate hover when cursor enters a feature
- * - `long-hover`: Triggered after hovering for a configured duration (typically 300-800ms)
+ * - `hover`: Fires once when the cursor first enters a feature
+ * - `hover-move`: Fires on every mouse movement while the cursor remains over the same feature.
+ *   Use this when you need continuously updated coordinates as the cursor travels along the feature
+ *   (e.g. updating a tooltip position or snapping to a route line).
+ * - `long-hover`: Triggered after hovering over a feature for a configured duration (typically 300-800ms)
  *
  * Long-hover is useful for showing detailed tooltips or previews without
  * cluttering the UI during quick mouse movements.
@@ -3620,12 +3642,13 @@ declare type HillshadeSourcesWithLayers = {
  * @example
  * ```typescript
  * const quickHover: HoverEventType = 'hover';
+ * const movingHover: HoverEventType = 'hover-move';
  * const sustainedHover: HoverEventType = 'long-hover';
  * ```
  *
  * @group User Interaction Events
  */
-export declare type HoverEventType = 'hover' | 'long-hover';
+export declare type HoverEventType = 'hover' | 'hover-move' | 'long-hover';
 
 /**
  * Available traffic incident category identifiers.
@@ -4786,6 +4809,23 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      * ```
      */
     clear(): Promise<void>;
+    /**
+     * Returns the currently shown places.
+     *
+     * @returns The places currently displayed on the map.
+     *
+     * @remarks
+     * Returns the exact data that was passed to the `show()` method.
+     *
+     * @example
+     * ```typescript
+     * const shown = placesModule.getShown();
+     * console.log(`Showing ${shown.places.features.length} places`);
+     * ```
+     */
+    getShown(): {
+        places: Places<DisplayPlaceProps>;
+    };
     /**
      * Programmatically sets an event state on a specific place.
      *
@@ -5489,6 +5529,23 @@ export declare class POIsModule extends AbstractMapModule<PoIsSourcesAndLayers,
      * ```
      */
     filterCategories(categoriesFilter?: ValuesFilter<FilterablePOICategory> | undefined): void;
+    /**
+     * Returns features currently visible in the viewport.
+     *
+     * @returns An object containing visible POI features with properly typed properties.
+     *
+     * @example
+     * ```typescript
+     * const shown = poisModule.getShown();
+     * console.log(`Visible POIs: ${shown.poi.length}`);
+     * shown.poi.forEach(poi => {
+     *   console.log(poi.properties.name, poi.properties.category);
+     * });
+     * ```
+     */
+    getShown(): {
+        poi: POIsModuleFeature[];
+    };
     /**
      * Gets the events interface for handling user interactions with POIs.
      *
@@ -5638,6 +5695,7 @@ export declare type POIsModuleConfig = MapModuleCommonConfig & {
  * ```
  *
  * @group POIs
+ * @see https://docs.tomtom.com/map-display-api/documentation/tomtom-orbis-maps/vector/content#poi for more details on the available properties from the vector tile features
  */
 export declare type POIsModuleFeature = Omit<MapGeoJSONFeature, 'properties'> & {
     /**
@@ -5671,19 +5729,9 @@ export declare type POIsModuleFeature = Omit<MapGeoJSONFeature, 'properties'> &
          * Used for styling and filtering purposes. Maps to a specific POI type
          * (e.g., RESTAURANT, HOTEL_MOTEL).
          *
-         * @example 'RESTAURANT'
+         * @example 'restaurant'
          */
         category: string;
-        /**
-         * Sprite image ID for this POI's icon.
-         *
-         * @remarks
-         * References an image within the map style's sprite sheet used to
-         * render the POI icon on the map.
-         *
-         * @example 'restaurant-15'
-         */
-        iconID: string;
         /**
          * Broad category group this POI belongs to.
          *
@@ -6497,6 +6545,59 @@ export declare class RoutingModule extends AbstractMapModule<RoutingSourcesWithL
      * * If nothing was shown before, nothing happens.
      */
     clearWaypoints(): Promise<void>;
+    /**
+     * Returns the currently shown routes and waypoints.
+     *
+     * @returns An object containing all currently displayed routing data.
+     *
+     * @remarks
+     * Returns the exact data that was passed to the `showRoutes()` and `showWaypoints()` methods.
+     *
+     * **Returned Data:**
+     * - `mainLines`: Main route lines (selected and alternative)
+     * - `waypoints`: Route waypoints (start, stops, finish)
+     * - `incidents`: Traffic incidents on routes
+     * - `ferries`: Ferry sections
+     * - `chargingStops`: EV charging stations
+     * - `tollRoads`: Toll road sections
+     * - `tunnels`: Tunnel sections
+     * - `vehicleRestricted`: Vehicle-restricted sections
+     * - `instructionLines`: Turn-by-turn instruction lines
+     * - `instructionArrows`: Instruction arrow markers
+     * - `summaryBubbles`: Route summary popups
+     *
+     * @example
+     * ```typescript
+     * const shown = routingModule.getShown();
+     * console.log(`Showing ${shown.mainLines.features.length} routes`);
+     * console.log(`Showing ${shown.waypoints.features.length} waypoints`);
+     * console.log(`Showing ${shown.chargingStops.features.length} charging stops`);
+     * ```
+     *
+     * @example
+     * Check if any routes are displayed:
+     * ```typescript
+     * const shown = routingModule.getShown();
+     * if (shown.mainLines.features.length > 0) {
+     *   console.log('Routes are displayed');
+     * } else {
+     *   console.log('No routes displayed');
+     * }
+     * ```
+     */
+    getShown(): {
+        mainLines: Routes_2<DisplayRouteProps>;
+        waypoints: Waypoints_2<WaypointDisplayProps>;
+        incidents: RouteSections<DisplayTrafficSectionProps>;
+        ferries: RouteSections;
+        chargingStops: Waypoints_2;
+        tollRoads: RouteSections;
+        tunnels: RouteSections;
+        vehicleRestricted: RouteSections;
+        instructionLines: DisplayInstructions;
+        instructionArrows: DisplayInstructionArrows;
+        summaryBubbles: DisplayRouteSummaries;
+    };
     /**
      * Create the events on/off for this module
      * @returns An instance of EventsModule
@@ -6568,6 +6669,21 @@ export declare type RoutingModuleConfig = MapModuleCommonConfig & {
      * Controls how charging stops source data and/or layer configs are processed to rendering them the map.
      */
     chargingStops?: ChargingStopsConfig;
+    /**
+     * Configuration for the route summary bubbles displayed on the map.
+     *
+     * @remarks
+     * Summary bubbles show key route information (distance, duration, traffic delay)
+     * as visual overlays positioned along the route.
+     */
+    summaryBubbles?: {
+        /**
+         * Controls the visibility of route summary bubbles on the map.
+         *
+         * @defaultValue true
+         */
+        visible?: boolean;
+    };
     /**
      * Custom layer styling configuration.
      *
@@ -8171,6 +8287,45 @@ export declare class TrafficFlowModule extends AbstractMapModule<TrafficFlowSour
      * Returns if any layer for traffic flow is visible or not.
      */
     isVisible(): boolean;
+    /**
+     * Returns features currently visible in the viewport.
+     *
+     * @returns An object containing visible traffic flow features.
+     *
+     * @remarks
+     * Returns all traffic flow features currently rendered in the visible map area.
+     * These represent road segments with real-time traffic speed information.
+     *
+     * **Feature Properties:**
+     * Properties depend on the traffic flow vector tile schema and may include:
+     * - Current speed
+     * - Free flow speed
+     * - Road category
+     * - Congestion level
+     * - Road closure status
+     *
+     * @example
+     * ```typescript
+     * const shown = trafficFlow.getShown();
+     * console.log(`Visible flow segments: ${shown.trafficFlow.length}`);
+     * shown.trafficFlow.forEach(segment => {
+     *   console.log('Road segment:', segment.properties);
+     * });
+     * ```
+     *
+     * @example
+     * Analyze congestion in viewport:
+     * ```typescript
+     * const shown = trafficFlow.getShown();
+     * const congested = shown.trafficFlow.filter(
+     *   segment => segment.properties.speed < segment.properties.freeFlowSpeed * 0.5
+     * );
+     * console.log(`Congested segments: ${congested.length}`);
+     * ```
+     */
+    getShown(): {
+        trafficFlow: MapGeoJSONFeature[];
+    };
     /**
      * Create the events on/off for this module
      * @returns An instance of EventsModule
@@ -8583,6 +8738,45 @@ export declare class TrafficIncidentsModule extends AbstractMapModule<TrafficInc
      * ```
      */
     anyIconLayersVisible(): boolean;
+    /**
+     * Returns features currently visible in the viewport.
+     *
+     * @returns An object containing visible traffic incident features.
+     *
+     * @remarks
+     * Returns all incident features currently rendered in the visible map area,
+     * including both incident areas/lines and icon markers.
+     *
+     * **Feature Properties:**
+     * Properties depend on the traffic incidents vector tile schema and may include:
+     * - Incident type/category
+     * - Severity/magnitude
+     * - Delay information
+     * - Road affected
+     * - Description
+     *
+     * @example
+     * ```typescript
+     * const shown = incidents.getShown();
+     * console.log(`Visible incidents: ${shown.trafficIncidents.length}`);
+     * shown.trafficIncidents.forEach(incident => {
+     *   console.log('Incident:', incident.properties);
+     * });
+     * ```
+     *
+     * @example
+     * Filter and analyze visible incidents:
+     * ```typescript
+     * const shown = incidents.getShown();
+     * const accidents = shown.trafficIncidents.filter(
+     *   incident => incident.properties.category === 'accident'
+     * );
+     * console.log(`Accidents in view: ${accidents.length}`);
+     * ```
+     */
+    getShown(): {
+        trafficIncidents: MapGeoJSONFeature[];
+    };
     /**
      * Create the events on/off for this module
      * @returns An instance of EventsModule