--- title: Wayfinder Settings Class description: Wayfinder Settings Class --- [Skip to content](https://knowledge.acquiredigital.com/wayfinder-web-api-reference#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 Settings Class ## ontains all of the current settings used by the wayfinder. The only property that you can actively change while loaded is the language. With properties, (r) means read only, (r/w) means read/write. **Most of these properties match the fields in the initial settings supplied** while constructing the class. | background | property (r) | An object containing: { *color* : {*r*, *g*, *b*}, *url*: '' } | | --- | --- | --- | | destinations | property (r) | An object containing the default hover and selected destination colours: { hover: {*r*, *g*, *b*}, selected: {*r*, *g*, *b*} } | | icons | property (r) | An object containing icon (eg: amenity) size information: { scale, minSize, maxSize, inFrontOfFloatingLabels, combineWithFloatingLabels, transitIconsHavePriority, fadeTime, overlapMargin } | | idleMapAngle | property (r) | **float**: Map rotational angle to use at the start | | idleMapTilt | property (r) | **float**: Map tilt to use at the start and after routes are cleared | | inPerspectiveMode | property (r) | **bool**: set to true if the map should start in perspective mode | | labels | property (r) | How labels should appear on the map: { style : { fontName, sizeInPx, alignment, weight }, color : { r, g, b }, hover : { r, g, b }, selected : { r, g, b }, shadowColor : { r, g, b }, shadowHover : { r, g, b }, shadowSelected : { r, g, b }, shadowDistance, shadowSize, float: {     enabled,     font: { name, size, weight, alignment },     overlapMargin,     stopAfterClashCount,     prioritizeByLabelSize,     centerOnLabel,     showLabelOnFlagship,     dots : { enabled, color, shadow, useLabelColor, shadowSize, shadowDistance }}} | | language | property (r/w) | **string**: The current language being used by the wayfinder. | | mapLighting | property (r) | Lighting rules for the 3D render: { light1 : { position, lookat, color, strength, castshadow },     light2 : { position, lookat, color, strength, castshadow },     ambient : { color: { r, g, b } },     hemisphere : { groundcolor: { r, g, b }, skycolor: { r, g, b }, strength }, yahPoint : {         color: { r : 0x22, g : 0x22, b : 0x22 },         exp, linear, zposition, strength },     rotateLights, enableSpecular, shadowBias } | | maxZoomLevel | property (r) | **float**: Max zoom property (same as kiosk) | | mapScaleFactor | property(r) | **float**: a number to convert coordinates into meters. You should not need to use this | | positionChangeTime | property(r) | **integer:** Number of milliseconds defining the camera movement duration. | | renderShadows | property (r) | **bool**: If shadows will be rendered on the map | | routeAnimation | property (r) | How the route line should be drawn: { color, color2, size, yPosition } | | routeMapTilt | property (r) | **float**: Map tilt to use while route is active (default) | | routeByDistance | property(r) | **bool:** If routes generated are by shortest distance (true) or quickest time (false) - this can be overridden when requesting a route | | scaleChangeTime | property (r) | **integer**: Number of milliseconds to change map scale while loading (animation) | | screenPadding | property (r) | **integer**: Pixel border size to fit bounds within | | shouldZoomToRoute | property (r) | **bool**: If when routing, the map should zoom to fit the route | | startingFloorId | property (r) | **integer**: The primary map to show | | timezone | property (r) | **string:** The timezone of the destination of the project | | transitionTime | property (r) | **integer**: Time taken by default for all animations | | transitPopup | property (r) | How popups should appear advising how to change to another floor/map: { font : { fontName, sizeInPx, weight }, colors : { background: { r, g, b }, text: { r, g, b }, border: { r, g, b }, arrow: { r, g, b }, shadow: { r, g, b }, }, borderRadius, borderWidth, shadowSize, shadowDistanceX, shadowDistanceY, shadowAlpha } | | useAntialiasing | property (r) | **bool**: If antialiasing is enabled during render | | useLowerQuality | property (r) | **bool**: If lower quality (less resource intensive) methods should be used. |   - [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