Web SDK v5 Release Notes

Mappedin Web SDK v5 release notes are posted here and this page will be kept up-to-date as updates are released. The SDK is available from @mappedin/mappedin-js on NPM.

v5.34.0 - April 12, 2024

• Added option to exclude node IDs from a route when getting directions.

v5.33.0 - April 10, 2024

• Added ability to enable Stacked Maps without a Journey.
• Added removeGeoJSONLayer function to the Layers API.
• Added Outdoor View for maps rendered using an access token.
• Fixed changeLanguage and getVenue functions to accept language codes case-insensitive.

v5.32.0 - April 2, 2024

• Added venue render options for the data to use live polygons and simplified directions automatically.
• Fixed watermark failing to render.
• Fixed cases where the simplified path would traverse through walls.
• Fixed cases where exterior walls would not render.

v5.31.0 - March 25, 2024

• Added option to hide Stacked Maps level labels.
• Fixed cases where StackedMaps would force OutdoorView on.
• Fixed an issue where Dynamic Focus would stop working after venue language change.
• Fixed a crash when using live polygons with no rendered perspectives.
• Fixed an issue where removeTooltip did not trigger a collision update.

v5.30.1 - March 19, 2024

• Fixed images not appearing on invisible polygons.

v5.30.0 - March 18, 2024

• Added property filterFlags to MappedinLocation and MappedinVortex.
• Improved memory usage during venue initial load.
• Fixed the things option in getVenue so that it merges the new values with the default ones.
• Fixed Floating Label appearance on Intel integrated GPUs.

v5.29.4 - March 7, 2024

• Fixed an issue where Stacked Maps connection path would not redraw if the destination changed.
• Fixed a crash when width or height was 0.
• Fixed an issue where Content Security Policy connect-src could block FloatingLabel images.
• Fixed the polygon outline style being too dark on initial load.

v5.29.3 - February 27, 2024

• Fixed the polygon outline style being too dark when zoomed out.

v5.29.2 - February 27, 2024

• Version bump only.

v5.29.1 - February 27, 2024

• Added new visual option for map shading and outlines.
• Fixed default ambient occlusion performance.
• Fixed clearAllPolygonColors not working.

v5.28.0 - February 21, 2024

• Added option to use live polygons instead of the rendered scene.
• Fixed polygon hover color for polygons that have set color.
• Fixed default value for automatically changing maps in dynamic focus mode to math indoor being fully visible.
• Fixed stacked maps camera transition issue.
• Fixed image flipping when maps changed.
• Fixed floating label rendering height.
• Improved types for event callback.

v5.27.1 - February 6, 2024

• Fixed an issue where the camera could zoom far outside the bounds.
• Fixed polygons returned from click events missing metadata.

v5.27.0 - January 31, 2024

• Added dynamic performance adjustment.
  • This feature is on by default. To disable, pass the dynamicPerformance: false option in to showVenue.
  • Dynamic performance will attempt to maintain above 25 FPS performance on user devices.
• Fixed an incorrect warning about adding and removing FlatLabels on floor change.
• Fixed FloatingLabels not positioning at their correct height.

v5.26.0 - January 18, 2024

• Added option for static path arrows.
• Fixed the MappedinPolygon locations getter returning duplicate results.
• Fixed special characters not yielding search results with OfflineSearch.

v5.25.0 - January 10, 2024

• Added a new FloatingLabel class returned from FloatingLabels.add.
• Added the option to provide bearing when updating BlueDot position.
• Added getVenueMaker to hydrate map data from Maker.

v5.24.1 - January 4, 2024

• Fixed noisy ambient occlusion when monitor DPI is less than 2.
• Fixed FloatingLabels.labelAllLocations() not respecting polygon logo images.
• Fixed map failing to load when image textures cannot be downloaded.

v5.24.0 - December 14, 2023

• Added show and hide methods to OutdoorView.
• Added setDefaultMapForMapGroup method to DynamicFocus.
• Added option to keep colliders active on DynamicFocus base map.
• Journey and Paths now accept MappedinCoordinates.
• Improved collider performance.
• Improved analytics events.
• Improved OutdoorView to hide building outline underneath the venue.
• Improved polygon hover performance.
• Fixed cases where textures would fail to load.
• Fixed Journey pulse animation when arrows were turned off.
• Fixed error accessing browser APIs in Node.
• Fixed BlueDot showing on incorrect floor.
• Fixed invalid error message when adding a FloatingLabel to a polygon with an entrance.
• Fixed BlueDot in DynamicFocus should always be active on base map.
• Fixed Tooltips not appearing within their colliders.
• Fixed Tooltips created at the edge of the screen becoming hidden.

v5.23.0 - November 17, 2023

• Added changeLanguage function to Mappedin class.
• Added support to layer GeoJSON polygons on top of the MapView.
• Added support for OutdoorView while in StackedMaps mode.
• Improved collider performance.
• Improved analytics events.
• Fixed focusOn animation performing redundant rotations.
• Fixed Path drawing performance in OutdoorView.

v5.22.0 - November 10, 2023

• Added layer opacity interpolations based on zoom level.
• Added Markers and Tooltips to E_SDK_EVENT.CLICK.
• Fix BlueDot rendering on multiple floors while in StackedMaps overview.
• Fix instances where a duplicate path would be returned in the click event.
• Fix the connection buttons in StackedMaps zooming into the wrong floor.
• Fix MARKER_ANCHOR enum giving incorrect values.

5.21.0 - October 30, 2023

• Added default language to fetched venue fields.
• Added onMVFParsed and support for annotations.
• Fixed Marker only appearing after moving camera.
• Fixed BlueDot follow mode jumping out during dynamic focus.
• Fixed an issue where enabling and disabling stacked maps causes maps to disappear.
• Removed top level document.createElement.
• Fixed invisible Markers and Tooltips blocking map interaction.

v5.20.0 - October 25, 2023

• Improved Analytics events.
• Fixed FlatLabels / logos blending issue.
• Fixed initial Marker placement.

v5.19.0 - October 18, 2023

• Added DynamicFocus mode to automatically load map groups as the user explores.
• Added support for showing and hiding polygon layers.
• Added support for setting hover color of individual polygons.
• Added support for applying an outline effect to polygons.
• Added an option to configure custom ambient occlusion settings.
• Added children property to MappedinCategory.
• Added simplified instructions when passing simplify to TDirectionToOptions.
• Added an option to extend the OutdoorView attribution.
• Fixed focusOn incorrectly centering target within safeAreaInsets.
• Fixed simplified directions with MappedinDestinationSet.
• Fixed FlatLabels and geometry showing for multiple floors at once.
• Fixed E_SDK_EVENT.CLICK position returning incorrect coordinates.
• Fixed performance when adding multiple labels one-by-one.
• Fixed a crash when modifying paths during map transition.
• Fixed BlueDot appearing darker with multi-buffer rendering.
• Fixed some instances where camera would spin during focusOn.
• Fixed some instances of transparency layer fighting.
• Fixed focusOn positioning when the <div> is changed from display: none.

v5.18.0 - Sept 18, 2023

• Added OutdoorView vector tiles.
• Added support to disable a vortex.
• Added subtitle field to MappedinMap.
• Added getMappedinCoordinateAtScreenCoordinate.
• Added a method to force a Marker to update its dimensions.
• Added support to attach a FloatingLabel to a coordinate.
• Added simplify to TDirectionToOptions to generate directions with less turns.
• Added Camera.interactions.set to enable or disable specific camera interactions.
• Added updateZoomLimits to TFocusOnCameraOptions to enable or disable zoom level adjustments during focusOn.
• Fixed 2 finger tilt on touch screen devices.
• Fixed the camera entering max zoom when middle mouse button was pressed.
• Fixed the order of overlapping Markers based on camera distance.
• Fixed backgroundAlpha of 0 defaulting to 1.
• Fixed the path altitude adjustment not applying to the first segment.

v5.17.0 - Aug 24, 2023

• Added topLocations to venue object.
• Added option for FloatingLabels ranked by category.
• Added option to adjust path altitude to ensure it's on top of polygons.
• Added and improved documentation.
• Fixed a bug in polygon material loading.
• Fixed end caps of routes to be level with the path instead of sinking them to the floor.

v5.16.0 - July 21, 2023

• Fixed path end caps going below the ground when xRayPath: true.
• Fixed BlueDot exiting follow mode after receiving position updates.
• Fixed polygon hover color being cleared on mouse leave.
• Fixed polygon images in outdoorGeometryLayers still rendering.

v5.15.2 - July 13, 2023

• Fixed the appearance of paths when the last node is on a different map.
• Fixed an issue with BlueDot when using STATE.FOLLOW and Journey.
• Fixed an issue where focusOn would not fit targets within viewbox if tilt and rotation changed.
• Fixed the extra warnings in the console.
• Fixed the camera target calculation when outside of StackedMaps mode.

v5.15.1 - July 11, 2023

• Fixed the color space of images rendered on polygons.
• Fixed Three.js and analytics warnings in the console.

v5.15.0 - July 7, 2023

• Added state property to StackedMaps to get the current STACKED_MAPS_STATE.
• Fixed cursor position detection when the page containing the map element is scrolled.

v5.14.1 - June 29, 2023

• Fixed an issue where FlatLabels added to maps not currently visible skipped rendering.

v5.14.0 - June 27, 2023

• Added experimental support for ambient occlusion.
• Added experimental support for stacked maps.

v5.13.0 - June 22, 2023

• Added new icon fields to MappedinLocation and MappedinCategory.
• Added option to getVenue to preload map geometry.
• Changed anti-aliasing to be enabled for all monitors.
• Fixed an error with BlueDot when using useRotationMode: true and setState(STATE.FOLLOW).
• Fixed an issue with azure attribution when using the SAS token.

v5.12.1 - June 21, 2023

• Fixed an issue with JavaScript files in the type declarations.

v5.12.0 - June 19, 2023

• Added an experimental multi-buffer rendering option.
• Added x-ray paths when multi-buffer rendering is on.
• Fixed setLoggerLevel not working.
• Fixed an issue where scene transitions kicked Blue Dot out of follow mode.
• Fixed an error when fetching label rankings.
• Fixed an issue with SAS tokens for azure tiles.
• Fixed an issue where GLSL was included in type declarations.

v5.11.0 - June 13, 2023

• Added secure asset loading via CDN token requested during getVenue.
• Added documentation to MapView class.
• Fixed a bug where polygons with 0 opacity were visible.
• Fixed a bug where backgroundAlpha of 0 was ignored.

v5.10.2 - June 8, 2023

• Added documentation to Camera API class.
• Fixed Flat Label rendering on polygons with hidden images.

v5.10.1 - May 30, 2023

• Removed unused package.json dependencies

v5.10.0 - May 30, 2023

• Added setLoggerLevel function to show or hide console messages.
• Fixed artifacting around polygon images.

v5.9.1 - Apr 27, 2023

• Export Path as top level type

v5.9.0 - Apr 25, 2023

• Fix clearPolygonColor and clearAllPolygonColors resetting Flat Label appearance
• Fix cursor not changing when hovering interactive elements

v5.8.0 - Apr 13, 2023

• Add Paths Layer to MapView with support for interactive Paths
• Fix case where adding a new Flat Label didn't remove the old one
• Fix polygon colors appearing different than label colors

v5.7.1 - Apr 3, 2023

• Fix scene re-rendering after label updates

v5.7.0 - March 30, 2023

• Add Markers Layer to MapView with support for animated Markers

v5.6.1 - March 29, 2023

• Fix broken type definitions

v5.6.0 - March 28, 2023

• Add support for interactive Floating Labels
• Add Floating Labels to E_SDK_EVENT.CLICK payload
• Add nodes property to MappedinVortex
• Fix crash when calling FlatLabels.remove() on a polygon which has no label

v5.5.0 - March 27, 2023

• Made the Marker class public
  • createMarker now returns a Marker object
• Fix path arrows not rendering if path pulse is disabled
• Fix instances where MappedinDestinationSets could be discontinuous

v5.4.0 - March 21, 2023

• Add getPolygonsAtScreenCoordinate -method
• Add support for iconSize in Floating Label appearance
• Stop filtering polygons with invisible geometry when fetching venue data
• Fix scrolling zoom speed on Firefox

v5.3.0 - March 14, 2023

• Turn Blue Dot smoothing off by default on devices using Apple's IPS

v5.2.2 - March 9, 2023

• Additional fixes to polygon highlights

v5.2.1 - March 6, 2023

• Fix a bug where polygon highlight meshes were incorrectly positioned

v5.2.0 - February 27, 2023

• Autogenerated layers should always render
• Fix crash if incorrect map is passed as firstMap
• Add map to SDK_EVENT.CLICK payload
• Fix labels appearance when map is resized from 0x0

v5.1.5 - February 14, 2023

• Fix a bug with Blue Dot directional bearing cone animation
• Improve smart label rendering when using browser zoom

v5.1.4 - February 10, 2023

• Fixed issue with focusOn causing faded-out floating labels

v5.1.3 - February 7, 2023

• Adds double tap to zoom, two finger single tap to zoom out
• Fix floating labels not displaying on polygons with images

v5.1.2 - January 31, 2023

• Fix issues related to NextJS static HTML export

v5.1.1 - January 30, 2023

• Lowered ES target

v5.1.0 - January 30, 2023

• Add support for icons in Floating Labels
• Floating Labels now only labels one entrance
• Fix FlatLabels.labelAllLocations() failing after 3 times

v5.0.3 - December 15, 2022

• Fix issues with removing and relabelling Flat Labels

v5.0.2 - December 9, 2022

• Fix TypeScript definitions

v5.0.1 - December 5, 2022

• Update readme

v5.0.0 - December 5, 2022

This release includes changes from all previous beta versions.

• Improve Flat Label setAppearance to overwrite only specified settings
• Streamline createTooltip arguments
• Fix MappedinCategory.locations getter
• Internal caching and typing improvements
• Fix error preventing markers from being created
• Improve analytics API
• Add new Flat Labels and Floating Labels APIs
• Improve types and documentation in various parts
• Improve error handling in wrappers
• Remove setPolygonColor’s textColor and polygonId arguments
• Fix getPolygonsAtCoordinate to use map of coordinate instead of current map
• Fix camera animation rotation for larger angles
• Fix first map loaded -promise returning too early
• Suppress extraneous console logs in production
• Mark getVenueMVF as internal
• Remove old search, which was replaced with OfflineSearch
• Remove 2D perspective
• Add translate method to the Camera class to enable camera movement
• Fix map element selection in iOS
• Stop bundling fetch function for non-browser and React Native environments. This breaking change requires that you set your own fetch function in Node. For example:

Copy
import { setFetchFn } from '@mappedin/mappedin-js';
import fetch from 'node-fetch';

setFetchFn(fetch);

• Added maxTilt property to Camera which can be read to retrieve the current max tilt angle, and be set to a new max tilt angle. A range of is enforced via clamping, limiting the tilt angle to between a completely top-down view and completely side-on view.
• Added useDraftData option to getVenue to allow accessing draft mode data for testing purposes. This feature needs to be enabled separately for your API keys.
• Fix searching tags that contain diacritics (accents such as ñ)
• Fix ALWAYS_VISIBLE and other marker priority rankings

v5.0.0-beta.11 - November 23, 2022

• Streamline createTooltip arguments
• Fix MappedinCategory.locations getter
• Internal caching and typing improvements

v5.0.0-beta.10 - November 17, 2022

• Fix error preventing markers from being created

v5.0.0-beta.9 - November 9, 2022

• Improve analytics API
• Add new Flat Labels and Floating Labels APIs
• Improve types and documentation in various parts
• Improve error handling in wrappers
• Remove setPolygonColor’s textColor and polygonId arguments
• Fix getPolygonsAtCoordinate to use map of coordinate instead of current map

v5.0.0-beta.8 - October 19, 2022

• Fix camera animation rotation for larger angles
• Fix first map loaded -promise returning too early
• Suppress extraneous console logs in production
• Mark getVenueMVF as internal
• Remove old search, which was replaced with OfflineSearch
• Remove 2D perspective

v5.0.0-beta.7 - September 12, 2022

• Add translate method to the Camera class to enable camera movement
• Fix map element selection in iOS
• Stop bundling fetch function for non-browser and React Native environments. This breaking change requires that you set your own fetch function in Node. For example:

Copy
import { setFetchFn } from '@mappedin/mappedin-js';
import fetch from 'node-fetch';

setFetchFn(fetch);

v5.0.0-beta.6 - August 10, 2022

• Added maxTilt property to Camera which can be read to retrieve the current max tilt angle, and be set to a new max tilt angle. A range of is enforced via clamping, limiting the tilt angle to between a completely top-down view and completely side-on view.
• Added useDraftData option to getVenue to allow accessing draft mode data for testing purposes. This feature needs to be enabled separately for your API keys.

v5.0.0-beta.5 - August 10, 2022

• Fix searching tags that contain diacritics (accents such as ñ)

v5.0.0-beta.4 - August 4, 2022

• No changes