---
title: Events
description: Events
---
[Skip to content](https://knowledge.acquiredigital.com/events#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)
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)
# Events
## You can subscribe to a variery of events that the wayfinder can generate allowing you to fully integrate with its actions.
The Wayfinder class exposes the usual addEventListener, and removeEventListener so that you can subscribe to events at the ‘root’ level. The defined events are as follows:
| **Event Name** | **Description** | **Event.detail** |
| --- | --- | --- |
| “*boundschanged*” | Dispatched whenever the minimum and maximum coordinates for the map changes. Usually triggered during load. | |
| “*error*” | Dispatched when map loading fails for whatever reason | *error message* |
| “*floorchange*” | Dispatched when the floor is about to change, during, and after it has changed | **status**: ‘*changing*’,’*loading*’,’*error*’, ‘*animating*’, ‘*changed*’ **id**: floorId **error**: error message or object (if error) |
| “*floorload*” | Dispatched in response to floor loading operations | **status**: ‘error’, ‘ready’, ‘loading’ **id**: floorId **error**: error message or object (if error) |
| “*loading*” | Dispatched when map loading starts, for example as a result to the call to loadFromApiKey | |
| “*loaded*” | Dispatched when the first floor (the one initially shown) has loaded and is now visible. All API commands are now available from this point. | |
| “*ready*” | Dispatched when everything has finished background-loading (all floors, icons and graphics) | |
| “*render*” | Dispatched each time the map is updated/redrawn (even panning the map will trigger this) | *timestamp in milliseconds* |
| “*resize*” | Dispatched when the Wayfinder DIV element resizes | {width, height} |
| “*mousedown*” ”*mousemove*” ”*mouseup*” ”*mousewheel*” | Triggered when the mouse goes down, moved, lifted up or wheeled on the map | **screen**: {x,y}, **map**: {x,y,z}, **obj**: {x,y,z}, *(added in 2.11.0)* **amenity**: null \| amenity, **destination**: null \| destination, **destinationLabel**: null \| destination, **transit**: null \| transit, **transitPopup**: null \| see below, **marker**: null \| marker, **button**: false/true, **wheel**: null/delta, **meshes**: \[\] - See below, **floor**: null \| number (Floor ID) **modifiers**: { ctrlKey: boolean, altKey: boolean, shiftKey: boolean } *(added in 2.12.0)* |
| “*routecleared*” | The route line (if any) has been cleared from the map | |
| “routedrawn” | A route line has been drawn on the map between two points | **status**: Route information **waypoints**: array of waypoints information, split by floor |
| “*routefailed*” | Route generation request failed | *Error information* |
| "mapapp" | A special "map has loaded" event generated when visiting the map app page and using the special [loadAsMapApp](https://app.clickup.com/2561453/v/dc/2e5dd-10408)function | **You must trigger the routing between the start and end positions, and popup information about the destination or amenity.** **unitId**: kiosk id this was sent from **ddaMode**: if kiosk was in accessible mode **startNodeId**: id of the starting node **startNode**: null \| node **endNodeId**: id of the ending node **endNode**: null \| node **destinationId**: id of the target destination **destination**: null \| destination **amenityId**: id of the target amenity **amenity**: null \| amenity **kioskSessionId**: An id the kiosk passed to track a session |
| "locationupdated" | When location services are enabled, this event will be emitted every time the location is updated | **timestamp**: milliseconds timestamp of the location update **inBounds**: boolean indicating if the point is within the map bounds **mapPoint**: null or X,Y coordinates of the location on the map **gpsPosition**: null or [GeolocationCoordinates](https://developer.mozilla.org/en-US/docs/Web/API/GeolocationCoordinates) of the location |
#### Meshes Array
The meshes array is directly from THREE.js. Its an array of objects containing, in depth order the meshes passed through. See [THREE.JS Raycaster.intersectObject](https://threejs.org/docs/#api/en/core/Raycaster.intersectObject) for more details.
#### transitPopup:
Contains the following inside the "detail"
| **Event Name** | **Description** | **Event.detail** |
| --- | --- | --- |
| follow() | function | Call to navigate to the next part of the route. This will switch maps if needed and pan/center on the next "leg" of the route |
| hide() | function | Hides the transit popup |
| leg | number | If the route is split between several maps, this indicates which "leg" of the journey it is |
| node | class | a [WayfinderNode](https://app.clickup.com/2561453/v/dc/2e5dd-10408/2e5dd-19568)where this is positioned |
| panToView | function | Centers the display on this popup |
| show | function | re-displays the prompt if hidden with hide() |
| targetMapId | number | ID of the map this will jump to |
| text | string | The text that is displayed in the prompt |
| travelType | function | the [WayfinderTravelType](https://app.clickup.com/2561453/v/dc/2e5dd-10408/2e5dd-19588) used for this |
- [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)
[](http://acquiredigital.com)
[mailto:email@email.com](mailto:email@email.com)
Copyright © 2026, Acquire Digital