@mappedin/mappedin-js 6.0.1-alpha.18 → 6.0.1-alpha.19

package/lib/esm/index.d.ts

@@ -1051,10 +1051,16 @@ declare module '@mappedin/mappedin-js/maker/src/map-view-geojson' {
             updateState<T extends Space | MapObject | Label>(target: T, state: TUpdateState<T>): void;
             setHoverColor(c: string): void;
             getHoverColor(): string | undefined;
-            getState(target: Space | Label | MapObject): import("@mappedin/core-sdk").MeshState | {
+            getState(target: Space | Label | MapObject): {
                     appearance: import("../../geojson/src/components/label").LabelAppearance | undefined;
-                    interactive: boolean;
+                    interactive: boolean | undefined;
                     opacity: number;
+                    color?: undefined;
+            } | {
+                    interactive: boolean | undefined;
+                    color: string;
+                    opacity: number;
+                    appearance?: undefined;
             } | undefined;
             /**
                 * Retrieves the current floor of the map.
@@ -1732,11 +1738,27 @@ declare module '@mappedin/mappedin-js/maker/src/map-view-interface' {
                 */
             accessible?: boolean;
             /**
-                * Enable or disable path smoothing.
+                * Enable or disable line-of-sight directions smoothing.
+                * With this option enabled, the directions will be simplified to provide a more visually appealing path and shorter instructions.
+                *
+                * Can be a boolean to enable or disable smoothing, or an object with a radius property to specify the line of sight radius in metres.
                 *
                 * @default true
+                *
+                * @example
+                * ```ts
+                * // Enable smoothing with a radius of 3 metres
+                * mapView.getDirections(firstSpace, secondSpace, {
+                * 	smoothing: {
+                * 		radius: 3,
+                * 	}
+                * })
+                * ```
                 */
-            smoothing?: boolean;
+            smoothing?: boolean | {
+                    enabled?: boolean;
+                    radius: number;
+            };
     };
     /**
         * Options for controlling the behavior of a {@link Marker}.
@@ -6798,6 +6820,23 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/MapView.types' {
     export type { TOutdoorViewOptions, TOutdoorViewOptionsWithHeaders, TOutdoorViewOptionsWithAuthURL };
     export type { default as BlueDotController } from '@mappedin/mappedin-js/packages/legacy-renderer/private/controllers/BlueDotController';
     export type { default as Journey } from '@mappedin/mappedin-js/packages/legacy-renderer/public/api/Journey';
+    export type TStackedMapsOptions = {
+            /**
+                * The vertical distance between maps in overview, in metres.
+                * @default 50
+                */
+            verticalDistanceBetweenMaps?: number;
+            /**
+                * Whether to show map level labels in overview.
+                * @default true
+                */
+            mapLabels?: boolean;
+            /**
+                * Whether to show only Journey maps in the stack if a Journey is active and the current map is part of the Journey.
+                * @default true
+                */
+            prioritizeJourneyMaps?: boolean;
+    };
 }
 
 declare module '@mappedin/mappedin-js/packages/legacy-renderer/internal/json-scene-loader' {
@@ -9534,142 +9573,126 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/private/controlle
     import { MappedinDirections, MappedinMap, MappedinNode } from '@mappedin/mappedin-js/packages/get-venue';
     import { STACKED_MAPS_STATE, MapViewScene, MapViewStackScene, CAMERA_EASING_MODE } from '@mappedin/mappedin-js/packages/legacy-renderer/internal';
     import type { ICore, TCameraTransform } from '@mappedin/mappedin-js/packages/legacy-renderer/internal';
+    import { TStackedMapsOptions } from '@mappedin/mappedin-js/packages/legacy-renderer/MapView.types';
     enum ACTION {
-            enable = "enable",
-            disable = "disable",
-            showOverview = "showOverview",
-            zoomInToMap = "zoomInToMap",
-            scrollToMap = "scrollToMap",
-            restack = "restack"
+        enable = "enable",
+        disable = "disable",
+        showOverview = "showOverview",
+        zoomInToMap = "zoomInToMap",
+        scrollToMap = "scrollToMap",
+        restack = "restack"
     }
     type TTargetTransitionFunction = ((options: TParams) => () => Promise<void>) | ((options: TParams) => void);
     type TParams = {
-            map: MappedinMap;
+        map: MappedinMap;
     } | {
-            directions: MappedinDirections | MappedinDirections[];
+        directions: MappedinDirections | MappedinDirections[];
     } | {
-            stackScene: MapViewStackScene;
-            directions: MappedinDirections | MappedinDirections[];
-            verticalDistanceBetweenMaps?: number;
+        stackScene: MapViewStackScene;
+        directions: MappedinDirections | MappedinDirections[];
+        verticalDistanceBetweenMaps?: number;
     } | {
-            stackScene: MapViewStackScene;
-            verticalDistanceBetweenMaps?: number;
-            map: MappedinMap;
-            nodes: MappedinNode[];
+        stackScene: MapViewStackScene;
+        verticalDistanceBetweenMaps?: number;
+        map: MappedinMap;
+        nodes: MappedinNode[];
     } | {
-            stackScene: MapViewStackScene;
-            map: MappedinMap;
-            nodes: MappedinNode[];
-            rotation: number;
-            cameraTransform?: TCameraTransform;
-            verticalDistanceBetweenMaps?: number;
+        stackScene: MapViewStackScene;
+        map: MappedinMap;
+        nodes: MappedinNode[];
+        rotation: number;
+        cameraTransform?: TCameraTransform;
+        verticalDistanceBetweenMaps?: number;
     };
     type TActionFn = [STACKED_MAPS_STATE, TTargetTransitionFunction[]];
     type TState = {
-            [stateName in STACKED_MAPS_STATE]?: {
-                    actions: {
-                            [actionName in ACTION]?: TActionFn;
-                    };
+        [stateName in STACKED_MAPS_STATE]?: {
+            actions: {
+                [actionName in ACTION]?: TActionFn;
             };
+        };
     };
     export type TInternalTransitionOptions = {
-            animate?: boolean;
-    };
-    export type TStackedMapsOptions = {
-            /**
-                * The vertical distance between maps in overview, in metres.
-                * @default 50
-                */
-            verticalDistanceBetweenMaps?: number;
-            /**
-                * Whether to show map level labels in overview.
-                * @default true
-                */
-            mapLabels?: boolean;
-            /**
-                * Whether to show only Journey maps in the stack if a Journey is active and the current map is part of the Journey.
-                * @default true
-                */
-            prioritizeJourneyMaps?: boolean;
+        animate?: boolean;
     };
     class StackedMapsController {
-            #private;
-            options: TStackedMapsOptions;
-            enabled: boolean;
-            stackScene: MapViewStackScene;
-            constructor(core: ICore);
-            needsUpdate: boolean;
-            currentState: STACKED_MAPS_STATE;
-            mapsInStack: MappedinMap[];
-            getZoomIntoMapOptions: (params: TParams) => (MapViewScene | {
-                    activeMap: MappedinMap;
-                    focusOn: {
-                            targets: {
-                                    nodes: MappedinNode[];
-                            };
-                            options: {
-                                    zoom?: number | undefined;
-                                    tilt: number;
-                                    rotation: number;
-                                    position?: MappedinNode | import("../../internal").MappedinCoordinate | undefined;
-                                    easing: CAMERA_EASING_MODE;
-                            };
-                    };
-            })[] | undefined;
-            getDisableOptions: (params: TParams) => (MapViewScene | {
-                    activeMap: MappedinMap;
-            })[] | undefined;
-            getShowOverviewOptions: (params: TParams) => (MapViewStackScene | {
-                    activeMap: MappedinMap;
-                    focusOn: {
-                            options: {
-                                    tilt: number;
-                                    duration: number;
-                            };
-                    };
-                    verticalDistanceBetweenMaps: number | undefined;
-            })[] | undefined;
-            getScrollToMapOptions: (params: TParams) => (MapViewStackScene | {
-                    focusOn: {
-                            targets: {
-                                    nodes: MappedinNode[];
-                            };
-                            options: {
-                                    tilt: number;
-                                    easing: CAMERA_EASING_MODE;
-                            };
-                    };
-                    activeMap: MappedinMap;
-            })[] | undefined;
-            getRestackOptions: (params: TParams) => (MapViewStackScene | {
-                    activeMap: MappedinMap;
-                    focusOn: {
-                            options: {
-                                    tilt: number;
-                                    duration: number;
-                            };
-                    };
-                    verticalDistanceBetweenMaps: number | undefined;
-            })[] | undefined;
-            getEnableOptions: () => void;
-            getShowOverviewTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
-            getZoomInToMapTransition: (options: any) => () => Promise<void>;
-            getScrollToMapTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
-            getRestackTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
-            getDisableTransition: (options: any) => () => Promise<void>;
-            getEnableTransition: () => () => void;
-            states: TState;
-            get determineMapStack(): MappedinMap[];
-            transition(currentState: STACKED_MAPS_STATE, actionName: ACTION): TTargetTransitionFunction[] | void;
-            exec(transitions: TTargetTransitionFunction[] | void, params: TParams): Promise<void>;
-            disable: () => Promise<void>;
-            enable: (opts?: TStackedMapsOptions) => Promise<void>;
-            get nodesInJourneyOrMap(): any[];
-            showOverview: () => Promise<void>;
-            scrollToMap: (map: MappedinMap) => Promise<void>;
-            restack: (options?: TStackedMapsOptions) => Promise<void>;
-            zoomInToMap: (map: MappedinMap, cameraTransform?: TCameraTransform) => Promise<void>;
-            get currentMap(): MappedinMap;
+        #private;
+        options: TStackedMapsOptions;
+        enabled: boolean;
+        stackScene: MapViewStackScene;
+        constructor(core: ICore);
+        needsUpdate: boolean;
+        currentState: STACKED_MAPS_STATE;
+        mapsInStack: MappedinMap[];
+        getZoomIntoMapOptions: (params: TParams) => (MapViewScene | {
+            activeMap: MappedinMap;
+            focusOn: {
+                targets: {
+                    nodes: MappedinNode[];
+                };
+                options: {
+                    zoom?: number | undefined;
+                    tilt: number;
+                    rotation: number;
+                    position?: MappedinNode | import("../../internal").MappedinCoordinate | undefined;
+                    easing: CAMERA_EASING_MODE;
+                };
+            };
+        })[] | undefined;
+        getDisableOptions: (params: TParams) => (MapViewScene | {
+            activeMap: MappedinMap;
+        })[] | undefined;
+        getShowOverviewOptions: (params: TParams) => (MapViewStackScene | {
+            activeMap: MappedinMap;
+            focusOn: {
+                options: {
+                    tilt: number;
+                    duration: number;
+                };
+            };
+            verticalDistanceBetweenMaps: number | undefined;
+        })[] | undefined;
+        getScrollToMapOptions: (params: TParams) => (MapViewStackScene | {
+            focusOn: {
+                targets: {
+                    nodes: MappedinNode[];
+                };
+                options: {
+                    tilt: number;
+                    easing: CAMERA_EASING_MODE;
+                };
+            };
+            activeMap: MappedinMap;
+        })[] | undefined;
+        getRestackOptions: (params: TParams) => (MapViewStackScene | {
+            activeMap: MappedinMap;
+            focusOn: {
+                options: {
+                    tilt: number;
+                    duration: number;
+                };
+            };
+            verticalDistanceBetweenMaps: number | undefined;
+        })[] | undefined;
+        getEnableOptions: () => void;
+        getShowOverviewTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
+        getZoomInToMapTransition: (options: any) => () => Promise<void>;
+        getScrollToMapTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
+        getRestackTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
+        getDisableTransition: (options: any) => () => Promise<void>;
+        getEnableTransition: () => () => void;
+        states: TState;
+        get determineMapStack(): MappedinMap[];
+        transition(currentState: STACKED_MAPS_STATE, actionName: ACTION): TTargetTransitionFunction[] | void;
+        exec(transitions: TTargetTransitionFunction[] | void, params: TParams): Promise<void>;
+        disable: () => Promise<void>;
+        enable: (opts?: TStackedMapsOptions) => Promise<void>;
+        get nodesInJourneyOrMap(): any[];
+        showOverview: () => Promise<void>;
+        scrollToMap: (map: MappedinMap) => Promise<void>;
+        restack: (options?: TStackedMapsOptions) => Promise<void>;
+        zoomInToMap: (map: MappedinMap, cameraTransform?: TCameraTransform) => Promise<void>;
+        get currentMap(): MappedinMap;
     }
     export default StackedMapsController;
 }
@@ -14300,8 +14323,8 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/public/api/Camera
 
 declare module '@mappedin/mappedin-js/packages/legacy-renderer/public/api/StackedMaps' {
     import { MappedinMap } from '@mappedin/mappedin-js/packages/get-venue';
+    import { TStackedMapsOptions } from '@mappedin/mappedin-js/packages/legacy-renderer/MapView.types';
     import { STACKED_MAPS_STATE, StackedMapsController, TCameraTransform } from '@mappedin/mappedin-js/packages/legacy-renderer/internal';
-    import { TStackedMapsOptions } from '@mappedin/mappedin-js/packages/legacy-renderer/private/controllers/StackedMapsController';
     /**
         * @experimental
         * API for showing multiple maps involved in a {@link Journey} as a vertical stack.
@@ -14314,7 +14337,8 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/public/api/Stacke
             constructor(markersController: StackedMapsController);
             /**
                 * @experimental
-                * Enable Stacked Maps. A {@link Journey} must be drawn beforehand or this method will fail.
+                * Enable Stacked Maps. If a {@link Journey} is drawn beforehand the default behaviour is to only display the floors that are part of the journey.
+                * {@link TStackedMapsOptions} can be used to enabling display of all maps including those that are not part of the journey.
                 * Use {@link showOverview} to expand the maps vertically after enabling.
                 *
                 * Upon enabling, map state will become {@link STATE.STACKED | STACKED} and Stacked Maps state will become {@link STACKED_MAPS_STATE.ACTIVE | ACTIVE}.
@@ -14352,7 +14376,7 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/public/api/Stacke
             /**
                 * @experimental
                 *
-                * Expand the maps in the current {@link Journey} vertically and add vertical paths between connections.
+                * Expand and display all maps in the current {@link MapGroup}. If a {@link Journey} has been drawn, vertical paths between connections are displayed.
                 * Stacked Maps must be enabled beforehand and state will become {@link STACKED_MAPS_STATE.OVERVIEW | OVERVIEW}.
                 *
                 * @example
@@ -14407,7 +14431,8 @@ declare module '@mappedin/mappedin-js/packages/legacy-renderer/public/api/Stacke
                 * @experimental
                 *
                 * Used when in {@link STACKED_MAPS_STATE.OVERVIEW | OVERVIEW} state to replace the maps in the
-                * current stack if there is a new Journey or Journey is cleared.
+                * current stack after clearing or creating a {@link Journey}.
+                * Use this to hide maps that are not part of the journey or to display all maps in the {@link MapGroup}.
                 *
                 * @param options - Options to adjust the overview. Each option defaults to the setting passed in {@link enable}, unless provided.
                 *