--- title: ACQ Class description: ACQ Class --- [Skip to content](https://knowledge.acquiredigital.com/acq-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. [Wayfinder Map API](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#wayfinder-map-api) # ACQ Class ## The Wayfinder Web application is all contained withing the ACQ class. All other classes, methods and functions can be called once the ACQ class has been initialised. ### Init `ACQ.init(canvas_div, settings, *callback*)` #### **Parameters**: - canvas\_div: HTMLElement - settings: Object (see below) - callback: function (optional) Initialises Wayfinder Web, validates the passed **`api_key`**, downloads the required files, creates a new canvas inside the specified **`div`** and draws the 3D map to that space. If you're yet to setup and API key, see [Get API Key](https://www.notion.so/Get-Your-API-Key-e497d824fa7348b19757150c6eee72fc) for more information. The settings object can contain any of the following properties to override some of the defaults within the maps. If you omit a field then a default value or colour will be chosen: ``` { apiKey: "your-key-here", controls: "default", disableUnusedMeshes:true, startupMapId: 120, detectQueryString: true, routeShowDestination: true, text:{ route: { notfound: 'Use Caution – No Walkable Route', notrequired: 'No route required', notavailable: 'Route could not be created' }, ui: { from: 'From', to: 'To', accessibleRouting: 'Accessible Routing', near: 'Near:', categories: 'Categories', amenities: 'Amenities', selectDestination: 'Select a destination...', noMatchesFound: 'No matches found' } }, map:{ shadows: true, lowerQuality: false, antialiasing: true, tilt: 45, angle: 45, perspective: true, popupInfo: true, zoomToRoute: false, routeTilt: 80, transitionTime: 500, initialZoomMode: 0, background: { color: { r: 255,g: 255,b: 255 } }, routeHandoffStartIcon : { visible: true, size: null, url: "" }, icon: { scale: 5 }, label:{ style: { fontName: 'arial', sizeInPx: 30, padding: 10, alignment: 'center' }, color: { r: 255,g: 0,b: 0 }, hover: { r:0,g:255,b:255 }, selected: { r:255,g:255,b:0 } }, destinations: { hover: { r:0, g:255,b:255 }, selected: { r:0, g:0,b:255 } }, routeLine : { color: { r: 255, g: 255, b: 255 }, size: 0.25 }, routeDot: { color: { r: 0, g: 0, b: 0 }, size: 0.3 } }, autoCloseOnRoute:true, dontLoadCSS:false} ``` **See Init() Settings below for more information.**   Any fields not specified above will go to defaults (which is what the above are) **Colors:** You can specify as {r:0, g:0, b:0} (and the numbers are between 0 and 255) or '#000000' **label style:** Padding is in pixels, as is the font size. You must ensure that any font you use is available and loaded (if not a standard web font) BEFORE you call ACQ.init(). If you load a custom font, the name field will be from your CSS file. #### **Events**   #### **ready** This event is fired when the first map at the site has loaded successfully and is ready to be manipulated. This event *must* be setup *before* you call init() For example: ``` ACQ.addEventListener("ready", function() { console.log("READY FIRED!");}) ```   #### **error** This event is fired if for some reason the map rendering or loading did not complete successfully.the first map at the site has loaded successfully and is ready to be manipulated. This event *must* be setup *before* you call init() For example: ``` ACQ.addEventListener("error", function(e) { console.log("Map load error: " + e.detail);}) ``` - [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