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:

`accountId`

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.

`deepLinkParms`

Please see all available options in Deep Linking.

`defaultSearchTerms`

Please see Search Defaults.

`desktopViewMinWidth`

The minimum width before using the desktop layout.

`headLess`

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.

`initState`

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.

`name`

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

`poiCategories`

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

`preserveStateInURL`

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

`supportURLDeepLinks`

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

`theme`

Allows specification of custom map colors. See UI Customization.

`uiHide`

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

`noLangOptions`

Allows specification of if the user should be able to control the UI's language/localization from within the map experience.

Type: boolean

Default: false

`pinnedLocation`

Allows specification of a static location that should be pinned/represented by a blue dot when the map loads.

Type: object

Default: null

Example:

{
	pinTitle: 'You Are Here',
  lat: 00.00000000,
  lng: -00.00000000,
  ordinal: 0,
  structureId: 'my-structure-id',
  floorId: 'my-floor-id'
}

`pinnedLocationZoom`

The zoom level to use when focusing on the pinned location

Type: number

Range: 0 - 24

`pinnedLocationFocusAtStart`

A flag which determines if the map should zoom and pan to the pinned location on map start

Type: boolean

Default: true

`venueId`

The venue ID you wish the map to render.