@mappedin/mappedin-js 5.31.0 → 5.33.0

package/lib/esm/renderer/chunk-C76G2TTC.js

@@ -0,0 +1 @@
+import{b as a}from"./chunk-ZRT45YCM.js";var e,c=a((()=>{e={env:{NODE_ENV:"production",npm_package_version:"5.33.0"}}}));export{c as a,e as b};

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

@@ -766,7 +766,7 @@ declare module '@mappedin/mappedin-js/renderer/public/MapView' {
 }
 
 declare module '@mappedin/mappedin-js/get-venue' {
-    import type { TAllGetVenueOptions, TGetVenueOptions, TGetVenueOptionsInternal, TVenueMetadata } from '@mappedin/mappedin-js/get-venue/Mappedin.types';
+    import type { TAllGetVenueOptions, TGetVenueOptions, TGetVenueOptionsInternal, TVenueMetadata, ThingsOption } from '@mappedin/mappedin-js/get-venue/Mappedin.types';
     import { Mappedin } from '@mappedin/mappedin-js/get-venue/Mappedin';
     import { defaultThings } from '@mappedin/mappedin-js/get-venue/default-things';
     import { GET_VENUE_EVENT } from '@mappedin/mappedin-js/get-venue/internal';
@@ -804,6 +804,7 @@ declare module '@mappedin/mappedin-js/get-venue' {
     export type { TOperationHoursMap } from '@mappedin/mappedin-js/get-venue/MappedinLocation';
     export type { TMappedinCoordinateOptions } from '@mappedin/mappedin-js/get-venue/MappedinCoordinate';
     export type { TDirectionToOptions, TTHINGS, TAccessors } from '@mappedin/mappedin-js/get-venue/internal';
+    export type { ThingsOption };
     export { OfflineSearch } from '@mappedin/mappedin-js/get-venue/Mappedin.OfflineSearch';
     export type { TMappedinOfflineSearchOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineAllSearchMatch, TMappedinOfflineSearchAllOptions, } from '@mappedin/mappedin-js/get-venue/Mappedin.OfflineSearch';
     export { defaultThings };
@@ -1135,7 +1136,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.BlueDot/Mappedi
 }
 
 declare module '@mappedin/mappedin-js/renderer/MapView.types' {
-    import type { Mappedin, MappedinCoordinate, MappedinLocation, MappedinMap, MappedinNode, MappedinPolygon } from '@mappedin/mappedin-js/get-venue';
+    import type { Mappedin, MappedinCoordinate, MappedinLocation, MappedinMap, MappedinNode, MappedinPolygon, ThingsOption } from '@mappedin/mappedin-js/get-venue';
     import type { TFloatingLabelAppearance } from '@mappedin/mappedin-js/renderer/internal/Mappedin.FloatingLabel';
     import type { TEnableBlueDotOptions, TBlueDotPositionUpdate, TBlueDotStateChange } from '@mappedin/mappedin-js/renderer/internal/Mappedin.BlueDot/Mappedin.BlueDot.core';
     import type { Euler, Object3D, Vector3 } from 'three';
@@ -1143,7 +1144,7 @@ declare module '@mappedin/mappedin-js/renderer/MapView.types' {
     import { TOOLTIP_ANCHOR } from '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartTooltip';
     import { GEOLOCATION_STATUS, COLLISION_RANKING_TIERS, STATE, MARKER_ANCHOR, E_SDK_EVENT, E_BLUEDOT_EVENT, E_CAMERA_EVENT, MAP_RENDER_MODE, CAMERA_EASING_MODE, E_MAP_CHANGED_REASON } from '@mappedin/mappedin-js/renderer/MapView.enums';
     import { TOutdoorViewOptions, TOutdoorViewOptionsWithHeaders, TOutdoorViewOptionsWithAuthURL } from '@mappedin/mappedin-js/renderer/private/controllers/OutdoorViewController';
-    export type { TEnableBlueDotOptions, TFloatingLabelAppearance };
+    export type { TEnableBlueDotOptions, TFloatingLabelAppearance, ThingsOption };
     /** @internal */
     export type Without<T, U> = {
             [P in Exclude<keyof T, keyof U>]?: never;
@@ -3522,6 +3523,26 @@ declare module '@mappedin/mappedin-js/renderer/public/api/StackedMaps' {
                 * @returns Promise when all animations are complete.
                 */
             zoomInToMap: (map: MappedinMap, cameraTransform?: TCameraTransform) => Promise<void>;
+            /**
+                * @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.
+                *
+                * @param options - Options to adjust the overview. Each option defaults to the setting passed in {@link enable}, unless provided.
+                *
+                * @example
+                * ```ts
+                * mapView.Journey.draw(...);
+                * mapView.StackedMaps.enable();
+                * mapView.StackedMaps.showOverview();
+                * mapView.Journey.clear();
+                * mapView.StackedMaps.restack();
+                * ```
+                *
+                * @returns Promise when all animations are complete.
+                */
+            restack: (options?: TStackedMapsOptions) => Promise<void>;
             /**
                 * @experimental
                 *
@@ -3686,6 +3707,12 @@ declare module '@mappedin/mappedin-js/renderer/public/api/Layers' {
                 * Adds a GeoJSON Feature or FeatureCollection to the map as a layer. The layer name must be unique
                 */
             addGeoJSONLayer(layerName: string, featureOrFeatureCollection: Feature<Polygon, GeoJsonProperties | null> | FeatureCollection<Polygon, GeoJsonProperties | null>): Promise<void> | undefined;
+            /**
+                * @experimental
+                * Hides a GeoJSON layer from the map and removes it from the list of layers.
+                * It will not appear in {@link getAllLayersForMap} afterwards and can be overwritten by a new layer with the same name.
+                */
+            removeGeoJSONLayer(layerName: string): Promise<void> | undefined;
     }
     export default LayerController;
 }
@@ -4133,7 +4160,7 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/WatermarkCont
         #private;
         static ENABLED: boolean;
         static OPTIONS: Required<TShowWatermarkOptions>;
-        object: Sprite;
+        object?: Sprite;
         constructor(core: ICore);
         show: () => void;
         hide: () => void;
@@ -4809,6 +4836,7 @@ declare module '@mappedin/mappedin-js/get-venue/Mappedin.types' {
             clientId: string;
             clientSecret: string;
             venue: string;
+            accessToken: string;
     };
     export type TAllGetVenueOptions = TGetVenueOptions | TGetVenueMVFOptions | (TProcessedMVFOptions & {
             perspective?: string;
@@ -6611,115 +6639,141 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/StackedMapsCo
     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';
     enum ACTION {
-        enable = "enable",
-        disable = "disable",
-        showOverview = "showOverview",
-        zoomInToMap = "zoomInToMap",
-        scrollToMap = "scrollToMap"
+            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;
+            animate?: boolean;
     };
     export type TStackedMapsOptions = {
-        verticalDistanceBetweenMaps?: number;
-        mapLabels?: boolean;
+            /**
+                * 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;
     };
     class StackedMapsController {
-        #private;
-        options: TStackedMapsOptions;
-        enabled: boolean;
-        stackScene: MapViewStackScene;
-        directions: MappedinDirections | MappedinDirections[];
-        constructor(core: ICore);
-        needsUpdate: boolean;
-        currentState: STACKED_MAPS_STATE;
-        mapsInJourney: 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;
-        getEnableOptions: (params: TParams) => void;
-        getShowOverviewTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
-        getZoomInToMapTransition: (options: any) => () => Promise<void>;
-        getScrollToMapTransition: (options: any, inTransit?: boolean) => () => Promise<void>;
-        getDisableTransition: (options: any) => () => Promise<void>;
-        getEnableTransition: () => () => void;
-        states: TState;
-        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 nodesInJourney(): MappedinNode[];
-        showOverview: () => Promise<void>;
-        scrollToMap: (map: MappedinMap) => 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;
 }
@@ -6983,7 +7037,10 @@ declare module '@mappedin/mappedin-js/renderer/private/Core.interface' {
                 * An object containing all outlined polygons.
                 */
             outlinedPolygons: Map<string, MappedinPolygon>;
-            cameraPlane: any;
+            /**
+                * A plane that is parallel to the ground and is used for raycasting.
+                */
+            worldPlane: Mesh;
             getPositionLatLon(lat: number, lon: number, map?: MappedinMap | string | null): Vector3;
             currentScale: number;
             getPositionPolygon(polygon: MappedinPolygon | string): Vector3;
@@ -7691,7 +7748,7 @@ declare module '@mappedin/mappedin-js/get-venue/pub-sub.typed' {
         * @template EVENT_PAYLOAD - The type of the event payload.
         * @template EVENT - The type of the event.
         */
-    export class PubSub<EVENT_PAYLOAD, EVENT extends keyof EVENT_PAYLOAD> {
+    export class PubSub<EVENT_PAYLOAD, EVENT extends keyof EVENT_PAYLOAD = keyof EVENT_PAYLOAD> {
             /**
                 * @private
                 * @internal
@@ -8722,73 +8779,76 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/EventSystem'
     import type { ICore, MappedinPolygon, Collider } from '@mappedin/mappedin-js/renderer/internal';
     import { BlueDotManager, Path } from '@mappedin/mappedin-js/renderer/internal';
     class EventSystem {
-        core: ICore;
-        blueDotManager?: BlueDotManager;
-        rendererDomElement: any;
-        currentHover: string | null;
-        hoverLabel: any;
-        hoverColor: Color;
-        options: {
-            disableHover: boolean;
-        };
-        constructor(core: ICore);
-        setBlueDotManager: (blueDotManager: any) => void;
-        touchCount: number;
-        zoomOut(): void;
-        zoomIn(event: any): void;
-        onPointerMove: (event: any) => void;
-        onPointerUp: (event: any) => void;
-        /**
-          * We've confirmed that a map click has occured, so handle that here
-          */
-        handleMapClick(event: any): void;
-        onPointerDown: (event: any) => void;
-        incrementTouches: (event: any) => void;
-        decrementTouches: (event: any) => void;
-        clearMouse: () => void;
-        getMousePos: (event: any) => {
-            x: any;
-            y: any;
-        };
-        getScaledMousePos: (event: any) => {
-            x: number;
-            y: number;
-        };
-        cursorPos: {
-            x: number;
-            y: number;
-        };
-        mouse: {
-            x: number;
-            y: number;
-        };
-        mouseDownStart: {
-            time: number;
-            clientX: number;
-            clientY: number;
-        };
-        scaledCursorPos: {
-            x: number;
-            y: number;
-        };
-        hasTouched: boolean;
-        calculateMouseCoordinates: (event: any) => void;
-        getMouseRayIntersects: (objects: Object3D | Object3D[]) => import("three").Intersection<Object3D<import("three").Object3DEventMap>>[];
-        detectCollidersUnderMouse: () => Collider[];
-        detectPolygonsUnderMouse: () => string[];
-        detectPathsUnderMouse: () => Path[];
-        detectWatermarkUnderMouse: () => boolean;
-        detectMapsUnderMouse: () => (import("../../internal").MappedinMap | null)[];
-        getMouseMapPosition: () => {
-            x: number;
-            y: number;
-        };
-        checkMouseIntersectsBlueDot: () => boolean;
-        doHoverEffect: () => void;
-        onPolygonHoverOut: (polygonId: string) => false | undefined;
-        onPolygonHoverOver: (polygon: MappedinPolygon | string) => false | undefined;
-        setHoverColor: (color: string) => void;
-        destroy(): void;
+            core: ICore;
+            blueDotManager?: BlueDotManager;
+            rendererDomElement: any;
+            currentHover: string | null;
+            hoverLabel: any;
+            hoverColor: Color;
+            options: {
+                    disableHover: boolean;
+            };
+            constructor(core: ICore);
+            setBlueDotManager: (blueDotManager: any) => void;
+            touchCount: number;
+            zoomOut(): void;
+            zoomIn(event: any): void;
+            onPointerMove: (event: any) => void;
+            onPointerUp: (event: any) => void;
+            /**
+                * We've confirmed that a map click has occured, so handle that here
+                */
+            handleMapClick(event: any): void;
+            onPointerDown: (event: any) => void;
+            incrementTouches: (event: any) => void;
+            decrementTouches: (event: any) => void;
+            clearMouse: () => void;
+            getMousePos: (event: any) => {
+                    x: any;
+                    y: any;
+            };
+            getScaledMousePos: (event: any) => {
+                    x: number;
+                    y: number;
+            };
+            cursorPos: {
+                    x: number;
+                    y: number;
+            };
+            mouse: {
+                    x: number;
+                    y: number;
+            };
+            mouseDownStart: {
+                    time: number;
+                    clientX: number;
+                    clientY: number;
+            };
+            scaledCursorPos: {
+                    x: number;
+                    y: number;
+            };
+            hasTouched: boolean;
+            calculateMouseCoordinates: (event: any) => void;
+            getMouseRayIntersects: (objects: Object3D | Object3D[]) => import("three").Intersection<Object3D<import("three").Object3DEventMap>>[];
+            detectCollidersUnderMouse: () => Collider[];
+            detectPolygonsUnderMouse: () => string[];
+            detectPathsUnderMouse: () => Path[];
+            detectWatermarkUnderMouse: () => boolean;
+            detectMapsUnderMouse: () => (import("../../internal").MappedinMap | null)[];
+            /**
+                * Gets mouse click position in x y map coordinates
+                */
+            getMouseMapPosition: () => {
+                    x: number;
+                    y: number;
+            };
+            checkMouseIntersectsBlueDot: () => boolean;
+            doHoverEffect: () => void;
+            onPolygonHoverOut: (polygonId: string) => false | undefined;
+            onPolygonHoverOver: (polygon: MappedinPolygon | string) => false | undefined;
+            setHoverColor: (color: string) => void;
+            destroy(): void;
     }
     export default EventSystem;
 }
@@ -9310,7 +9370,7 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/ExportControl
             /**
                 * Exports the current scene as a GLTF file.
                 */
-            getCurrentSceneGLTF(userOptions: TGLTFExportOptions): Promise<Blob>;
+            getCurrentSceneGLTF: (userOptions: TGLTFExportOptions) => Promise<Blob>;
     }
 }
 
@@ -9334,6 +9394,7 @@ declare module '@mappedin/mappedin-js/renderer/private/controllers/LayerControll
                 */
             getVisibleLayersForLoadedMap(map: MappedinMap): string[] | undefined;
             addGeoJSONLayer(layerName: string, featureOrFeatureCollection: Feature<Polygon, GeoJsonProperties | null> | FeatureCollection<Polygon, GeoJsonProperties | null>): Promise<void>;
+            removeGeoJSONLayer(layerName: string): Promise<void>;
     }
     export default LayerController;
 }
@@ -9905,7 +9966,7 @@ declare module '@mappedin/mappedin-js/renderer/private/Core' {
             resolution: Vector2;
             cameraParameters: any;
             controls: typeof Mappedin.CameraControls;
-            cameraPlane: Mesh;
+            worldPlane: Mesh;
             canvasWidth: number;
             canvasHeight: number;
             cachedPadding: TPadding;
@@ -10610,60 +10671,73 @@ declare module '@mappedin/mappedin-js/get-venue/MappedinVenue' {
     import type { Mappedin } from '@mappedin/mappedin-js/get-venue/internal';
     import type { TLogo, TOpeningHours } from '@mappedin/mappedin-js/get-venue/Mappedin.API.types';
     /**
-      * A {@link MappedinVenue} is a specific place (like a mall) with one or more Maps (typically representing different floors) and Locations (stores, washrooms, elevators, etc).
-      *
-      * A Venue can have more properties such as 'name' and 'slug'. The {@link Mappedin} 'things' object is where you would specify what properties you want to download for Venues. Only specify what you will actually use, to minmimze transfer time. Work with your Mappedin developer relations contact to set up any custom properties you need.
-      *
-      * See below for an example a 'things' object with available Venue properties specified:
-      *
-      *	things: {
-      *		venue: ['slug', 'name', 'language', 'address', 'city', 'state', 'postal', 'telephone', 'latitude', 'longitude', 'website', 'operationHours'],
-      *		locations: [],
-      *		categories: [],
-      *		maps: []
-      * 	}
-      *
-      *
-      * @class MappedinVenue
-      */
+        * A {@link MappedinVenue} is a specific place (like a mall) with one or more Maps (typically representing different floors) and Locations (stores, washrooms, elevators, etc).
+        *
+        * A Venue can have more properties such as 'name' and 'slug'. The {@link Mappedin} 'things' object is where you would specify what properties you want to download for Venues. Only specify what you will actually use, to minmimze transfer time. Work with your Mappedin developer relations contact to set up any custom properties you need.
+        *
+        * See below for an example a 'things' object with available Venue properties specified:
+        *
+        *	things: {
+        *		venue: ['slug', 'name', 'language', 'address', 'city', 'state', 'postal', 'telephone', 'latitude', 'longitude', 'website', 'operationHours'],
+        *		locations: [],
+        *		categories: [],
+        *		maps: []
+        * 	}
+        *
+        *
+        * @class MappedinVenue
+        */
     export class MappedinVenue {
-        #private;
-        defaultMap: string;
-        address: string;
-        city: string;
-        countrycode: string;
-        externalId: string;
-        id: string;
-        latitude?: number;
-        logo?: TLogo;
-        longitude?: number;
-        name: string;
-        operationHours?: TOpeningHours[];
-        postal: string;
-        slug: string;
-        state: string;
-        telephone: string;
-        tzid: string;
-        tzidOverride: string;
-        utcOffset: string;
-        website: string;
-        secureContentStorage: boolean;
-        defaultLanguage: {
-            code: string;
-            name: string;
-        };
-        languages: {
+            #private;
+            defaultMap: string;
+            address: string;
+            city: string;
+            countrycode: string;
+            externalId: string;
+            id: string;
+            latitude?: number;
+            logo?: TLogo;
+            longitude?: number;
             name: string;
-            code: string;
-        }[];
-        topLocations?: string[];
-        constructor(mappedin: Mappedin, data: any);
-        get metadata(): any;
-        set metadata(value: any);
-        static hydrate(data: any, mappedin: Mappedin): MappedinVenue;
-        static fetch(mappedin: Mappedin): Promise<MappedinVenue>;
-        get isMultiBuilding(): any;
-        toJSON(): any;
+            operationHours?: TOpeningHours[];
+            postal: string;
+            slug: string;
+            state: string;
+            telephone: string;
+            tzid: string;
+            tzidOverride: string;
+            utcOffset: string;
+            website: string;
+            secureContentStorage: boolean;
+            defaultLanguage: {
+                    code: string;
+                    name: string;
+            };
+            languages: {
+                    name: string;
+                    code: string;
+            }[];
+            topLocations?: string[];
+            /**
+                * Venue render options provided by the server.
+                */
+            renderOptions: {
+                    /**
+                        * Whether the venue should use perspectives to render the map or {@link Mappedin.polygons}.
+                        */
+                    useLivePolygons: boolean;
+                    /**
+                        * Whether the venue should automatically apply {@link TDirectionToOptions} `simplify: { enabled: true }` to all directions.
+                        */
+                    simplifyDirections: boolean;
+            };
+            constructor(mappedin: Mappedin, data: any);
+            get metadata(): any;
+            set metadata(value: any);
+            static hydrate(data: any, mappedin: Mappedin): MappedinVenue;
+            static fetch(mappedin: Mappedin): Promise<MappedinVenue>;
+            get isMultiBuilding(): any;
+            toJSON(): any;
     }
 }