mapcomplete/Docs/URL_Parameters.md

183 lines
4 KiB
Markdown
Raw Normal View History

2021-11-07 17:18:10 +01: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.
2021-11-07 17:18:10 +01:00
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 separated 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-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-userbadge
2021-04-06 18:34:45 +02:00
--------------
2021-11-07 17:18:10 +01: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-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-search
2021-04-06 18:34:45 +02:00
-----------
2021-11-07 17:18:10 +01:00
Disables/Enables the search bar The default value is _true_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-background
---------------
2021-04-06 18:34:45 +02:00
2021-11-07 17:18:10 +01:00
Disables/Enables the background layer control The default value is _true_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-filter
-----------
2021-11-07 17:18:10 +01:00
Disables/Enables the filter The default value is _true_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-add-new
2021-04-06 18:34:45 +02:00
------------
2021-11-07 17:18:10 +01: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-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-welcome-message
2021-04-06 18:34:45 +02:00
--------------------
2021-11-07 17:18:10 +01:00
Disables/enables the help menu or welcome message The default value is _true_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-iframe-popout
2021-10-28 03:21:17 +02:00
------------------
2021-04-06 18:34:45 +02:00
2021-11-07 17:18:10 +01:00
Disables/Enables the iframe-popout button. If in iframe mode and the welcome message is hidden, a popout button to the full mapcomplete instance is shown instead (unless disabled with this switch) The default value is _true_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-more-quests
2021-04-06 18:34:45 +02:00
----------------
2021-11-07 17:18:10 +01:00
Disables/Enables the 'More Quests'-tab in the welcome message The default value is _true_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-share-screen
2021-04-06 18:34:45 +02:00
-----------------
2021-11-07 17:18:10 +01:00
Disables/Enables the 'Share-screen'-tab in the welcome message The default value is _true_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-geolocation
2021-04-06 18:34:45 +02:00
----------------
2021-11-07 17:18:10 +01:00
Disables/Enables the geolocation button The default value is _true_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-all-questions
2021-06-08 17:00:54 +02:00
------------------
2021-11-07 17:18:10 +01:00
Always show all questions The default value is _false_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-export
-----------
2021-11-07 17:18:10 +01:00
Enable the export as GeoJSON and CSV button The default value is _false_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fs-pdf
--------
2021-11-07 17:18:10 +01:00
Enable the PDF download button The default value is _false_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
backend
2021-10-28 03:21:17 +02:00
---------
2021-11-07 17:18:10 +01:00
The OSM backend to use - can be used to redirect mapcomplete to the testing backend when using 'osm-test' The default value is _osm_
2021-10-28 03:21:17 +02:00
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
test
2021-07-24 02:42:37 +02:00
------
2021-11-07 17:18:10 +01:00
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_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
debug
-------
2021-06-08 17:00:54 +02:00
2021-11-07 17:18:10 +01:00
If true, shows some extra debugging help such as all the available tags on every object The default value is _false_
2021-04-06 18:34:45 +02:00
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
fake-user
-----------
2021-11-07 17:18:10 +01:00
If true, 'dryrun' mode is activated and a fake user account is loaded The default value is _false_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
overpassUrl
2021-09-09 00:30:48 +02:00
-------------
2021-11-07 17:18:10 +01:00
Point mapcomplete to a different overpass-instance. Example: https://overpass-api.de/api/interpreter The default value is _https://overpass-api.de/api/interpreter,https://overpass.kumi.systems/api/interpreter,https://overpass.openstreetmap.ru/cgi/interpreter_
2021-09-09 00:30:48 +02:00
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
overpassTimeout
2021-09-09 00:30:48 +02:00
-----------------
2021-11-07 17:18:10 +01:00
Set a different timeout (in seconds) for queries in overpass The default value is _30_
2021-09-09 00:30:48 +02:00
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
overpassMaxZoom
2021-10-28 03:21:17 +02:00
-----------------
2021-11-07 17:18:10 +01:00
point to switch between OSM-api and overpass The default value is _17_
2021-10-28 03:21:17 +02:00
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
osmApiTileSize
2021-10-28 03:21:17 +02:00
----------------
2021-11-07 17:18:10 +01:00
Tilesize when the OSM-API is used to fetch data within a BBOX The default value is _18_
2021-07-24 02:42:37 +02:00
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
background
2021-07-24 02:42:37 +02:00
------------
2021-11-07 17:18:10 +01:00
The id of the background layer to start with The default value is _osm_
2021-11-08 02:36:01 +01:00
2021-11-07 17:18:10 +01:00
layer-<layer-id>
------------------
2021-11-08 02:36:01 +01:00
Wether or not the layer with id <layer-id> is shown The default value is _true_
This document is autogenerated from QueryParameters