Appearance
Interface: initializeOptions
Deprecated
Use InitOptions. Will be removed in v5.0.0.
Extends
initializeOptions.SetOptions
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
accessKey? | string | Access key that is generated in hub for a property. This config field will be used only during the initialization - [[initialize]] | iframeIntializeOptions.accessKey | - |
boost? | Boost | - | - | SetOptions.boost |
coordsData? | CoordsData[] | - | - | SetOptions.coordsData |
defaultCustomRoutingConfig? | DefaultCustomRoutingConfig | Default custom routing options | - | SetOptions.defaultCustomRoutingConfig |
element? | string | HTMLElement | HTMLElement or queryString | - | iframeIntializeOptions.element |
entityData? | MapEntity[] | - | - | SetOptions.entityData |
entityDefaults? | MapEntity | - | - | SetOptions.entityDefaults |
features? | Partial<FeatureFlagSet> | - | - | SetOptions.features |
focus? | number | "property" | null | Focus mode for the map: - If "property" → initial focus will be at the property level - If a BuildingId (number) is passed → focus will go to that building level | - | SetOptions.focus |
idleTime? | number | Idle timeout delay in milliseconds | - | SetOptions.idleTime |
language? | string | To set the default language This config field will be used only during the initialization - [[initialize]] | iframeIntializeOptions.language | - |
loader? | "cube" | "rolling" | "spinner" | Loader that will be used in the map, the value should be from the above set of loader options else the default loader will be used. This config field will be used only during the initialization - [[initialize]] | - | SetOptions.loader |
mapOverlayMarkers? | MapOverlayMarker[] | Array of map overlay marker details | - | SetOptions.mapOverlayMarkers |
mapsDomain? | string | Map-backend origin. Fills the {#MAPSTED_MAPS_DOMAIN#} token in IFRAME_URL. Optional: when omitted and the token was not substituted server-side (CDN mode) — e.g. a static/self-hosted bundle — the factory defaults the token to DEFAULT_MAPS_ORIGIN so init({ propertyId }) still renders. In CDN mode the Express origin substitutes it server-side. | - | iframeIntializeOptions.mapsDomain |
onload? | () => void | Function is run once the map is loaded | - | - |
propertyId? | string | number | Property id (npm mode). Fills the {#MAPSTED_PROPERTY_KEY#} token in IFRAME_URL. Omitted in CDN mode (substituted server-side from ?id=). | - | iframeIntializeOptions.propertyId |
shareUrl? | string | Custom url that will used while creating links to share entities and routes e.g. if https://your.domain/deeplink/<app name> is set then entity selection share link will be generated as: https://your.domain/deeplink/<app name>/map/select?property=95&building=95&floor=184&entity=81 By following this URL structure [https://your.domain/deeplink/<app name>], the Mapsted mobile application will be able to properly handle deep links and provide a seamless user experience | - | SetOptions.shareUrl |