--- title: Wayfinder Class description: Wayfinder Class --- [Skip to content](https://knowledge.acquiredigital.com/wayfinder-class#main-content) English Show submenu for translations [More support](https://knowledge.acquiredigital.com/kb-tickets/new?hsLang=en) [Support Portal](https://knowledge.acquiredigital.com/support?hsLang=en) ![acquire-digital-logo](https://knowledge.acquiredigital.com/hs-fs/hubfs/Property%201=No%20Trademark.png?width=50&height=50&name=Property%201=No%20Trademark.png) Open main navigation Close main navigation - English Show submenu for translations - [More support](https://knowledge.acquiredigital.com/kb-tickets/new) - [Support Portal](https://knowledge.acquiredigital.com/support) - Contact us Contact us How can we help you? - There are no suggestions because the search field is empty. 1. [Acquire Digital Knowledgebase](https://knowledge.acquiredigital.com/?hsLang=en) 2. [Acquire Wayfinder](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en) 3. [JS Web Map API V2.0](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#js-web-map-api-v2-0) # Wayfinder Class ## The wayfinder class exports the following static properties and functions: | *BuildVersion* | A string with the current version | | --- | --- | | *BuildDate* | When this was created, in dd/mm/yyyy format | | *BoundaryTypeFloorActiveArea* *BoundaryTypeFloorArea* *BoundaryTypeEntireRoute* *BoundaryTypeRouteLeg* | Integer values to use with the getFloorBounds() function | | *GetRGB* | Converts multiple types of colour input into a standard object containing r, g, b and a properties that have a range between 0 and 255. | | *RGB2Hex* | Converts an object with properties r, g and b, into hex notatation suitable for use with CSS. | | *ToCDN* | Converts a url of the form: [wayfinderstorager.blob.core.windows.net](http://wayfinderstorager.blob.core.windows.net/) to [cdn.wayfinder.acquiredigital.com](http://cdn.wayfinder.acquiredigital.com/) | The wayfinder class also exports the following properties and functions while instantiated. With properties, (r) means read only, (r/w) means read/write. | *angle* | property (r/w) | The current rotational angle of the map in degrees | | --- | --- | --- | | *animateToBounds(bounds, angle, tilt, animate)* | function | Pans and zooms the map such that the map coordinates provided fit within the display. **bounds**: a [WayfinderBounds](https://app.clickup.com/2561453/v/dc/2e5dd-10408/2e5dd-19388) object describing the region **angle**: defaults to null, the rotational angle of the map to spin to **tilt**: The tilt of the map to use **animate**: true/false if the function should smoothly animate to these bounds or not. **returns**: A promise on completion. | | *clearRoute* | function | Clears and removes any active route | | *database* | property (r) | Provides access to the [Wayfinder](https://doc.clickup.com/2561453/p/h/2e5dd-19288/6651ad4daef5747/2e5dd-19388)[Database](https://doc.clickup.com/2561453/p/h/2e5dd-19288/6651ad4daef5747/2e5dd-19388)object | | floorId | property (r) | Returns the current floor ID | | *getFloorBounds(floorId, type, leg)* | function | Returns a [Wayfinder](https://doc.clickup.com/2561453/p/h/2e5dd-19288/6651ad4daef5747/2e5dd-19388)[Bounds](https://doc.clickup.com/2561453/p/h/2e5dd-19288/6651ad4daef5747/2e5dd-19388) object that describes the minimum and maximum coordinates of the map, where: **floorId**: The floor to get bounds from **type**: Can be one of: *BoundaryTypeFloorActiveArea* *BoundaryTypeFloorArea* *BoundaryTypeEntireRoute* *BoundaryTypeRouteLeg* **leg**: If type is set to *BoundaryTypeRouteLeg* then this allows you to extract the bounds of a specific part of a route. This is only useful if following a route leads to another map, and then back to this one. | | loaded | property (r) | Boolean indicating whether the database data has finished loading. | | *loadFromApiKey(key)* | function | Loads and sets up the map from the api key string provided. **Returns** a promise that resolves when the map is loaded. | | *loadFromJSON(jsonData)* | function | Loads and sets up the map from jsonData object. This is in the format generated via the Wayfinder CMS. **Returns** a promise that resolves when the map is loaded. | | loadAsMapApp() | function | Should only ever be called from [*mapapp.co*](http://mapapp.co/). This will populate the required fields from the handoff URL from the kiosk and start the map loading process. The default starting floor will be overwritten to the start waypoint/node supplied. This also generates a new event when loading is complete called 'mapapp' **Returns** a promise that resolves when the map is loaded. | | *panTo(position, animate)* | function | Moves the center of the map to a new position **position**: The new position to move/pan to. Position is an object with *x*, *y* and *z* properties, although the y property is not used. **animate**: If true then the map moves over a small interval as oppose to instantly moving there. **returns**: a promise for completion or error. | | *position* | property (r/w) | Set the position of the map on screen. The property is an object with *x*, *y* and *z* properties. | | ready | property (r) | Boolean indicating whether all background assets have finished loading. | | *redraw* | function | The map only re-renders if something changes. This will cause a re-draw of the map. | | *resetSelection* | function | Restores all meshes and icons back to their default non-selected state | | *rootDIV* | property (r) | The HTML element passed into the constructor | | *routeBetween(startId, endIds, useDDA, \[routeByShortestDistance\])* | function | Requests a route to be generated **start**: The ID of a node to start from **endIds**: An array of target node IDs. The nearest one will be the route returned. **useDDA**: true/false. If true makes the routing engine generate more accessible routes. ***routeByShortestDistance****: optional true/false. If not set will default to project settings. If true then route generated will be the shortest distance, if false it will be the quickest time* **returns:** A promise for success/failure | | *setViewMode(perspectiveView)* | function | Changes the display type. **perspectiveView***:* ***true:*** switches to perspective view **false**: switches to orthographic view. | | *showFloor(floorId, animate, waitForLoad)* | function | Switches the map to a different map **floorid**: The map to change to **animate**: If an animation should occur for the transition (not currently implemented) **waitForLoad**: If the map is not currently loaded then the function will wait for this. **returns**: a promise for completion or error. | | *size* | property (r) | Returns the current map size in pixels *{width,height}* | | *settings* | property (r) | Allows access to the [settings](https://app.clickup.com/2561453/v/dc/2e5dd-10408/2e5dd-19408) object | | *tilt* | property (r/w) | The current elevation angle of the map in degrees between 30 and 90, where 90 is top-down | | *zoomBy(delta)* | function | Zooms the map in or out. **delta**: ***A negative value*** causes zoom out by 10% ***A positive value*** causes zoom in by 10% | | *zoomLevel* | property (r/w) | The current zoom level of the map. Between 0 and 100. ***0***is fully zoomed out ***100***is fully zoomed in | | *addMarker(url, nodeId)* | function | Adds a marker to the specified ***nodeId*** using the image provided in ***url***. A marker object is returned. | | *deleteMarker(marker)* | function | Deletes a previously created marker. The parameter ***marker***is the return value from addMarker | - [Software Installers](https://knowledge.acquiredigital.com/software-installers?hsLang=en) - [StudioDX & DX Player](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#main-content) - [Studio DX FAQ's](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#studio-dx-faqs) - [Acquire StudioDX User Documentation](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#acquire-studiodx-user-documentation) - [User Guide](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#user-guide) - [Widgets](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#widgets) - [Transitions](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#transitions) - [Warning Alerts](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#warning-alerts) - [Setup App](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#setup-app) - [Project Apps](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#project-apps) - [StudioDX Stream Deck Plugin](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#studiodx-stream-deck-plugin) - [XML Formats](https://knowledge.acquiredigital.com/studiodx-dx-player?hsLang=en#xml-formats) - [Acquire Wayfinder](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#main-content) - [Map Editor - Atlas](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#map-editor-atlas) - [Devices](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#devices) - [CMS User Management](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#cms-user-management) - [Project Settings](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#project-settings) - [The Map Editor](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#the-map-editor) - [JS Web Map UI V2.0](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#js-web-map-ui-v2-0) - [JS Web Map API V2.0](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#js-web-map-api-v2-0) - [JS Web Directory API V1.0](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#js-web-directory-api-v1-0) - [Wayfinder Map API](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#wayfinder-map-api) - [Broadsign Integration](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#broadsign-integration) - [Adverts Plugin](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#adverts-plugin) - [Wayfinder FAQs](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#wayfinder-faqs) - [Beacon](https://knowledge.acquiredigital.com/beacon?hsLang=en#main-content) - [Devices](https://knowledge.acquiredigital.com/beacon?hsLang=en#devices) - [Layouts](https://knowledge.acquiredigital.com/beacon?hsLang=en#layouts) - [Information Displays](https://knowledge.acquiredigital.com/beacon?hsLang=en#information-displays) - [Playlists](https://knowledge.acquiredigital.com/beacon?hsLang=en#playlists) - [Project Settings](https://knowledge.acquiredigital.com/beacon?hsLang=en#project-settings) - [Activity Logs](https://knowledge.acquiredigital.com/beacon?hsLang=en#activity-logs) - [Acquire DOOHAD](https://knowledge.acquiredigital.com/acquire-doohad?hsLang=en#main-content) - [DOOHAd Standalone Installer & Advert Configuration Tool](https://knowledge.acquiredigital.com/acquire-doohad?hsLang=en#doohad-standalone-installer-advert-configuration-tool) - [DooHad FAQs](https://knowledge.acquiredigital.com/acquire-doohad?hsLang=en#doohad-faqs) - [Acquire Vision User Guide](https://knowledge.acquiredigital.com/acquire-vision-user-guide?hsLang=en) - [Acquire StudioDX & Wayfinder Trial Install Guides](https://knowledge.acquiredigital.com/acquire-studiodx-wayfinder-trial-install-guides?hsLang=en#main-content) - [Acquire Wayfinder Trial](https://knowledge.acquiredigital.com/acquire-studiodx-wayfinder-trial-install-guides?hsLang=en#acquire-wayfinder-trial) - [Acquire StudioDX Trial Installation Guide](https://knowledge.acquiredigital.com/acquire-studiodx-wayfinder-trial-install-guides?hsLang=en#acquire-studiodx-trial-installation-guide) - [Acquire Assist](https://knowledge.acquiredigital.com/acquire-assist?hsLang=en) - [Acquire Premier](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#main-content) - [Quick Start Guide.](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#quick-start-guide) - [Acquire Editor User Guide](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#acquire-editor-user-guide) - [Toolbox](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#toolbox) - [The PLUS! Network](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#the-plus-network) - [Acquire Site Manager](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#acquire-site-manager) - [Apps & Helpers Manuals](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#apps-helpers-manuals) - [Minute Master-Classes](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#minute-master-classes) - [Acquire Editor FAQs](https://knowledge.acquiredigital.com/acquire-premier?hsLang=en#acquire-editor-faqs) - [Acquire Player FAQs](https://knowledge.acquiredigital.com/acquire-player-faqs?hsLang=en) - [Site Manager](https://knowledge.acquiredigital.com/site-manager?hsLang=en#main-content) - [Site Manager User Guide](https://knowledge.acquiredigital.com/site-manager?hsLang=en#site-manager-user-guide) - [Site Manager FAQs](https://knowledge.acquiredigital.com/site-manager?hsLang=en#site-manager-faqs) - [Watchdog](https://knowledge.acquiredigital.com/watchdog?hsLang=en#main-content) - [Watchdog User Guide](https://knowledge.acquiredigital.com/watchdog?hsLang=en#watchdog-user-guide) - [Watchdog FAQs](https://knowledge.acquiredigital.com/watchdog?hsLang=en#watchdog-faqs) - [FAQs](https://knowledge.acquiredigital.com/faqs?hsLang=en) [![acquire-digital-logo](https://knowledge.acquiredigital.com/hs-fs/hubfs/Property%201=No%20Trademark.png?width=50&height=50&name=Property%201=No%20Trademark.png "acquire-digital-logo")](http://acquiredigital.com) [mailto:email@email.com](mailto:email@email.com) Copyright © 2026, Acquire Digital