midgard/mapcomplete
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
mapcomplete/Docs/URL_Parameters.md

9.7 KiB
Raw Blame History

URL-parameters and URL-hash

Table of contents

  1. 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.org/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.

The URL-hash can contain multiple values:

  • The id of the currently selected object, e.g. node/1234

  • The currently opened menu view

  • The base64-encoded JSON-file specifying a custom theme (only when loading)

Possible hashes to open a menu

The possible hashes are:

menu:about,menu:settings,menu:community,menu:privacy,menu:advanced

theme-menu:intro,theme-menu:filters,theme-menu:download,theme-menu:copyright,theme-menu:share

language

The language to display MapComplete in. The user display language is determined in the following order:

  1. Use the language as set by the URL-parameter language (following ISO 639-1 | ex. language=nl). This will disable setting the language by the user
  2. If the user did log in and did set their language before with MapComplete, use this language. This language selection is synchronized accross devices using the openstreetmap.org user preferences.
  3. If the user visited MapComplete before and did change their language manually, this changed language will be saved in local storage. Use the language from local storage
  4. Use the navigator-language (if available)
  5. Use English

Note that this URL-parameter is not added to the URL-bar by default. Note that the loading screen will always use the navigator language.

Translations are never complete. If a translation in a certain language is missing, English is used as fallback.

This documentation is defined in the source code at Locale.ts

No default value set

fs-translation-mode

If set, will show a translation button next to every string.

This documentation is defined in the source code at Locale.ts

The default value is false

backend

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

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is osm

fake-user

If true, 'dryrun' mode is activated and a fake user account is loaded

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is false

fs-enable-login

Disables/Enables logging in and thus disables editing all together. This effectively puts MapComplete into read-only mode.

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is true

fs-search

Disables/Enables the search bar

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is true

fs-background

Disables/Enables the background layer control

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is true

fs-filter

Disables/Enables the filter view

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is true

fs-welcome-message

Disables/enables the help menu or welcome message

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is true

fs-community-index

Disables/enables the button to get in touch with the community

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is true

fs-iframe-popout

Disables/Enables the extraLink button. By default, 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 or another extraLink button is enabled)

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is true

fs-more-quests

Disables/Enables the 'More Quests'-tab in the welcome message

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is true

fs-share-screen

Disables/Enables the 'Share-screen'-tab in the welcome message

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is true

fs-geolocation

Disables/Enables the geolocation button

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is true

fs-all-questions

Always show all questions

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is false

fs-export

Enable the export as GeoJSON and CSV button

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is true

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

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is false

debug

If true, shows some extra debugging help such as all the available tags on every object

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is false

overpassUrl

Point mapcomplete to a different overpass-instance. Example: https://overpass-api.de/api/interpreter

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is https://overpass-api.de/api/interpreter,https://overpass.kumi.systems/api/interpreter,https://overpass.openstreetmap.ru/cgi/interpreter

overpassTimeout

Set a different timeout (in seconds) for queries in overpass

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is 30

overpassMaxZoom

point to switch between OSM-api and overpass

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is 16

osmApiTileSize

Tilesize when the OSM-API is used to fetch data within a BBOX

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is 17

background

The id of the background layer to start with

This documentation is defined in the source code at FeatureSwitchState.ts

The default value is osm

layer-<layer-id>

Wether or not the layer with id is shown

This documentation is defined in the source code at QueryParameterDocumentation.ts

The default value is true

This document is autogenerated from src/Logic/Web/QueryParameters.ts, src/UI/QueryParameterDocumentation.ts