2021-06-15 00:28:59 +02:00
2021-04-17 11:37:22 +02:00
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.
2021-04-06 18:34:45 +02:00
2021-07-16 02:06:33 +02:00
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
2021-06-15 00:28:59 +02:00
----------------------
2021-06-08 17:00:54 +02:00
2021-07-16 02:06:33 +02:00
Whether or not the layer control is shown The default value is _false_
2021-04-06 18:34:45 +02:00
2021-07-16 02:06:33 +02:00
tab
2021-06-15 00:28:59 +02:00
-----
2021-04-17 11:37:22 +02:00
2021-07-16 02:06:33 +02:00
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_
2021-04-17 11:37:22 +02:00
2021-04-06 18:34:45 +02:00
2021-07-16 02:06:33 +02:00
z
2021-04-06 18:34:45 +02:00
---
2021-07-16 02:06:33 +02:00
The initial/current zoom level The default value is _14_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
lat
2021-04-06 18:34:45 +02:00
-----
2021-07-16 02:06:33 +02:00
The initial/current latitude The default value is _51.2095_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
lon
2021-04-06 18:34:45 +02:00
-----
2021-07-16 02:06:33 +02:00
The initial/current longitude of the app The default value is _3.2228_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
fs-userbadge
2021-04-06 18:34:45 +02:00
--------------
2021-07-16 02:06:33 +02:00
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_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
fs-search
2021-04-06 18:34:45 +02:00
-----------
2021-07-16 02:06:33 +02:00
Disables/Enables the search bar The default value is _true_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
fs-layers
2021-04-06 18:34:45 +02:00
-----------
2021-07-16 02:06:33 +02:00
Disables/Enables the layer control The default value is _true_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
fs-add-new
2021-04-06 18:34:45 +02:00
------------
2021-07-16 02:06:33 +02:00
Disables/Enables the 'add new feature'-popup. (A theme without presets might not have it in the first place) The default value is _true_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
fs-welcome-message
2021-04-06 18:34:45 +02:00
--------------------
2021-07-16 02:06:33 +02:00
Disables/enables the help menu or welcome message The default value is _true_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
fs-iframe
2021-04-06 18:34:45 +02:00
-----------
2021-07-16 02:06:33 +02:00
Disables/Enables the iframe-popup The default value is _false_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
fs-more-quests
2021-04-06 18:34:45 +02:00
----------------
2021-07-16 02:06:33 +02:00
Disables/Enables the 'More Quests'-tab in the welcome message The default value is _true_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
fs-share-screen
2021-04-06 18:34:45 +02:00
-----------------
2021-07-16 02:06:33 +02:00
Disables/Enables the 'Share-screen'-tab in the welcome message The default value is _true_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
fs-geolocation
2021-04-06 18:34:45 +02:00
----------------
2021-07-16 02:06:33 +02:00
Disables/Enables the geolocation button The default value is _true_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
fs-all-questions
2021-06-08 17:00:54 +02:00
------------------
2021-07-16 02:06:33 +02:00
Always show all questions The default value is _false_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
fs-export
-----------
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
If set, enables the 'download'-button to download everything as geojson The default value is _false_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
fake-user
-----------
2021-04-06 18:34:45 +02:00
2021-07-16 02:06:33 +02:00
If true, 'dryrun' mode is activated and a fake user account is loaded The default value is _false_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
debug
-------
2021-06-08 17:00:54 +02:00
2021-07-16 02:06:33 +02:00
If true, shows some extra debugging help such as all the available tags on every object The default value is _false_
2021-06-15 00:28:59 +02:00
2021-04-06 18:34:45 +02:00
2021-07-16 02:06:33 +02:00
custom-css
2021-04-06 18:34:45 +02:00
------------
2021-07-16 02:06:33 +02:00
If specified, the custom css from the given link will be loaded additionaly The default value is __
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
background
2021-06-15 00:28:59 +02:00
------------
2021-07-16 02:06:33 +02:00
The id of the background layer to start with The default value is _osm_
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
oauth_token
-------------
2021-06-15 00:28:59 +02:00
2021-07-16 02:06:33 +02:00
Used to complete the login No default value set
2021-06-15 00:28:59 +02:00
layer-< layer-id >
------------------
2021-06-16 17:21:37 +02:00
Wether or not the layer with id < layer-id > is shown The default value is _true_ Generated from QueryParameters
