becomap 1.6.93 → 1.6.95

package/lib/index.d.ts

@@ -654,6 +654,52 @@ export interface BCRouteController {
 	 * It relies on the routeController to manage route layers or data.
 	 */
 	clearAllRoutes(): void;
+	/**
+	 * Animates a marker along the drawn route.
+	 *
+	 * This method creates a marker that smoothly moves along the route path,
+	 * following the coordinates of all route segments. The animation automatically
+	 * switches to the start location's floor, handles floor changes during the route,
+	 * and provides a visual representation of navigation. The map camera can optionally
+	 * follow the marker for an immersive experience.
+	 *
+	 * @param options - Optional configuration for the animation
+	 * @param options.duration - Total duration of the animation in milliseconds (default: 5000)
+	 * @param options.markerSize - Size of the marker icon in pixels (default: 32)
+	 * @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.onComplete - Callback function called when animation completes
+	 * @param options.onFloorChange - Callback function called when marker changes floor
+	 *
+	 * @example
+	 * // Animate with default settings (camera follows marker)
+	 * routeController.animateMarkerAlongRoute();
+	 *
+	 * @example
+	 * // Animate with custom settings and camera following
+	 * routeController.animateMarkerAlongRoute({
+	 *   duration: 10000,
+	 *   markerSize: 40,
+	 *   followCamera: true,
+	 *   cameraZoom: 19,
+	 *   onComplete: () => console.log('Animation finished!'),
+	 *   onFloorChange: (floor) => console.log('Changed to floor:', floor.name)
+	 * });
+	 */
+	animateMarkerAlongRoute(options?: {
+		duration?: number;
+		markerSize?: number;
+		followCamera?: boolean;
+		cameraZoom?: number;
+		showFloorChangeNotification?: boolean;
+		onComplete?: () => void;
+		onFloorChange?: (floor: BCMapFloor) => void;
+	}): void;
+	/**
+	 * Stops the ongoing marker animation.
+	 */
+	stopMarkerAnimation(): void;
 }
 export type BCRoutable = BCLocation;
 export interface BCRouteOptions {

package/package.json

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