becomap 1.6.96 → 1.6.98

package/lib/index.d.ts

@@ -599,8 +599,9 @@ export interface BCRouteController {
 	 *
 	 * @param segments - A single BCRouteSegment or an array of BCRouteSegment objects to display on the map.
 	 * @param onFLoor - BCMapFloor object that defines which floor route should show. if null shows starting floor.
+	 * @param useAnimatedArrows - If true, shows animated arrows; if false, shows static arrows (default: true)
 	 */
-	showRoute(segments: BCRouteSegment | BCRouteSegment[], onFLoor: BCMapFloor | null): void;
+	showRoute(segments: BCRouteSegment | BCRouteSegment[], onFLoor: BCMapFloor | null, useAnimatedArrows?: boolean): void;
 	/**
 	 * Initiates a walkthrough of the given route segment, animating through each step of the route.
 	 *
@@ -669,6 +670,7 @@ export interface BCRouteController {
 	 * @param options.followCamera - Whether the map camera should follow the marker (default: true)
 	 * @param options.cameraZoom - Optional zoom level for the camera when following (default: current zoom)
 	 * @param options.showFloorChangeNotification - Whether to show visual notification on floor change (default: true)
+	 * @param options.customFloorNotification - Custom function to render floor change notification (receives floor and returns HTMLElement)
 	 * @param options.onComplete - Callback function called when animation completes
 	 * @param options.onFloorChange - Callback function called when marker changes floor
 	 *
@@ -686,6 +688,17 @@ export interface BCRouteController {
 	 *   onComplete: () => console.log('Animation finished!'),
 	 *   onFloorChange: (floor) => console.log('Changed to floor:', floor.name)
 	 * });
+	 *
+	 * @example
+	 * // Animate with custom floor notification
+	 * routeController.animateMarkerAlongRoute({
+	 *   customFloorNotification: (floor) => {
+	 *     const div = document.createElement('div');
+	 *     div.innerHTML = `<h1>Going to ${floor.name}</h1>`;
+	 *     div.style.cssText = 'position: fixed; top: 20px; right: 20px; background: blue; color: white; padding: 20px;';
+	 *     return div;
+	 *   }
+	 * });
 	 */
 	animateMarkerAlongRoute(options?: {
 		duration?: number;
@@ -693,6 +706,7 @@ export interface BCRouteController {
 		followCamera?: boolean;
 		cameraZoom?: number;
 		showFloorChangeNotification?: boolean;
+		customFloorNotification?: (floor: BCMapFloor) => HTMLElement;
 		onComplete?: () => void;
 		onFloorChange?: (floor: BCMapFloor) => void;
 	}): void;
@@ -700,6 +714,26 @@ export interface BCRouteController {
 	 * Stops the ongoing marker animation.
 	 */
 	stopMarkerAnimation(): void;
+	/**
+	 * Animates arrows moving along the route path using GeoJSON source.
+	 * Creates multiple arrow symbols that physically move along the route line.
+	 *
+	 * @param options - Optional configuration for the arrow animation
+	 * @param options.duration - Duration for arrows to complete the full route in milliseconds (default: 3000)
+	 * @param options.arrowCount - Number of arrows moving along the route (if not provided, calculated dynamically based on distance)
+	 * @param options.arrowSpacing - Distance between arrows in meters (default: 30m, used when arrowCount is not provided)
+	 * @param options.floorId - Optional floor ID to filter arrows to specific floor only
+	 */
+	startArrowAnimation(options?: {
+		duration?: number;
+		arrowCount?: number;
+		arrowSpacing?: number;
+		floorId?: string;
+	}): void;
+	/**
+	 * Stops the arrow animation and removes the animated arrows.
+	 */
+	stopArrowAnimation(): void;
 }
 export type BCRoutable = BCLocation;
 export interface BCRouteOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "becomap",
-  "version": "1.6.96",
+  "version": "1.6.98",
   "description": "we lib to display becomap",
   "main": "lib/becomap.js",
   "module": "lib/becomap.js",