[//]: # (WARNING: this file is automatically generated. Please find the sources at the bottom and edit those sources) URL-parameters and URL-hash ============================= ## Table of contents 1. [URL-parameters and URL-hash](#url-parameters-and-url-hash) - [What is a URL parameter?](#what-is-a-url-parameter) - [language](#language) - [fs-translation-mode](#fs-translation-mode) - [fake-user](#fake-user) - [fs-enable-login](#fs-enable-login) - [fs-search](#fs-search) - [fs-background](#fs-background) - [fs-filter](#fs-filter) - [fs-welcome-message](#fs-welcome-message) - [fs-community-index](#fs-community-index) - [fs-iframe-popout](#fs-iframe-popout) - [fs-more-quests](#fs-more-quests) - [fs-share-screen](#fs-share-screen) - [fs-geolocation](#fs-geolocation) - [fs-all-questions](#fs-all-questions) - [fs-export](#fs-export) - [test](#test) - [debug](#debug) - [overpassUrl](#overpassurl) - [overpassTimeout](#overpasstimeout) - [overpassMaxZoom](#overpassmaxzoom) - [osmApiTileSize](#osmapitilesize) - [background](#background) - [z](#z) - [lat](#lat) - [lon](#lon) - [oauth_token](#oauth_token) - [layer-public_bookcase](#layer-public_bookcase) - [filter-public_bookcase-kid-books](#filter-public_bookcase-kid-books) - [filter-public_bookcase-adult-books](#filter-public_bookcase-adult-books) - [filter-public_bookcase-inside](#filter-public_bookcase-inside) - [filter-public_bookcase-has_image](#filter-public_bookcase-has_image) - [layer-note_import_public_bookcase](#layer-note_import_public_bookcase) - [mode](#mode) - [layer-<layer-id>](#layer-<layer-id>) 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:favourites`,`menu:community`,`menu:privacy`,`menu:advanced` `theme-menu:intro`,`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](/src/UI/i18n/Locale.ts#L35) 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](/src/UI/i18n/Locale.ts#L79) The default value is _false_ 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](/src/Logic/State/FeatureSwitchState.ts#L33) 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](/src/Logic/State/FeatureSwitchState.ts#L73) The default value is _true_ fs-search ----------- Disables/Enables the search bar This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L88) The default value is _true_ fs-background --------------- Disables/Enables the background layer control This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L93) The default value is _true_ fs-filter ----------- Disables/Enables the filter view This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L99) 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](/src/Logic/State/FeatureSwitchState.ts#L105) 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](/src/Logic/State/FeatureSwitchState.ts#L110) 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](/src/Logic/State/FeatureSwitchState.ts#L115) 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](/src/Logic/State/FeatureSwitchState.ts#L120) 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](/src/Logic/State/FeatureSwitchState.ts#L125) The default value is _true_ fs-geolocation ---------------- Disables/Enables the geolocation button This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L130) The default value is _true_ fs-all-questions ------------------ Always show all questions This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L135) 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](/src/Logic/State/FeatureSwitchState.ts#L141) 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](/src/Logic/State/FeatureSwitchState.ts#L155) 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](/src/Logic/State/FeatureSwitchState.ts#L161) 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](/src/Logic/State/FeatureSwitchState.ts#L167) 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](/src/Logic/State/FeatureSwitchState.ts#L178) 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](/src/Logic/State/FeatureSwitchState.ts#L186) 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](/src/Logic/State/FeatureSwitchState.ts#L194) 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](/src/Logic/State/FeatureSwitchState.ts#L201) No default value set z --- The initial/current zoom level This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L28) The default value is _1_ lat ----- The initial/current latitude This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L28) The default value is _0_ lon ----- The initial/current longitude of the app This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L28) The default value is _0_ oauth_token ------------- Used to complete the login This documentation is defined in the source code at [ThemeViewState.ts](/src/Models/ThemeViewState.ts#L166) No default value set layer-public_bookcase ----------------------- Whether or not layer public_bookcase is shown This documentation is defined in the source code at [FilteredLayer.ts](/src/Models/FilteredLayer.ts#L106) The default value is _true_ filter-public_bookcase-kid-books ---------------------------------- State of filter kid-books This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161) The default value is _false_ filter-public_bookcase-adult-books ------------------------------------ State of filter adult-books This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161) The default value is _false_ filter-public_bookcase-inside ------------------------------- State of filter inside This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161) The default value is _0_ filter-public_bookcase-has_image ---------------------------------- State of filter has_image This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161) The default value is _0_ layer-note_import_public_bookcase ----------------------------------- Whether or not layer note_import_public_bookcase is shown This documentation is defined in the source code at [FilteredLayer.ts](/src/Models/FilteredLayer.ts#L106) The default value is _true_ mode ------ The mode the application starts in, e.g. 'map', 'dashboard' or 'statistics' This documentation is defined in the source code at [generateDocs.ts](ervdvn/git/MapComplete/scripts/generateDocs.ts#L420) The default value is _map_ layer-<layer-id> ------------------------ Wether or not the layer with id is shown This documentation is defined in the source code at [QueryParameterDocumentation.ts](/src/UI/QueryParameterDocumentation.ts#L59) The default value is _true_ This document is autogenerated from [src/Logic/Web/QueryParameters.ts](https://github.com/pietervdvn/MapComplete/blob/develop/src/Logic/Web/QueryParameters.ts), [src/UI/QueryParameterDocumentation.ts](https://github.com/pietervdvn/MapComplete/blob/develop/src/UI/QueryParameterDocumentation.ts)