Interface: Configuration
Main configuration interface for MapVX SDK. Contains all configuration options for customizing the behavior and appearance of the MapVX map and navigation system.
Example
rut-modal
Properties
additionalAnalytics?
true
List of strings that identify additional analytics used.
Currently supported:
rut-modal: to show the rut modal on totems project.
Used only on totems project.
Example
default
baseUrl?
The base URL to use for creating URLs shown as QR codes on the route screen.
Used only on totems project.
Example
cityOptions?
List of city options to be used in the city filter on the website component project.
Example
contactInfo?
Contact info displayed with the parking feature.
Email to display with the phone
phone
Phone text to display
Whatsapp to display with the phone
Example
customMarkers?
Configuration for custom marker icons on the place map. When active, the marker URL is used as the default icon for places.
active
When true, the custom marker icon is used for places on the map
marker
URL of the SVG or image to use as the default place marker icon
Example
defaultLanguage
The two character valid code of the language to use as default. Must be one of the languages included in enabledLanguages.
Example
directionBtnText?
Parameter to control the text of the direction button
Example
enabledFloors
List of enabled floor identifiers. Only these floors will be available for navigation.
Example
enabledLanguages
A list of valid languages in their two character code form. The defaultLanguage must be included in this array.
Example
enableGPS?
Parameter that controls if the GPS floor selector should be shown.
When true, this also activates the rest of GPS functionalities.
Example
enableHover?
Parameter that controls if hover effects should be enabled. Enables interactive hover states for map elements.
Example
fitToRoute?
Parameter to control if the map should be fit to the route when the route is added.
Example
healthPingId?
ID for the health ping functionality. Used for monitoring and analytics purposes.
Example
initialBearing?
The initial bearing (rotation) of the map in degrees. 0 degrees points north, 90 degrees points east.
Used only on directory project.
Example
initialCenter?
The initial center coordinates to use on the map.
lat
lng
See
LatLng for coordinate structure
Example
initialPitch?
The initial pitch (tilt) of the map in degrees. 0 degrees is flat, higher values create a 3D perspective.
Example
initialZoom?
The initial zoom level to use on the map. Higher values indicate more zoomed in view.
Example
instructionDurationMs?
Parameter to control how long take the instruction to appear in screen
limitZoomIn?
Maximum zoom level allowed on the map. Prevents users from zooming in too close.
Example
limitZoomOut?
Minimum zoom level allowed on the map. Prevents users from zooming out too far.
Example
locationMarkerText?
Parameter to control the text of the location marker
Example
maintainAllPins?
Parameter to control if all pins should be maintained on the map when a pin is clicked.
Used only on directory project.
Example
mapRotations?
The rotation to use on the map. This dictionary is indexed by the id of the totem.
Used only on totems project.
Example
multiBuilding?
Parameter that controls if the mixed routing interface should be used. Enables routing between different buildings or areas.
Example
paddingToFit?
Parameter to control the padding when the map is fit to the route.
bottom
left
right
top
Example
parkingFeature?
Parameter to control if the parking feature would be visible by place Boolean parameter
Example
pitch?
Map pitch angle in degrees. Controls the 3D tilt of the map view.
Example
pointsOfInterest?
Points of interest for bounding box calculations. Used to define the area of interest for the map.
See
LatLng for coordinate structure
Example
potentialParentPlaces?
List of place IDs where mixed routing is allowed.
This permits creating routes between different parent places when their IDs are declared in this array.
Example
routeDrawing?
Object that contains custom configuration for drawing routes. Allows customization of route appearance and colors.
aheadColor?
Color for the ahead path (future route segments). Can be a HEX, rgb, or rgba string.
Example
behindColor?
Color for the behind path (completed route segments). Can be a HEX, rgb, or rgba string.
Example
Example
showAccessibleModeButton?
Parameter that controls if the accessible mode button should be shown on the sidebar.
Used only on totems project.
Example
showCarousel?
Parameter that controls if the place carousel should be shown at the bottom of the screen in horizontal view.
Used on directory project.
Example
showFloorAdvice?
Parameter to control if an advice is showed along with the floor selector
Example
showSearchBar?
Parameter that controls if the search bar should be shown on the home page.
Used only on totems project.
Example
splashScreen
Parameter that controls if the splash screen should be used. When true, displays a loading screen before the main interface.
Example
splashScreenUrls?
The URLs of images to use as the splash screen.
This object allows you to assign a custom image to each totem, identifying it by its id as a key, or
always having the default key to use otherwise.
Used only on totems project.
Index Signature
Custom splash screen images indexed by totem ID
default
Default splash screen image URL
Example
timeForHome?
The time in seconds to wait after showing the “still here” screen to make an automatic redirection.
The destination of the redirection is based on the splashScreen and splashScreenUrls parameters.
Used only on totems project.
Example
timeForStillHere?
The time in seconds to wait after the last interaction to show the “still here” screen.
Used only on totems project.
Example
welcomeMessage?
Welcome message configuration for the application.
logo?
Optional logo URL to display with the welcome message
text
Welcome message text to display