@mappedin/mappedin-js 5.36.0 → 5.37.0

package/lib/esm/renderer/index.d.ts

@@ -3440,7 +3440,7 @@ declare module '@mappedin/mappedin-js/renderer/public/api/Paths' {
 declare module '@mappedin/mappedin-js/renderer/public/api/StackedMaps' {
     import { MappedinMap } from '@mappedin/mappedin-js/get-venue';
     import { TStackedMapsOptions } from '@mappedin/mappedin-js/renderer/MapView.types';
-    import { STACKED_MAPS_STATE, StackedMapsController, TCameraTransform } from '@mappedin/mappedin-js/renderer/internal';
+    import { STACKED_MAPS_STATE, StackedMapsController, TCameraTransform, TCameraAnimationOptions } from '@mappedin/mappedin-js/renderer/internal';
     /**
         * @experimental
         * API for showing multiple maps involved in a {@link Journey} as a vertical stack.
@@ -3504,7 +3504,7 @@ declare module '@mappedin/mappedin-js/renderer/public/api/StackedMaps' {
                 *
                 * @returns Promise when all animations are complete.
                 */
-            showOverview: () => Promise<void>;
+            showOverview: (animationOptions?: TCameraAnimationOptions) => Promise<void>;
             /**
                 * @experimental
                 *
@@ -3512,7 +3512,7 @@ declare module '@mappedin/mappedin-js/renderer/public/api/StackedMaps' {
                 *
                 * @example
                 * ```ts
-                * // Zoom into a clicked map if Stacked Maps is in Overview state
+                * // Scroll the camera to a specific map if Stacked Maps is in Overview state
                 * mapView.on(E_SDK_EVENT.CLICK, ({ maps }) => {
                 * 	if (maps.length <= 0) return;
                 * 	if (mapView.StackedMaps.state === STACKED_MAPS_STATE.OVERVIEW) {
@@ -3523,7 +3523,7 @@ declare module '@mappedin/mappedin-js/renderer/public/api/StackedMaps' {
                 *
                 * @returns Promise when all animations are complete.
                 */
-            scrollToMap: (map: MappedinMap) => Promise<void>;
+            scrollToMap: (map: MappedinMap, duration?: number) => Promise<void>;
             /**
                 * @experimental
                 *
@@ -3542,7 +3542,7 @@ declare module '@mappedin/mappedin-js/renderer/public/api/StackedMaps' {
                 *
                 * @returns Promise when all animations are complete.
                 */
-            zoomInToMap: (map: MappedinMap, cameraTransform?: TCameraTransform) => Promise<void>;
+            zoomInToMap: (map: MappedinMap, cameraOptions?: TCameraTransform & TCameraAnimationOptions) => Promise<void>;
             /**
                 * @experimental
                 *
@@ -8963,7 +8963,7 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/BillboardMana
 declare module '@mappedin/mappedin-js/renderer/private/controllers/StackedMapsController' {
     import { MappedinDirections, MappedinMap, MappedinNode } from '@mappedin/mappedin-js/get-venue';
     import { STACKED_MAPS_STATE, MapViewScene, MapViewStackScene, CAMERA_EASING_MODE } from '@mappedin/mappedin-js/renderer/internal';
-    import type { ICore, TCameraTransform } from '@mappedin/mappedin-js/renderer/internal';
+    import type { ICore, TCameraTransform, TCameraAnimationOptions } from '@mappedin/mappedin-js/renderer/internal';
     import { TStackedMapsOptions } from '@mappedin/mappedin-js/renderer/MapView.types';
     enum ACTION {
         enable = "enable",
@@ -8982,18 +8982,24 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/StackedMapsCo
         stackScene: MapViewStackScene;
         directions: MappedinDirections | MappedinDirections[];
         verticalDistanceBetweenMaps?: number;
+        animationOptions?: TCameraAnimationOptions;
     } | {
         stackScene: MapViewStackScene;
         verticalDistanceBetweenMaps?: number;
         map: MappedinMap;
         nodes: MappedinNode[];
+        cameraOptions?: TCameraTransform & TCameraAnimationOptions;
+        duration?: number;
+        animationOptions?: TCameraAnimationOptions;
     } | {
         stackScene: MapViewStackScene;
         map: MappedinMap;
         nodes: MappedinNode[];
         rotation: number;
-        cameraTransform?: TCameraTransform;
+        cameraOptions?: TCameraTransform & TCameraAnimationOptions;
         verticalDistanceBetweenMaps?: number;
+        duration?: number;
+        animationOptions?: TCameraAnimationOptions;
     };
     type TActionFn = [STACKED_MAPS_STATE, TTargetTransitionFunction[]];
     type TState = {
@@ -9026,6 +9032,7 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/StackedMapsCo
                     tilt: number;
                     rotation: number;
                     position?: MappedinNode | import("../../internal").MappedinCoordinate | undefined;
+                    duration?: number | undefined;
                     easing: CAMERA_EASING_MODE;
                 };
             };
@@ -9037,8 +9044,9 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/StackedMapsCo
             activeMap: MappedinMap;
             focusOn: {
                 options: {
-                    tilt: number;
                     duration: number;
+                    easing?: CAMERA_EASING_MODE | undefined;
+                    tilt: number;
                 };
             };
             verticalDistanceBetweenMaps: number | undefined;
@@ -9054,6 +9062,7 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/StackedMapsCo
                 };
             };
             activeMap: MappedinMap;
+            duration: number | undefined;
         })[] | undefined;
         getRestackOptions: (params: TParams) => (MapViewStackScene | {
             activeMap: MappedinMap;
@@ -9079,10 +9088,10 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/StackedMapsCo
         disable: () => Promise<void>;
         enable: (opts?: TStackedMapsOptions) => Promise<void>;
         get nodesInJourneyOrMap(): any[];
-        showOverview: () => Promise<void>;
-        scrollToMap: (map: MappedinMap) => Promise<void>;
+        showOverview: (animationOptions?: TCameraAnimationOptions) => Promise<void>;
+        scrollToMap: (map: MappedinMap, duration?: number) => Promise<void>;
         restack: (options?: TStackedMapsOptions) => Promise<void>;
-        zoomInToMap: (map: MappedinMap, cameraTransform?: TCameraTransform) => Promise<void>;
+        zoomInToMap: (map: MappedinMap, cameraOptions?: TCameraTransform & TCameraAnimationOptions) => Promise<void>;
         get currentMap(): MappedinMap;
     }
     export default StackedMapsController;