Properties
Properties control the behavior of your embedded iframes — for example, setting the preferred language, measurement units, map controls, or user interface options.
All properties are defined at the organization level to establish consistent defaults across all embedded iframes. Properties at the organization level are configured collaboratively by your organization and the Mountaya team.
They can be overridden on a per-iframe basis via the HTTP query parameters in the iframe URL (after the ? symbol) and can be combined using &. For example:
/explore?with_activeroute_elevation=true&with_activeroute_pois=trueUnlike safety rules, which enforce strict limits, properties act as configuration presets. They provide flexibility while maintaining a consistent user experience across your organization.
Required properties
Authenticate the iframe using the organization identifier given by the Mountaya team. Internally, this is used in tandem with boundaries and domains set in safety rules to help us preventing excessive or unintended usage.
Key:
organization_idType:
string (uuid)Example:
/explore?organization_id=2517fcb5-ac6b-4763-9546-f49c926b0d44Optional properties
Sets the language. This preference can not be changed by the user via the "Preferences" panel.
Key:
preferred_languageType:
stringSupported languages:
"en"
"fr"Example:
/explore?preferred_language=enSets the theme. This preference can not be changed by the user via the "Preferences" panel.
Key:
preferred_themeType:
stringSupported themes:
"auto"
"dark"
"light"Example:
/explore?preferred_theme=darkSets the unit of length. This preference can be changed by the user via the "Preferences" panel, if the panel is enabled via with_preferences_control. When changed by the user, the preferred unit of length is changed across all iframes of the user's session, overriding this property.
Key:
preferred_unit_lengthType:
stringSupported units of length:
"metric"
"imperial"Example:
/explore?preferred_unit_length=metricSets the unit of temperature. This preference can be changed by the user via the "Preferences" panel, if the panel is enabled via with_preferences_control. When changed by the user, the preferred unit of temperature is changed across all iframes of the user's session, overriding this property.
Key:
preferred_unit_temperatureType:
stringSupported units of temperature:
"celsius"
"fahrenheit"Example:
/explore?preferred_unit_temperature=celsiusEnables the "Characteristics" tab in the "Active route" panel.
Key:
with_activeroute_characteristicsType:
booleanExample:
/explore?with_activeroute_characteristics=trueEnables the "Description" tab in the "Active route" panel.
Key:
with_activeroute_descriptionType:
booleanExample:
/explore?with_activeroute_description=trueEnables the "Elevation" tab in the "Active route" panel.
Key:
with_activeroute_elevationType:
booleanExample:
/explore?with_activeroute_elevation=trueEnables the "Photos" tab in the "Active route" panel.
Key:
with_activeroute_photosType:
booleanExample:
/explore?with_activeroute_photos=trueEnables the "POIs" (Points of Interest) tab in the "Active route" panel and displays them on the map.
Key:
with_activeroute_poisType:
booleanExample:
/explore?with_activeroute_pois=trueEnables the display on the map of drawings present in the collection passed in the state via collection_id.
Key:
with_collection_drawingsType:
booleanExample:
/explore?with_collection_drawings=trueEnables the display on the map of routes present in the collection passed in the state via collection_id. This doesn't apply to the route_id passed in the state, which is always displayed (if any).
Key:
with_collection_routesType:
booleanExample:
/explore?with_collection_routes=trueEnables map interactivity, allowing users to zoom, pan within the defined boundaries, adjust pitch, and explore the map freely.
Key:
with_interaction_controlType:
booleanExample:
/explore?with_interaction_control=trueEnables the zoom and bearing icons at the top-right of the map. Disabled if with_interaction_control is disabled as well.
Key:
with_navigation_controlType:
booleanExample:
/explore?with_navigation_control=trueEnables specific overlays so the user can switch from one overlay to another in the "Layers" panel on the top-right of the map. Each string corresponds to a supported overlay. A wildcard as first and unique item enables all overlays. If both with_overlays and with_terrains are empty or "null", the "Layers" panel is hidden.
Key:
with_overlaysType:
string[] | ["*"]Supported overlays:
"aspectslope"
"avalanche"
"hillshade"
"humidity"
"landcover"
"snowdepth"
"snowfall-daily"
"snowfall-hourly"
"temperature-actual"
"temperature-perceived"
"temperature-soil"
"visibility"
"wind"Example:
/explore?with_overlays=temperature-perceived&with_overlays=snowdepthEnables the history and forecast layer control.
Key:
with_overlays_controlType:
booleanExample:
/explore?with_overlays_control=trueEnables the "Preferences" panel at the top-right of the map, allowing users to set their preferred unit of length and unit of temperature, overriding preferred_unit_length and preferred_unit_temperature across all iframes of the user's session.
Key:
with_preferences_controlType:
booleanExample:
/explore?with_preferences_control=trueEnables the scale control at the bottom-right of the map.
Key:
with_scale_controlType:
booleanExample:
/explore?with_scale_control=trueEnables specific terrains so the user can switch from one terrain to another in the "Layers" panel on the top-right of the map. Each string corresponds to a supported terrain. A wildcard as first and unique item enables all terrains. If both with_overlays and with_terrains are empty or "null", the "Layers" panel is hidden.
Key:
with_terrainsType:
string[] | ["*"]Supported terrains:
"satellite"
"topo"
"winter"Example:
/explore?with_terrains=satellite&with_terrains=winter