mapcomplete/Docs/URL_Parameters.md

URL-parameters and URL-hash

This document gives an overview of which URL-parameters can be used to influence MapComplete.

What is a URL parameter?

URL-parameters are extra parts of the URL used to set the state.

For example, if the url is https://mapcomplete.osm.be/cyclofix?lat=51.0&lon=4.3&z=5&test=true#node/1234, the URL-parameters are stated in the part between the ? and the #. There are multiple, all seperated by &, namely:

• The url-parameter lat is 51.0 in this instance
• The url-parameter lon is 4.3 in this instance
• The url-parameter z is 5 in this instance
• The url-parameter test is true in this instance

Finally, the URL-hash is the part after the #. It is node/1234 in this case.

backend

The OSM backend to use - can be used to redirect mapcomplete to the testing backend when using 'osm-test' The default value is osm

test

If true, 'dryrun' mode is activated. The app will behave as normal, except that changes to OSM will be printed onto the console instead of actually uploaded to osm.org The default value is false

layout

The layout to load into MapComplete The default value is __

userlayout

If not 'false', a custom (non-official) theme is loaded. This custom layout can be done in multiple ways:

• The hash of the URL contains a base64-encoded .json-file containing the theme definition
• The hash of the URL contains a lz-compressed .json-file, as generated by the custom theme generator
• The parameter itself is an URL, in which case that URL will be downloaded. It should point to a .json of a theme The default value is false

layer-control-toggle

Whether or not the layer control is shown The default value is false

tab

The tab that is shown in the welcome-message. 0 = the explanation of the theme,1 = OSM-credits, 2 = sharescreen, 3 = more themes, 4 = about mapcomplete (user must be logged in and have >50 changesets) The default value is 0

z

The initial/current zoom level The default value is 14

lat

The initial/current latitude The default value is 51.2095

lon

The initial/current longitude of the app The default value is 3.2228

fs-userbadge

Disables/Enables the user information pill (userbadge) at the top left. Disabling this disables logging in and thus disables editing all together, effectively putting MapComplete into read-only mode. The default value is true

fs-search

Disables/Enables the search bar The default value is true

fs-layers

Disables/Enables the layer control The default value is true

fs-add-new

Disables/Enables the 'add new feature'-popup. (A theme without presets might not have it in the first place) The default value is true

fs-welcome-message

Disables/enables the help menu or welcome message The default value is true

fs-iframe

Disables/Enables the iframe-popup The default value is false

fs-more-quests

Disables/Enables the 'More Quests'-tab in the welcome message The default value is true

fs-share-screen

Disables/Enables the 'Share-screen'-tab in the welcome message The default value is true

fs-geolocation

Disables/Enables the geolocation button The default value is true

fs-all-questions

Always show all questions The default value is false

fs-export

If set, enables the 'download'-button to download everything as geojson The default value is false

fake-user

If true, 'dryrun' mode is activated and a fake user account is loaded The default value is false

debug

If true, shows some extra debugging help such as all the available tags on every object The default value is false

custom-css

If specified, the custom css from the given link will be loaded additionaly The default value is __

background

The id of the background layer to start with The default value is osm

oauth_token

Used to complete the login No default value set layer-

Wether or not the layer with id is shown The default value is true Generated from QueryParameters