---
title: Settings API Reference
description: Settings API Reference
---
[Skip to content](https://knowledge.acquiredigital.com/settings-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)
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 Directory API V1.0](https://knowledge.acquiredigital.com/acquire-wayfinder?hsLang=en#js-web-directory-api-v1-0)
# Settings API Reference
## Optional Settings
All settings, and indeed the entire settings object, are optional.
**Selected Categories**
For v1.0.0 of the Embedded Web Directory, categories that are shown may only be customised using the category IDs, not by name (These should be requested from Acquire Digital as required).
**Type:** Array.
Pass an array of category IDs for parent categories that you *wish to show.*
This setting can also be used in combination with `excludedSubcategories` to show only a single subcategory. To achieve this, pass the parent category that it belongs to, then use the `excludedSubcategories` setting to exclude everything except the subcategory you wish to show.
**Default Behaviour**
Without this setting (or also if you pass an *empty array*), all categories and their destinations will be shown in the component.
**Key:** `"selectedCategories"`
**Example Value:** `[12, 11, 10]`
**Excluded Subcategories**
**ype:** Array.
Pass an array of subcategory IDs that you *do not wish to show.*
**Default Behaviour**
Without this setting, all subcategories and their destinations will be shown in the component.
**Key:** `"excludedSubcategories"`
**Example Value:** `[10, 20, 30, 40, 50]`
**Show Empty Categories**
**Type:** Boolean.
Pass a boolean to tell the component whether or not to show categories that do not have any destinations.
**Default Behaviour**
Without this setting, the default behaviour is equivalent to passing `false` - empty categories will not be shown.
**Key:** `"showEmptyCategories"`
**Example Value:** true
**Map URL**
**Type:** String.
Pass the URL of the page of your website where the Wayfinder web map is embedded. This URL will be used for the 'View on map' link on the destination view.
**Default Behaviour**
Without this setting the view on map link will not render on the destination view.
**Key:** `"mapUrl"`
**Example Value:** `https://www.example.com`
**Twenty Four Hour Time Format**
**Type:** Boolean.
Pass a boolean to tell the component whether or not to show opening times in the card headers in 24 hour format.
**Default Behaviour**
Without this setting, the default behaviour is equivalent to passing `false` - times will be shown in 12 hour format e.g. **2:00PM** instead of **14:00**.
**Key:** `"twentyFourHourTimeFormat"`
**Example Value:** true
**Buildings Filter Default Option**
**Type:** String.
Pass the text you would like to show as the default option in the buildings filter.
**Default Behaviour**
Without this setting the default value `Show All` will be used.
**Key:** `"buildingsFilterDefaultOption"`
**Example Value:** `Show All`
**Buildings Filter Default Label**
**Type:** String.
Pass the text you would like to show as the label for the buildings filter.
**Default Behaviour**
Without this setting the default value `Filter by Level` will be used.
**Key:** `"buildingsFilterDefaultLabel"`
**Example Value:** `Filter by Level`
**Scroll Behavior**
**ype:** String.
`"smooth"` or `"instant"` or `"auto"`
The behaviour of programmatic scrolls. Consistent with [window.scrollTo behaviour options](https://developer.mozilla.org/en-US/docs/Web/API/Window/scrollTo#behavior).
**Default Behaviour**
To preserve backward-compatibility, the default is `smooth` .
**Key:** `"scrollBehavior"` NOTE: Spelling is american for consistency with web standards.
- [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