Properties
Properties control the behavior and appearance of the embedded iframes — such as setting the default terrain, preferred language, measurement units, map controls, and other user interface options.
Most properties are defined at the organization level to establish consistent defaults across all embedded iframes. These organization-level properties are configured collaboratively between your team and the Mountaya team.
You can override these organization-level properties on a per-iframe basis, allowing for customization as needed for specific use cases.
All properties (except for view) are specified as URL query parameters. These are added after the ? symbol and can be combined using the & symbol. The view property, however, is set as a URL fragment (following the # symbol) and must be placed after the query parameters.
For example:
/studio/embed?with_activeroute_elevation=true#view=10.93/45.8793/6.939/171.3/51Unlike safety rules, which impose strict limits, properties function as configuration presets. They allow flexibility while ensuring 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.
Kind: URL query parameter (?)
Key:
organization_idType:
uuidExample:
/studio/embed?organization_id=2517fcb5-ac6b-4763-9546-f49c926b0d44Optional properties
Map's default state
Fetches the drawings and routes of a collection. Displays the collection's drawings if with_collection_drawings is enabled. Displays the collections' routes if with_collection_routes is enabled.
Required if activeroute_id is defined.
To display a single route of a collection and automatically select it, disable the property with_collection_routes and set activeroute_id like this:
/studio/embed?with_collection_routes=false&collection_id=uuid&activeroute_id=uuidKind: URL query parameter (?)
Key:
collection_idType:
uuidExample:
/studio/embed?collection_id=78ea01f3-8256-4925-9a02-44d3eadc3980Sets the default active overlay. The string corresponds to a supported overlay.
Kind: URL query parameter (?)
Key:
overlayType:
stringSupported overlays:
"aspectslope"
"avalanche"
"hillshade"
"humidity"
"pois"
"snowdepth"
"snowfall-daily"
"snowfall-hourly"
"temperature-actual"
"temperature-perceived"
"temperature-soil"
"visibility"
"wind"Example:
/studio/embed?overlay=temperature-perceivedSets the default active route, which lets users access the route's elevation profile and characteristics. The route must be present in the collection defined in collection_id.
The route will be displayed even if the property with_collection_routes is disabled: this allows to display this specific route only and not all routes present in the collection.
Kind: URL query parameter (?)
Key:
activeroute_idType:
uuidExample:
/studio/embed?collection_id=78ea01f3-8256-4925-9a02-44d3eadc3980&activeroute_id=d60fdb18-ec52-490c-9a89-f781ae113cc8Sets the default terrain. The string corresponds to a supported terrain.
Kind: URL query parameter (?)
Key:
terrainType:
stringSupported terrains:
"satellite"
"topo"
"winter"Example:
/studio/embed?terrain=satelliteSets the default map's position using zoom, center latitude, center longitude, bearing, and pitch. In the example below, this corresponds to zoom 10.93, center latitude 45.8793, center longitude 6.939, bearing 171.3, and pitch 51.
Kind: URL fragment (#)
Key:
viewType:
string (zoom/latitude/longitude/bearing/pitch)Example:
/studio/embed#view=10.93/45.8793/6.939/171.3/51Custom user experience
Sets the language. This preference can not be changed by the user via the "Preferences" panel.
Kind: URL query parameter (?)
Key:
preferred_languageType:
stringSupported languages:
"en"
"fr"Example:
/studio/embed?preferred_language=enSets the theme. This preference can not be changed by the user via the "Preferences" panel.
Kind: URL query parameter (?)
Key:
preferred_themeType:
stringSupported themes:
"auto"
"dark"
"light"Example:
/studio/embed?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.
Kind: URL query parameter (?)
Key:
preferred_unit_lengthType:
stringSupported units of length:
"metric"
"imperial"Example:
/studio/embed?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.
Kind: URL query parameter (?)
Key:
preferred_unit_temperatureType:
stringSupported units of temperature:
"celsius"
"fahrenheit"Example:
/studio/embed?preferred_unit_temperature=celsiusSets the terrain appearance to better represent different conditions such as day or night environments.
Kind: URL query parameter (?)
Key:
terrain_variantType:
stringSupported terrain variants:
"light"
"dark"Example:
/studio/embed?terrain_variant=darkEnables the characteristics of the active route.
Kind: URL query parameter (?)
Key:
with_activeroute_characteristicsType:
booleanExample:
/studio/embed?with_activeroute_characteristics=trueEnables the elevation profile of the active route.
Kind: URL query parameter (?)
Key:
with_activeroute_elevationType:
booleanExample:
/studio/embed?with_activeroute_elevation=trueEnables the summary of the active route in the iframe header.
Kind: URL query parameter (?)
Key:
with_activeroute_summaryType:
booleanExample:
/studio/embed?with_activeroute_summary=trueEnables the display of drawings present in the collection passed via collection_id.
Kind: URL query parameter (?)
Key:
with_collection_drawingsType:
booleanExample:
/studio/embed?with_collection_drawings=trueEnables the display of routes present in the collection passed via collection_id. This doesn't apply to the activeroute_id passed, which is always displayed (if any).
Kind: URL query parameter (?)
Key:
with_collection_routesType:
booleanExample:
/studio/embed?with_collection_routes=trueEnables map interactivity, allowing users to zoom, pan within the defined boundaries, adjust pitch, and explore the map freely.
Kind: URL query parameter (?)
Key:
with_interaction_controlType:
booleanExample:
/studio/embed?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.
Kind: URL query parameter (?)
Key:
with_navigation_controlType:
booleanExample:
/studio/embed?with_navigation_control=trueEnables specific overlays so the user can switch from one overlay to another. 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.
Kind: URL query parameter (?)
Key:
with_overlaysType:
string[] | ["*"]Supported overlays:
"aspectslope"
"avalanche"
"hillshade"
"humidity"
"pois"
"snowdepth"
"snowfall-daily"
"snowfall-hourly"
"temperature-actual"
"temperature-perceived"
"temperature-soil"
"visibility"
"wind"Example:
/studio/embed?with_overlays=temperature-perceived&with_overlays=snowdepthEnables the history and forecast layer control.
Kind: URL query parameter (?)
Key:
with_overlays_controlType:
booleanExample:
/studio/embed?with_overlays_control=trueEnables the "Preferences" panel at the bottom-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.
Kind: URL query parameter (?)
Key:
with_preferences_controlType:
booleanExample:
/studio/embed?with_preferences_control=trueEnables the scale control at the bottom-left of the map.
Kind: URL query parameter (?)
Key:
with_scale_controlType:
booleanExample:
/studio/embed?with_scale_control=trueEnables specific terrains so the user can switch from one terrain to another. 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.
Kind: URL query parameter (?)
Key:
with_terrainsType:
string[] | ["*"]Supported terrains:
"satellite"
"topo"
"winter"Example:
/studio/embed?with_terrains=satellite&with_terrains=winter