@mappedin/mappedin-js 5.34.3 → 5.36.0

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

@@ -1044,7 +1044,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.BlueDot/Mappedi
             map: MappedinMap | null;
             bearing: any;
             nearestNode: any;
-            forceBlueDot: boolean;
+            hasEverReceivedFloorLevel: boolean;
     };
     export interface IBlueDotCore extends IPubSub {
             positionUpdater: IPositionUpdater | null;
@@ -1060,6 +1060,8 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.BlueDot/Mappedi
             Whether blue dot should be allowed with missing floor level information.
              */
             forceBlueDot: boolean;
+            /** Whether we have received floorLevel data and are on a floorLevel supported device */
+            hasEverReceivedFloorLevel: boolean;
             /**
             The state machine for the current state of the blue dot.
              */
@@ -4169,21 +4171,64 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/WatermarkCont
     import { Sprite } from 'three';
     type TPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center' | 'top' | 'bottom' | 'left' | 'right';
     export type TShowWatermarkOptions = {
-        padding?: number;
-        position?: TPosition;
-        iconOnly?: boolean;
-        scale?: number;
-        onClick?: () => void;
+            /**
+                * Padding in pixels. Can be a number or an object with top, right, bottom, and left properties.
+                * @default 16
+                * @example
+                * ```ts
+                * // Watermark with 20 pixels of padding on all sides
+                * __showWatermark({
+                * 	padding: 20,
+                * });
+                * ```
+                * @example
+                * ```ts
+                * // Watermark with unique top, right, bottom, left padding
+                * __showWatermark({
+                * 	padding: {
+                * 		top: 10,
+                * 		right: 20,
+                * 		bottom: 30,
+                * 		left: 40,
+                * 	},
+                * });
+                * ```
+                */
+            padding?: number | {
+                    top?: number;
+                    right?: number;
+                    bottom?: number;
+                    left?: number;
+            };
+            /**
+                * Position of the watermark on the screen.
+                * @default 'bottom-left'
+                */
+            position?: TPosition;
+            /**
+                * Show only the Mappedin icon without text.
+                * @default false
+                */
+            iconOnly?: boolean;
+            /**
+                * Scale of the watermark between 0.5 and 1.5.
+                * @default 1
+                */
+            scale?: number;
+            /**
+                * Callback when the watermark is clicked.
+                */
+            onClick?: () => void;
     };
     class WatermarkController {
-        #private;
-        static ENABLED: boolean;
-        static OPTIONS: Required<TShowWatermarkOptions>;
-        object?: Sprite;
-        constructor(core: ICore);
-        show: () => void;
-        hide: () => void;
-        resize: () => void;
+            #private;
+            static ENABLED: boolean;
+            static OPTIONS: Required<TShowWatermarkOptions>;
+            object?: Sprite;
+            constructor(core: ICore);
+            show: () => void;
+            hide: () => void;
+            resize: () => void;
     }
     export default WatermarkController;
 }
@@ -6205,13 +6250,49 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.FloatingLabel'
                             inactive?: string;
                     };
                     /**
-                        * Size of bounding box of SVG icon
+                        * Size of bounding box of the icon
+                        * @default 10
                         */
                     iconSize?: number;
                     /**
-                        * SVG of icon to place inside Floating Label
+                        * Icon to be placed inside the Floating Label marker. Supports SVG or a URL to png or jpeg.
+                        * @example
+                        * ```ts
+                        * // SVG
+                        * mapView.FloatingLabels.add(polygon, "Label", {
+                        * 	appearance: {
+                        * 		marker: {
+                        * 			icon: `<svg>...</svg>`,
+                        * 		},
+                        * 	},
+                        * });
+                        * ```
+                        *
+                        * @example
+                        * ```ts
+                        * // Image URL
+                        * mapView.FloatingLabels.add(polygon, "Label", {
+                        * 	appearance: {
+                        * 		marker: {
+                        * 			icon: 'https://example.com/icon.png',
+                        * 		},
+                        * 	},
+                        * });
+                        * ```
                         */
                     icon?: string;
+                    /**
+                        * How the icon should fit inside the marker. By default, this is not set and the icon will be centered inside the marker.
+                        *  - `fill` will stretch the icon to fill the marker.
+                        *  - `cover` will maintain aspect ratio and fill the marker.
+                        *  - `contain` will maintain aspect ratio and fit the icon inside the marker.
+                        */
+                    iconFit?: 'contain' | 'fill' | 'cover';
+                    /**
+                        * Padding around the icon, in pixels.
+                        * @default 4
+                        */
+                    iconPadding?: number;
                     /**
                         * Defines when the icon becomes visible relative to the current zoom level
                         * anything below 0 will result in icons never showing up
@@ -6243,6 +6324,8 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.FloatingLabel'
                     };
                     iconSize?: number;
                     icon?: string;
+                    iconFit?: 'fill' | 'cover' | 'contain';
+                    iconPadding: number;
                     iconVisibilityThreshold?: number;
             };
     };
@@ -6309,6 +6392,12 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.FloatingLabel'
             static imagePromiseCache: {
                     [key in number]?: Promise<HTMLImageElement>;
             };
+            static imageDimensionsCache: {
+                    [key in number]: {
+                            width: number;
+                            height: number;
+                    };
+            };
             get pinCanvasSize(): number;
             draw(context: CanvasRenderingContext2D): void;
     }
@@ -6983,29 +7072,33 @@ declare module '@mappedin/mappedin-js/renderer/internal/json-scene-loader' {
     import { MappedinMap, MappedinPolygon } from '@mappedin/mappedin-js/renderer/internal';
     import { MAP_RENDER_MODE } from '@mappedin/mappedin-js/renderer/MapView.enums';
     class JSONSceneLoader {
-        defaultExtrudeSettings: {
-            amount: number;
-            bevelEnabled: boolean;
-        };
-        materials: {};
-        scale: number;
-        assetManager: DefaultAssetManager;
-        setAssetManager<T extends DefaultAssetManager>(am: T): void;
-        overlayHeight: number;
-        /**
-        Takes in either an object containing polygons and generates a 3D scene based
-        on it, or a string URL to fetch those polygons from.
-         **/
-        load(polygons: string | MappedinPolygon[], mapClass: MappedinMap, mapLoadingStrategy?: MAP_RENDER_MODE): Promise<{
-            container: Group<import("three").Object3DEventMap>;
-            elements: (Element | null)[];
-            visibleLayers: Set<unknown>;
-        }>;
-        _build(polygons: MappedinPolygon[], mapClass: MappedinMap, mapLoadingStrategy?: MAP_RENDER_MODE): Promise<{
-            container: Group<import("three").Object3DEventMap>;
-            elements: (Element | null)[];
-            visibleLayers: Set<unknown>;
-        }>;
+            defaultExtrudeSettings: {
+                    amount: number;
+                    bevelEnabled: boolean;
+            };
+            materials: {};
+            scale: number;
+            assetManager: DefaultAssetManager;
+            setAssetManager<T extends DefaultAssetManager>(am: T): void;
+            overlayHeight: number;
+            /**
+            Takes in either an object containing polygons and generates a 3D scene based
+            on it, or a string URL to fetch those polygons from.
+             **/
+            load(polygons: string | MappedinPolygon[], mapClass: MappedinMap, mapLoadingStrategy?: MAP_RENDER_MODE, allLayersVisible?: boolean): Promise<{
+                    container: Group<import("three").Object3DEventMap>;
+                    elements: (Element | null)[];
+                    visibleLayers: Set<unknown>;
+            }>;
+            _build(polygons: MappedinPolygon[], mapClass: MappedinMap, mapLoadingStrategy?: MAP_RENDER_MODE, 
+            /**
+                * If true, sets all layers to be visible. If false, uses the layer visibility from the mapClass.
+                */
+            allLayersVisible?: boolean): Promise<{
+                    container: Group<import("three").Object3DEventMap>;
+                    elements: (Element | null)[];
+                    visibleLayers: Set<unknown>;
+            }>;
     }
     const _default: JSONSceneLoader;
     export default _default;