SDK Configuration

When creating a new map in the SDK, you must pass in a configuration object containing several properties that defines which map you wish to render, how how you wish to render it. The available configuration properties are listed below:



This is the customer account against which you wish to display a map. Each account is associated with a list of 1 or more venues that it is authorized to display.



Please see all available options in Deep Linking.



Please see Search Defaults.



The minimum width before using the desktop layout.



If set to true, the map will not render any visual at all. This is used for data query only. A small subset of commands are available in headless mode - see Commands ] for details.



Defines the initial state for the map via a "state string". This string is an encoded representation of map state which you can obtain via a map.getState() call.



The name you wish to give to this map instance. It is mostly for "internal use".



A list of search categories or terms that will be displayed on the sidebar while not in use. Please see Custom Actions.



If true, causes the url to include an identifier representing the current location and zoom of the map.



If true, allows deep links params to be passed in along with the map url. See Deep Linking.



Allows specification of custom map colors. See UI Customization.



Allows specified UI elements to be hidden e.g.:
"uiHide": { sidebar: true, controls: false, levelSelector: true }



The venue ID you wish the map to render.