Interface: MapConfig
Basic configuration for the map. Provides essential settings for initializing and customizing map behavior.
Example
string
Properties
authToken?
void
(Optional) Authentication token for accessing protected map resources. Required for loading map related data from Portal.
bearingSnap?
void
(Optional) The bearing snap threshold in degrees.
center
string
The initial center coordinates of the map.
enableHover?
void
(Optional) Whether to enable hover interactions on the map.
institutionId?
number
(Optional) The institution identifier for map context. Required for loading map related data from Portal.
lang?
void
(Optional) Language code for map labels and UI.
maxBounds?
number
(Optional) Array of coordinates defining the maximum bounds of the map.
maxZoom?
void
(Optional) Maximum allowed zoom level.
minZoom?
(Optional) Minimum allowed zoom level.
navigationPosition?
(Optional) Position of the navigation controls on the map.
onFloorChange()?
(Optional) Callback invoked when the floor changes. Receives the new floor ID.
Parameters
newFloorId
string
Returns
void
onMapReady()?
(Optional) Callback invoked when the map is ready.
Returns
void
onParentPlaceChange()?
(Optional) Callback invoked when the parent place changes. Receives the new parent place ID.
Parameters
newParentPlaceId
string
Returns
void
onRotate()?
(Optional) Callback invoked when the map is rotated. Receives the rotation in degrees.
Parameters
degrees
number
Returns
void
onZoomEnd()?
(Optional) Callback invoked when the zoom operation ends. Receives the new zoom level.
Parameters
zoomLvl?
number
Returns
void
otherPotentialParentPlacesIds?
(Optional) List of alternative parent place IDs.
parentPlaceId?
(Optional) The ID of the parent place to display.
pitch?
(Optional) The pitch (tilt) of the map in degrees.
showCompass?
(Optional) Whether to display the compass control.
showZoom?
(Optional) Whether to display the zoom control.
tileCache?
Tile cache configuration options Controls how map tiles are cached in memory and persisted
See
MapTileCacheConfig for available options
zoom
The initial zoom level of the map.