@mappedin/mappedin-js 5.6.1 → 5.7.0

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

@@ -12,7 +12,7 @@ declare module '@mappedin/mappedin-js' {
     import type { TMapViewOptions, TJourneyOptions } from '@mappedin/mappedin-js/renderer/MapView.types';
     import { labelThemes } from '@mappedin/mappedin-js/renderer/MapView.types';
     import { MARKER_ANCHOR } from '@mappedin/mappedin-js/renderer/internal/Mappedin.Marker';
-    export type { Marker } from '@mappedin/mappedin-js/renderer/layers/Markers';
+    export type { Marker } from '@mappedin/mappedin-js/renderer/internal/Mappedin.Markers';
     export { BEARING_TYPE, ACTION_TYPE } from '@mappedin/mappedin-js/navigator';
     export type { IDirectionsResult, E_MESSAGES as E_GET_DIRECTIONS_MESSAGES } from '@mappedin/mappedin-js/navigator';
     export type { IFlatLabels, FlatLabels } from '@mappedin/mappedin-js/renderer/MapView.FlatLabels';
@@ -102,13 +102,14 @@ declare module '@mappedin/mappedin-js/renderer/MapView' {
     import { E_SDK_EVENT, STATE } from '@mappedin/mappedin-js/renderer/MapView.enums';
     import SmartTooltip from '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartTooltip';
     import Camera from '@mappedin/mappedin-js/renderer/Camera';
-    import { Marker } from '@mappedin/mappedin-js/renderer/layers/Markers';
+    import { Marker } from '@mappedin/mappedin-js/renderer/internal/Mappedin.Markers';
     import { PubSub } from '@mappedin/mappedin-js/renderer/internal/pub-sub.typed';
     import BlueDotLayer from '@mappedin/mappedin-js/renderer/layers/BlueDot';
     import JourneyLayer from '@mappedin/mappedin-js/renderer/layers/Journey';
     import { TGetPolygonsAtCoordinateOptions } from '@mappedin/mappedin-js/renderer';
     import { IFlatLabels } from '@mappedin/mappedin-js/renderer/MapView.FlatLabels';
     import { IFloatingLabels } from '@mappedin/mappedin-js/renderer/MapView.FloatingLabels';
+    import { MarkersLayer } from '@mappedin/mappedin-js/renderer/layers/Markers';
     export enum INTERNAL_EVENT {
             ON_FIRST_MAP_LOADED = 0,
             TEXTURE_LOADED = 1,
@@ -180,6 +181,7 @@ declare module '@mappedin/mappedin-js/renderer/MapView' {
             Camera: Camera;
             FlatLabels: IFlatLabels<void>;
             FloatingLabels: IFloatingLabels<void>;
+            Markers: MarkersLayer;
             options: TMapViewOptions;
             constructor(container: HTMLElement, venue: Mappedin, options?: TMapViewOptions & {
                     onFirstMapLoaded: () => void;
@@ -280,16 +282,18 @@ declare module '@mappedin/mappedin-js/renderer/MapView' {
                 */
             removeInteractivePolygon(polygonOrPolygonId: MappedinPolygon | string): void;
             /**
-                * Attach any HTML to a {@link MappedinNode}, and have the marker interact and collide with smart labels and tooltips
+                * Attach any HTML to a {@link MappedinNode} or {@link MappedinCoordinate}, and have the marker interact and collide with smart labels and tooltips
+                * @deprecated use `mapView.Markers.add` instead.
                 */
             createMarker(nodeOrCoordinate: MappedinNode | MappedinCoordinate, contentHtml: string, options?: TCreateMarkerOptions): Marker;
             /**
                 * Remove Marker
+                * @deprecated use `mapView.Markers.remove` instead.
                 */
             removeMarker(markerOrMarkerId: Marker | Marker['id']): void;
             /**
                 * Removes all Markers (from all Maps, not just the current one).
-                *
+                * @deprecated use `mapView.Markers.removeAll` instead.
                 */
             removeAllMarkers(): void;
             /**
@@ -347,9 +351,9 @@ declare module '@mappedin/mappedin-js/renderer/MapView' {
                 */
             nodeOrCoordinate: MappedinNode | MappedinCoordinate, contentHtml: string, selector: string, options?: TCreateTooltipCommonOptions): SmartTooltip;
             /**
-                * Removes a {@link Tooltip} you have added previously.
+                * Removes a Tooltip you have added previously.
                 *
-                * @param tooltipOrTooltipId A Tooltip that has previously been returned from {@link MapView.createTooltip}.
+                * @param tooltipOrTooltipId A Tooltip or Tooltip id that has previously been returned from {@link MapView.createTooltip}.
                 */
             removeTooltip(tooltipOrTooltipId: SmartTooltip | SmartTooltip['id']): void;
             /**
@@ -779,7 +783,7 @@ declare module '@mappedin/mappedin-js/renderer/MapView.types' {
     import { TBlueDotPositionUpdate, TBlueDotStateChange } from '@mappedin/mappedin-js/renderer/internal/Mappedin.BlueDot/Mappedin.BlueDot.core';
     import { TOOLTIP_ANCHOR } from '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartTooltip';
     import type { Euler, Object3D, Vector3 } from 'three';
-    import { GEOLOCATION_STATUS, COLLISION_RANKING_TIERS, STATE, MARKER_ANCHOR, E_SDK_EVENT, E_BLUEDOT_EVENT, E_CAMERA_EVENT, MAP_RENDER_MODE } from '@mappedin/mappedin-js/renderer/MapView.enums';
+    import { GEOLOCATION_STATUS, COLLISION_RANKING_TIERS, STATE, MARKER_ANCHOR, E_SDK_EVENT, E_BLUEDOT_EVENT, E_CAMERA_EVENT, MAP_RENDER_MODE, CAMERA_EASING_MODE } from '@mappedin/mappedin-js/renderer/MapView.enums';
     export type { TEnableBlueDotOptions, TFloatingLabelAppearance };
     /**
     An extension of the GeolocationPosition type.
@@ -969,6 +973,16 @@ declare module '@mappedin/mappedin-js/renderer/MapView.types' {
             rank?: COLLISION_RANKING_TIERS | number;
             anchor?: MARKER_ANCHOR;
     };
+    export type TAnimationOptions = {
+            /**
+                * Animation duration in milliseconds
+                */
+            duration?: number;
+            /**
+                * Mode for easing in and out of the animation.
+                */
+            easing?: CAMERA_EASING_MODE;
+    };
     export type TCreateTooltipInternalOptions = {
             nodeOrCoordinate: MappedinNode | MappedinCoordinate;
             html?: string;
@@ -1225,7 +1239,7 @@ declare module '@mappedin/mappedin-js/renderer/MapView.types' {
             text: string;
             scale?: number;
             /**
-                * Ranking tier to determine how likely a {@link FloatingLabel} will appear
+                * Ranking tier to determine how likely a {@link FloatingLabels | Floating Label} will appear
                 */
             rank?: COLLISION_RANKING_TIERS | number;
             /**
@@ -1256,7 +1270,7 @@ declare module '@mappedin/mappedin-js/renderer/MapView.types' {
                 */
             locations?: MappedinLocation[];
             /**
-                * Custom Translation Map for {@link MappedinLocation.MappedinLocationState}
+                * Custom translation map for location states
                 */
             translationMap?: {
                     [key in string]: string;
@@ -1445,9 +1459,9 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.Marker' {
     export default InternalMarker;
 }
 
-declare module '@mappedin/mappedin-js/renderer/layers/Markers' {
+declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.Markers' {
     import { MappedinCoordinate, MappedinNode } from '@mappedin/mappedin-js/get-venue';
-    import { TCreateMarkerOptions } from '@mappedin/mappedin-js/renderer';
+    import { TCreateMarkerOptions, TAnimationOptions } from '@mappedin/mappedin-js/renderer';
     import InternalMarker from '@mappedin/mappedin-js/renderer/internal/Mappedin.Marker';
     import { ICore } from '@mappedin/mappedin-js/renderer/Core.interface';
     /**
@@ -1469,14 +1483,42 @@ declare module '@mappedin/mappedin-js/renderer/layers/Markers' {
                 */
             get contentEl(): any;
     }
-    class MarkersLayer {
+    class MarkersController {
             #private;
             constructor(core: ICore);
-            createMarker(nodeOrCoordinate: MappedinNode | MappedinCoordinate, contentHtml: string, options?: TCreateMarkerOptions): Marker;
-            removeMarker(markerOrMarkerId: Marker | Marker['id']): void;
-            removeAllMarkers(): void;
+            /**
+                * Create a new Marker, containing some HTML, at the specified position
+                * @param nodeOrCoordinate the position for the Marker
+                * @param contentHtml the content to show in the Marker
+                * @param options options for the display of the Marker
+                * @returns the Marker object that was created.
+                */
+            add(nodeOrCoordinate: MappedinNode | MappedinCoordinate, contentHtml: string, options?: TCreateMarkerOptions): Marker;
+            updateMap(internalMarker: InternalMarker, from: string, to: string): void;
+            /**
+                * Moves a Marker to a new position instantaneously.
+                * @param markerOrMarkerId the Marker to move
+                * @param target the new position for this Marker
+                */
+            setPosition(markerOrMarkerId: Marker | Marker['id'], target: MappedinNode | MappedinCoordinate): void;
+            /**
+                * Moves a Marker to a new position over time.
+                * @param markerOrMarkerId the Marker to move
+                * @param target the new position for this Marker
+                * @param options the options for how this movement should be animated
+                */
+            animate(markerOrMarkerId: Marker | Marker['id'], target: MappedinCoordinate | MappedinNode, options?: TAnimationOptions): Promise<void>;
+            /**
+                * Removes a Marker.
+                * @param markerOrMarkerId the Marker to be removed
+                */
+            remove(markerOrMarkerId: Marker | Marker['id']): void;
+            /**
+                * Remove all Markers from all maps.
+                */
+            removeAll(): void;
     }
-    export default MarkersLayer;
+    export default MarkersController;
 }
 
 declare module '@mappedin/mappedin-js/navigator' {
@@ -1516,7 +1558,10 @@ declare module '@mappedin/mappedin-js/renderer/MapView.FlatLabels' {
                 */
             setAppearance(polygon: MappedinPolygon, appearance: TFlatLabelAppearance): T;
             /**
-                * Sets the color for hovering over labels
+                * Sets the hover text color for all Flat Labels.
+                * Expects color in hexadecimal string e.g. `#2e2e2e`
+                *
+                * To set hover color for all polygons, see {@link MapView.setHoverColor}.
                 */
             setHoverColorForAll(color: string): T;
     }
@@ -1905,8 +1950,8 @@ declare module '@mappedin/mappedin-js/renderer/Camera' {
     import { ICore } from '@mappedin/mappedin-js/renderer/Core.interface';
     import { MappedinNode, MappedinPolygon, MappedinCoordinate } from '@mappedin/mappedin-js/get-venue';
     import { PubSub } from '@mappedin/mappedin-js/renderer/internal/pub-sub.typed';
-    import { CAMERA_EVENT_PAYLOAD } from '@mappedin/mappedin-js/renderer/MapView.types';
-    import { E_CAMERA_EVENT, E_CAMERA_DIRECTION, CAMERA_EASING_MODE, SAFE_AREA_INSET_TYPE } from '@mappedin/mappedin-js/renderer/MapView.enums';
+    import { CAMERA_EVENT_PAYLOAD, TAnimationOptions } from '@mappedin/mappedin-js/renderer/MapView.types';
+    import { E_CAMERA_EVENT, E_CAMERA_DIRECTION, SAFE_AREA_INSET_TYPE } from '@mappedin/mappedin-js/renderer/MapView.enums';
     export type TSafeAreaInsets = {
             top: number;
             left: number;
@@ -1941,13 +1986,7 @@ declare module '@mappedin/mappedin-js/renderer/Camera' {
             rotation?: number;
             position?: MappedinCoordinate | MappedinNode;
     };
-    export type TCameraAnimationOptions = {
-            /**
-                * Animation duration in milliseconds
-                */
-            duration?: number;
-            easing?: CAMERA_EASING_MODE;
-    };
+    export type TCameraAnimationOptions = TAnimationOptions;
     /**
         * The Camera object specifies a view of the map and allows manipulation of that view.
         */
@@ -2250,7 +2289,7 @@ declare module '@mappedin/mappedin-js/renderer' {
     import type { TMapViewOptions, TJourneyOptions } from '@mappedin/mappedin-js/renderer/MapView.types';
     import { labelThemes } from '@mappedin/mappedin-js/renderer/MapView.types';
     import { MARKER_ANCHOR } from '@mappedin/mappedin-js/renderer/internal/Mappedin.Marker';
-    export type { Marker } from '@mappedin/mappedin-js/renderer/layers/Markers';
+    export type { Marker } from '@mappedin/mappedin-js/renderer/internal/Mappedin.Markers';
     export { BEARING_TYPE, ACTION_TYPE } from '@mappedin/mappedin-js/navigator';
     export type { IDirectionsResult, E_MESSAGES as E_GET_DIRECTIONS_MESSAGES } from '@mappedin/mappedin-js/navigator';
     export type { IFlatLabels, FlatLabels } from '@mappedin/mappedin-js/renderer/MapView.FlatLabels';
@@ -2332,6 +2371,47 @@ declare module '@mappedin/mappedin-js/renderer' {
     IOutdoorContextProvider } from './layers/Outdoor-Context/Outdoor-Context.provider';
 }
 
+declare module '@mappedin/mappedin-js/renderer/layers/Markers' {
+    import { TAnimationOptions } from '@mappedin/mappedin-js/renderer';
+    import { MappedinCoordinate, MappedinNode } from '@mappedin/mappedin-js/get-venue';
+    import { TCreateMarkerOptions } from '@mappedin/mappedin-js/renderer/index.rn';
+    import MarkersController, { Marker } from '@mappedin/mappedin-js/renderer/internal/Mappedin.Markers';
+    export class MarkersLayer {
+            #private;
+            constructor(markersController: MarkersController);
+            /**
+                * Create a new Marker, containing some HTML, at the specified position
+                * @param nodeOrCoordinate the position for the Marker
+                * @param contentHtml the content to show in the Marker
+                * @param options options for the display of the Marker
+                * @returns the Marker object that was created.
+                */
+            add(nodeOrCoordinate: MappedinNode | MappedinCoordinate, contentHtml: string, options?: TCreateMarkerOptions): Marker;
+            /**
+                * Moves a Marker to a new position instantaneously.
+                * @param markerOrMarkerId the Marker to move
+                * @param target the new position for this Marker
+                */
+            setPosition(markerOrMarkerId: Marker | Marker['id'], target: MappedinNode | MappedinCoordinate): void;
+            /**
+                * Moves a Marker to a new position over time.
+                * @param markerOrMarkerId the Marker to move
+                * @param target the new position for this Marker
+                * @param options the options for how this movement should be animated
+                */
+            animate(markerOrMarkerId: Marker | Marker['id'], target: MappedinCoordinate | MappedinNode, options?: TAnimationOptions): Promise<void>;
+            /**
+                * Removes a Marker.
+                * @param markerOrMarkerId the Marker to be removed
+                */
+            remove(markerOrMarkerId: Marker | Marker['id']): void;
+            /**
+                * Remove all Markers from all maps.
+                */
+            removeAll(): void;
+    }
+}
+
 declare module '@mappedin/mappedin-js/get-venue/Mappedin.types' {
     export type TGetVenueOptions = {
             accessToken?: string;
@@ -2629,7 +2709,7 @@ declare module '@mappedin/mappedin-js/get-venue/Mappedin' {
             hydrateFromMVF(mvfData: MVFData): Promise<undefined>;
             /**
                 *
-                * [experimental] Hydrate the Mappedin instance using a response from either {@link IMappedin.toString()}, {@link getVenueBundle} or by downloading the bundle manually
+                * @experimental Hydrate the Mappedin instance using a response from either {@link Mappedin.toString}, {@link getVenueBundle} or by downloading the bundle manually
                 * @param mappedinSerializableData Mappedin data that was serialized or exported as JSON
                 * @param shouldPopulateBundledImagesAsBlobs Takes the scenes and images from a bundle and maps them as blobs to where they exist as URLs in the bundle. False by default
                 */
@@ -3562,10 +3642,10 @@ declare module '@mappedin/mappedin-js/get-venue/Mappedin.OfflineSearch' {
     export const removeAccents: (it: string) => string;
     export type { SearchOptions };
     /**
-        * A {@link Mappedin.OfflineSearch} is an offline search module
+        * A {@link OfflineSearch} is an offline search module
         *
         *
-        * @class Mappedin.OfflineSearch
+        * @class OfflineSearch
         */
     export type TMappedinOfflineSearchAllOptions = {
             /**
@@ -4725,6 +4805,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollider'
         };
         flipIfNeeded(): void;
         constructor(options: any);
+        setPosition(position: MappedinNode | MappedinCoordinate): void;
         setPriority(rank: any): void;
         setAction(action: any): void;
         resetPriority(): void;
@@ -6342,6 +6423,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollisionE
         reposition: () => void;
         add: (colliderId: string, collider: ICollider) => void;
         remove: (colliderId: string) => void;
+        updateMap: (colliderId: string, from: string, to: string) => void;
         update: () => void;
         resize: (container: any) => void;
         destroy: () => void;