forked from MapComplete/MapComplete
Docs: add example images to element
This commit is contained in:
parent
5ee033a8c1
commit
634d4a7186
4 changed files with 184 additions and 145 deletions
|
@ -14,8 +14,6 @@ General usage is `{func_name()}`, `{func_name(arg, someotherarg)}` or `{func_nam
|
|||
- [UI](#ui)
|
||||
+ [braced](#braced)
|
||||
+ [create_copy](#create_copy)
|
||||
+ [preset_description](#preset_description)
|
||||
+ [show_icons](#show_icons)
|
||||
+ [title](#title)
|
||||
+ [translated](#translated)
|
||||
- [data](#data)
|
||||
|
@ -81,15 +79,13 @@ General usage is `{func_name()}`, `{func_name(arg, someotherarg)}` or `{func_nam
|
|||
- [tagrendering_manipulation](#tagrendering_manipulation)
|
||||
+ [group](#group)
|
||||
+ [multi](#multi)
|
||||
+ [open_in_iD](#open_in_id)
|
||||
+ [open_in_josm](#open_in_josm)
|
||||
+ [steal](#steal)
|
||||
- [ui](#ui)
|
||||
+ [preset_type_select](#preset_type_select)
|
||||
- [web_and_communication](#web_and_communication)
|
||||
+ [fediverse_link](#fediverse_link)
|
||||
+ [link](#link)
|
||||
+ [mapillary_link](#mapillary_link)
|
||||
+ [open_in_iD](#open_in_id)
|
||||
+ [open_in_josm](#open_in_josm)
|
||||
+ [send_email](#send_email)
|
||||
+ [wikidata_label](#wikidata_label)
|
||||
+ [wikipedia](#wikipedia)
|
||||
|
@ -99,6 +95,8 @@ General usage is `{func_name()}`, `{func_name(arg, someotherarg)}` or `{func_nam
|
|||
+ [histogram](#histogram)
|
||||
+ [language_chooser](#language_chooser)
|
||||
+ [multi_apply](#multi_apply)
|
||||
+ [preset_description](#preset_description)
|
||||
+ [preset_type_select](#preset_type_select)
|
||||
+ [upload_to_osm](#upload_to_osm)
|
||||
|
||||
# Using expanded syntax
|
||||
|
@ -142,7 +140,8 @@ Show a literal text within braces
|
|||
-----|-----|----- |
|
||||
| text | _undefined_ | The value to show |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L296](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L296)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L295](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L295)
|
||||
|
||||
#### Example usage of braced
|
||||
|
||||
|
@ -152,42 +151,19 @@ Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L296](/src/
|
|||
|
||||
Allow to create a copy of the current element
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L315](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L315)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L314](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L314)
|
||||
|
||||
#### Example usage of create_copy
|
||||
|
||||
`{create_copy()}`
|
||||
|
||||
### preset_description
|
||||
|
||||
Shows the extra description from the presets of the layer, if one matches. It will pick the most specific one (e.g. if preset `A` implies `B`, but `B` does not imply `A`, it'll pick B) or the first one if no ordering can be made. Might be empty
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L215](/src/UI/Popup/DataVisualisations.ts#L215)
|
||||
|
||||
#### Example usage of preset_description
|
||||
|
||||
`{preset_description()}`
|
||||
|
||||
### show_icons
|
||||
|
||||
Displays all icons from the specified tagRenderings (if they are known and have an icon) together, e.g. to give a summary of the dietary options
|
||||
|
||||
| name | default | description |
|
||||
-----|-----|----- |
|
||||
| labels | _undefined_ | A ';'-separated list of labels and/or ids of tagRenderings |
|
||||
| class | inline-flex mx-4 | CSS-classes of the container, space-separated |
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L307](/src/UI/Popup/DataVisualisations.ts#L307)
|
||||
|
||||
#### Example usage of show_icons
|
||||
|
||||
`{show_icons(,inline-flex mx-4)}`
|
||||
|
||||
### title
|
||||
|
||||
Shows the title of the popup. Useful for some cases, e.g. 'What is phone number of {title()}?'
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L281](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L281)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L280](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L280)
|
||||
|
||||
#### Example usage of title
|
||||
|
||||
|
@ -201,7 +177,8 @@ If the given key can be interpreted as a JSON, only show the key containing the
|
|||
-----|-----|----- |
|
||||
| key | value | The attribute to interpret as json |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L251](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L251)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L250](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L250)
|
||||
|
||||
#### Example usage of translated
|
||||
|
||||
|
@ -215,7 +192,7 @@ Visualises data of a POI, sometimes with data updating capabilities
|
|||
|
||||
Prints all key-value pairs of the object - used for debugging
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L270](/src/UI/Popup/DataVisualisations.ts#L270)
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L263](/src/UI/Popup/DataVisualisations.ts#L263)
|
||||
|
||||
#### Example usage of all_tags
|
||||
|
||||
|
@ -229,7 +206,7 @@ Converts a short, canonical value into the long, translated text including the u
|
|||
-----|-----|----- |
|
||||
| key | _undefined_ | The key of the tag to give the canonical text for |
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L163](/src/UI/Popup/DataVisualisations.ts#L163)
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L155](/src/UI/Popup/DataVisualisations.ts#L155)
|
||||
|
||||
#### Example usage of canonical
|
||||
|
||||
|
@ -244,7 +221,7 @@ Converts compass degrees (with 0° being north, 90° being east, ...) into a hum
|
|||
| key | _direction:centerpoint | The attribute containing the degrees |
|
||||
| offset | 0 | Offset value that is added to the actual value, e.g. `180` to indicate the opposite (backward) direction |
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L47](/src/UI/Popup/DataVisualisations.ts#L47)
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L39](/src/UI/Popup/DataVisualisations.ts#L39)
|
||||
|
||||
#### Example usage of direction_absolute
|
||||
|
||||
|
@ -254,7 +231,7 @@ Defined in [/src/UI/Popup/DataVisualisations.ts#L47](/src/UI/Popup/DataVisualisa
|
|||
|
||||
Gives a distance indicator and a compass pointing towards the location from your GPS-location. If clicked, centers the map on the object
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L34](/src/UI/Popup/DataVisualisations.ts#L34)
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L26](/src/UI/Popup/DataVisualisations.ts#L26)
|
||||
|
||||
#### Example usage of direction_indicator
|
||||
|
||||
|
@ -270,7 +247,7 @@ A small element, showing if the POI is currently open and when the next change i
|
|||
| prefix | _empty string_ | Remove this string from the start of the value before parsing. __Note: use `&LPARENs` to indicate `(` if needed__ |
|
||||
| postfix | _empty string_ | Remove this string from the end of the value before parsing. __Note: use `&RPARENs` to indicate `)` if needed__ |
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L126](/src/UI/Popup/DataVisualisations.ts#L126)
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L118](/src/UI/Popup/DataVisualisations.ts#L118)
|
||||
|
||||
#### Example usage of opening_hours_state
|
||||
|
||||
|
@ -286,7 +263,7 @@ Creates an opening-hours table. Usage: {opening_hours_table(opening_hours)} to c
|
|||
| prefix | _empty string_ | Remove this string from the start of the value before parsing. __Note: use `&LPARENs` to indicate `(` if needed__ |
|
||||
| postfix | _empty string_ | Remove this string from the end of the value before parsing. __Note: use `&RPARENs` to indicate `)` if needed__ |
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L87](/src/UI/Popup/DataVisualisations.ts#L87)
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L81](/src/UI/Popup/DataVisualisations.ts#L81)
|
||||
|
||||
#### Example usage of opening_hours_table
|
||||
|
||||
|
@ -300,7 +277,7 @@ Creates a visualisation for 'points in time', e.g. collection times of a postbox
|
|||
-----|-----|----- |
|
||||
| key | _undefined_ | The key out of which the points_in_time will be parsed |
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L281](/src/UI/Popup/DataVisualisations.ts#L281)
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L274](/src/UI/Popup/DataVisualisations.ts#L274)
|
||||
|
||||
#### Example usage of points_in_time
|
||||
|
||||
|
@ -310,7 +287,7 @@ Defined in [/src/UI/Popup/DataVisualisations.ts#L281](/src/UI/Popup/DataVisualis
|
|||
|
||||
Show general statistics about all the elements currently in view. Intended to use on the `current_view`-layer. They will be split per layer
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L203](/src/UI/Popup/DataVisualisations.ts#L203)
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L195](/src/UI/Popup/DataVisualisations.ts#L195)
|
||||
|
||||
#### Example usage of statistics
|
||||
|
||||
|
@ -354,7 +331,8 @@ Gives an interactive element which shows a tag comparison between the OSM-object
|
|||
| host | _undefined_ | The domain name(s) where data might be fetched from - this is needed to set the CSP. A domain must include 'https', e.g. 'https://example.com'. For multiple domains, separate them with ';'. If you don't know the possible domains, use '*'. |
|
||||
| readonly | _undefined_ | If 'yes', will not show 'apply'-buttons |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts#L243](/src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts#L243)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts#L243](/src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts#L243)
|
||||
|
||||
#### Example usage of compare_data
|
||||
|
||||
|
@ -414,7 +392,8 @@ In the case that MapComplete is pointed to the testing grounds, the edit will be
|
|||
| icon | ./assets/svg/addSmall.svg | A nice icon to show in the button |
|
||||
| way_to_conflate | _undefined_ | The key, of which the corresponding value is the id of the OSM-way that must be conflated; typically a calculatedTag |
|
||||
|
||||
Defined in [/src/UI/Popup/ImportButtons/ConflateImportButtonViz.ts#L30](/src/UI/Popup/ImportButtons/ConflateImportButtonViz.ts#L30)
|
||||
Defined
|
||||
in [/src/UI/Popup/ImportButtons/ConflateImportButtonViz.ts#L30](/src/UI/Popup/ImportButtons/ConflateImportButtonViz.ts#L30)
|
||||
|
||||
#### Example usage of conflate_button
|
||||
|
||||
|
@ -543,7 +522,8 @@ In the case that MapComplete is pointed to the testing grounds, the edit will be
|
|||
| snap_onto_layers | _undefined_ | If no existing nearby point exists, but a line of a specified layer is closeby, snap to this layer instead |
|
||||
| snap_to_layer_max_distance | 0.1 | Distance to distort the geometry to snap to this layer |
|
||||
|
||||
Defined in [/src/UI/Popup/ImportButtons/WayImportButtonViz.ts#L22](/src/UI/Popup/ImportButtons/WayImportButtonViz.ts#L22)
|
||||
Defined
|
||||
in [/src/UI/Popup/ImportButtons/WayImportButtonViz.ts#L22](/src/UI/Popup/ImportButtons/WayImportButtonViz.ts#L22)
|
||||
|
||||
#### Example usage of import_way_button
|
||||
|
||||
|
@ -561,7 +541,8 @@ Attempts to load (via a proxy) the specified website and parsed ld+json from the
|
|||
| mode | _undefined_ | If `display`, only show the data in tabular and readonly form, ignoring already existing tags. This is used to explicitly show all the tags. If unset or anything else, allow to apply/import on OSM |
|
||||
| collapsed | yes | If the containing accordion should be closed |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts#L105](/src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts#L105)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts#L105](/src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts#L105)
|
||||
|
||||
#### Example usage of linked_data_from_website
|
||||
|
||||
|
@ -580,7 +561,8 @@ Change the status of the given MapRoulette task
|
|||
| maproulette_id | mr_taskId | The property name containing the maproulette id |
|
||||
| ask_feedback | _empty string_ | If not an empty string, this will be used as question to ask some additional feedback. A text field will be added |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts#L25](/src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts#L25)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts#L25](/src/UI/SpecialVisualisations/DataImportSpecialVisualisations.ts#L25)
|
||||
|
||||
#### Example usage of maproulette_set_status
|
||||
|
||||
|
@ -641,7 +623,7 @@ Note that these values can be prepare with javascript in the theme by using a [c
|
|||
| id_of_object_to_apply_this_one | _undefined_ | If specified, applies the the tags onto _another_ object. The id will be read from properties[id_of_object_to_apply_this_one] of the selected object. The tags are still calculated based on the tags of the _selected_ element |
|
||||
| maproulette_id | _undefined_ | If specified, this maproulette-challenge will be closed when the tags are applied. This should be the `id` of the individual task, _not_ the task_id (which corresponds with the challenge). |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/TagApplyViz.ts#L17](/src/UI/SpecialVisualisations/TagApplyViz.ts#L17)
|
||||
Defined in [/src/UI/SpecialVisualisations/TagApplyViz.ts#L13](/src/UI/SpecialVisualisations/TagApplyViz.ts#L13)
|
||||
|
||||
#### Example usage of tag_apply
|
||||
|
||||
|
@ -655,7 +637,8 @@ These special visualisations are (mostly) interactive components that most eleme
|
|||
|
||||
An element which allows to add a new point on the 'last_click'-location. Only makes sense in the layer `last_click`
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L235](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L235)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L234](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L234)
|
||||
|
||||
#### Example usage of add_new_point
|
||||
|
||||
|
@ -665,7 +648,8 @@ Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L235](/src/
|
|||
|
||||
Adds a button which allows to delete the object at this location. The config will be read from the layer config
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L157](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L157)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L157](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L157)
|
||||
|
||||
#### Example usage of delete_button
|
||||
|
||||
|
@ -680,7 +664,8 @@ Shows a 'nothing is currently known-message if there is at least one unanswered
|
|||
| text | _undefined_ | Text to show |
|
||||
| cssClasses | _undefined_ | Classes to apply onto the text |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L207](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L207)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L206](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L206)
|
||||
|
||||
#### Example usage of if_nothing_known
|
||||
|
||||
|
@ -696,7 +681,8 @@ A small map showing the selected feature.
|
|||
| idKey | id | The key of one or more properties of the feature, semi-colon separated. The corresponding value is interpreted as either the id or the a list of ID's. The features with these ID's will be shown on this minimap. |
|
||||
| class | h-40 rounded | CSS-classes (space-separated) that should be applied onto the container |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L81](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L81)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L81](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L81)
|
||||
|
||||
#### Example usage of minimap
|
||||
|
||||
|
@ -706,7 +692,8 @@ Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L81](/src/U
|
|||
|
||||
Adds a button which allows to move the object to another location. The config will be read from the layer config
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L137](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L137)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L137](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L137)
|
||||
|
||||
#### Example usage of move_button
|
||||
|
||||
|
@ -721,7 +708,8 @@ Generates a QR-code to share the selected object
|
|||
| text | _undefined_ | Extra text on the side of the QR-code |
|
||||
| textClass | _undefined_ | CSS class of the the side text |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L178](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L178)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L178](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L178)
|
||||
|
||||
#### Example usage of qr_code
|
||||
|
||||
|
@ -737,7 +725,8 @@ The special element which shows the questions which are unknown. Added by defaul
|
|||
| blacklisted-labels | _undefined_ | One or more ';'-separated labels of questions which should _not_ be included. Note that the questionbox which is added by default will blacklist 'hidden'. If both a whitelist and a blacklist are given, will show questions having at least one label from the whitelist but none of the blacklist. |
|
||||
| show_all | _undefined_ | Either `no`, `yes` or `user-preference`. Indicates if all questions should be shown at once |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L31](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L31)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L31](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L31)
|
||||
|
||||
#### Example usage of questions
|
||||
|
||||
|
@ -762,7 +751,8 @@ Defined in [/src/UI/Popup/ShareLinkViz.ts#L6](/src/UI/Popup/ShareLinkViz.ts#L6)
|
|||
|
||||
Adds a button which allows to split a way
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L123](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L123)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L123](/src/UI/SpecialVisualisations/UISpecialVisualisations.ts#L123)
|
||||
|
||||
#### Example usage of split_button
|
||||
|
||||
|
@ -776,7 +766,8 @@ Elements relating to marking an object as favourite (giving it a heart). Default
|
|||
|
||||
A small button that allows a (logged in) contributor to mark a location as a favourite location, sized to fit a title-icon
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/FavouriteVisualisations.ts#L19](/src/UI/SpecialVisualisations/FavouriteVisualisations.ts#L19)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/FavouriteVisualisations.ts#L19](/src/UI/SpecialVisualisations/FavouriteVisualisations.ts#L19)
|
||||
|
||||
#### Example usage of favourite_icon
|
||||
|
||||
|
@ -786,7 +777,8 @@ Defined in [/src/UI/SpecialVisualisations/FavouriteVisualisations.ts#L19](/src/U
|
|||
|
||||
A button that allows a (logged in) contributor to mark a location as a favourite location
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/FavouriteVisualisations.ts#L6](/src/UI/SpecialVisualisations/FavouriteVisualisations.ts#L6)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/FavouriteVisualisations.ts#L6](/src/UI/SpecialVisualisations/FavouriteVisualisations.ts#L6)
|
||||
|
||||
#### Example usage of favourite_status
|
||||
|
||||
|
@ -804,7 +796,8 @@ Creates an image carousel for the given sources. An attempt will be made to gues
|
|||
-----|-----|----- |
|
||||
| image_key | image;mapillary;image;wikidata;wikimedia_commons;image;panoramax;image;image | The keys given to the images, e.g. if <span class='literal-code'>image</span> is given, the first picture URL will be added as <span class='literal-code'>image</span>, the second as <span class='literal-code'>image:0</span>, the third as <span class='literal-code'>image:1</span>, etc... Multiple values are allowed if ';'-separated |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/ImageVisualisations.ts#L48](/src/UI/SpecialVisualisations/ImageVisualisations.ts#L48)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/ImageVisualisations.ts#L48](/src/UI/SpecialVisualisations/ImageVisualisations.ts#L48)
|
||||
|
||||
#### Example usage of image_carousel
|
||||
|
||||
|
@ -820,7 +813,8 @@ Creates a button where a user can upload an image to panoramax
|
|||
| label | _undefined_ | The text to show on the button |
|
||||
| disable_blur | _undefined_ | If set to 'true' or 'yes', then face blurring will be disabled. To be used sparingly |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/ImageVisualisations.ts#L82](/src/UI/SpecialVisualisations/ImageVisualisations.ts#L82)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/ImageVisualisations.ts#L82](/src/UI/SpecialVisualisations/ImageVisualisations.ts#L82)
|
||||
|
||||
#### Example usage of image_upload
|
||||
|
||||
|
@ -835,7 +829,8 @@ A component showing nearby images loaded from various online services such as Ma
|
|||
| mode | closed | Either `open` or `closed`. If `open`, then the image carousel will always be shown |
|
||||
| readonly | _undefined_ | If 'readonly' or 'yes', will not show the 'link'-button |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/ImageVisualisations.ts#L12](/src/UI/SpecialVisualisations/ImageVisualisations.ts#L12)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/ImageVisualisations.ts#L12](/src/UI/SpecialVisualisations/ImageVisualisations.ts#L12)
|
||||
|
||||
#### Example usage of nearby_images
|
||||
|
||||
|
@ -853,7 +848,8 @@ Adds an image to a node
|
|||
-----|-----|----- |
|
||||
| Id-key | id | The property name where the ID of the note to close can be found |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/NoteVisualisations.ts#L115](/src/UI/SpecialVisualisations/NoteVisualisations.ts#L115)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/NoteVisualisations.ts#L111](/src/UI/SpecialVisualisations/NoteVisualisations.ts#L111)
|
||||
|
||||
#### Example usage of add_image_to_note
|
||||
|
||||
|
@ -867,7 +863,8 @@ A textfield to add a comment to a node (with the option to close the note).
|
|||
-----|-----|----- |
|
||||
| Id-key | id | The property name where the ID of the note to close can be found |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/NoteVisualisations.ts#L79](/src/UI/SpecialVisualisations/NoteVisualisations.ts#L79)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/NoteVisualisations.ts#L75](/src/UI/SpecialVisualisations/NoteVisualisations.ts#L75)
|
||||
|
||||
#### Example usage of add_note_comment
|
||||
|
||||
|
@ -886,7 +883,8 @@ Button to close a note. A predefined text can be defined to close the note with.
|
|||
| minZoom | _undefined_ | If set, only show the closenote button if zoomed in enough |
|
||||
| zoomButton | _undefined_ | Text to show if not zoomed in enough |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/NoteVisualisations.ts#L22](/src/UI/SpecialVisualisations/NoteVisualisations.ts#L22)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/NoteVisualisations.ts#L18](/src/UI/SpecialVisualisations/NoteVisualisations.ts#L18)
|
||||
|
||||
#### Example usage of close_note
|
||||
|
||||
|
@ -896,7 +894,8 @@ Defined in [/src/UI/SpecialVisualisations/NoteVisualisations.ts#L22](/src/UI/Spe
|
|||
|
||||
Creates a new map note on the given location. This options is placed in the 'last_click'-popup automatically if the 'notes'-layer is enabled
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/NoteVisualisations.ts#L98](/src/UI/SpecialVisualisations/NoteVisualisations.ts#L98)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/NoteVisualisations.ts#L94](/src/UI/SpecialVisualisations/NoteVisualisations.ts#L94)
|
||||
|
||||
#### Example usage of open_note
|
||||
|
||||
|
@ -911,7 +910,8 @@ Visualises the comments for notes
|
|||
| commentsKey | comments | The property name of the comments, which should be stringified json |
|
||||
| start | 0 | Drop the first 'start' comments |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/NoteVisualisations.ts#L136](/src/UI/SpecialVisualisations/NoteVisualisations.ts#L136)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/NoteVisualisations.ts#L132](/src/UI/SpecialVisualisations/NoteVisualisations.ts#L132)
|
||||
|
||||
#### Example usage of visualize_note_comments
|
||||
|
||||
|
@ -931,7 +931,8 @@ Invites the contributor to leave a review. Somewhat small UI-element until inter
|
|||
| fallback | _undefined_ | The identifier to use, if <i>tags[subjectKey]</i> as specified above is not available. This is effectively a fallback value |
|
||||
| question | _undefined_ | The question to ask during the review |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L22](/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L22)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L22](/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L22)
|
||||
|
||||
#### Example usage of create_review
|
||||
|
||||
|
@ -946,7 +947,8 @@ Adds an overview of the mangrove-reviews of this object. Mangrove.Reviews needs
|
|||
| subjectKey | name | The key to use to determine the subject. If specified, the subject will be <b>tags[subjectKey]</b> |
|
||||
| fallback | _undefined_ | The identifier to use, if <i>tags[subjectKey]</i> as specified above is not available. This is effectively a fallback value |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L88](/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L88)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L88](/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L88)
|
||||
|
||||
#### Example usage of list_reviews
|
||||
|
||||
|
@ -961,7 +963,8 @@ Shows stars which represent the average rating on mangrove.
|
|||
| subjectKey | name | The key to use to determine the subject. If the value is specified, the subject will be <b>tags[subjectKey]</b> and will use this to filter the reviews. |
|
||||
| fallback | _undefined_ | The identifier to use, if <i>tags[subjectKey]</i> as specified above is not available. This is effectively a fallback value |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L125](/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L125)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L125](/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L125)
|
||||
|
||||
#### Example usage of rating
|
||||
|
||||
|
@ -977,7 +980,8 @@ A pragmatic combination of `create_review` and `list_reviews`
|
|||
| fallback | _undefined_ | The identifier to use, if <i>tags[subjectKey]</i> as specified above is not available. This is effectively a fallback value |
|
||||
| question | _undefined_ | The question to ask in the review form. Optional |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L182](/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L182)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L182](/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L182)
|
||||
|
||||
#### Example usage of reviews
|
||||
|
||||
|
@ -995,7 +999,8 @@ A button which clears the locally downloaded data and the service worker. Login
|
|||
-----|-----|----- |
|
||||
| text | _undefined_ | The text to show on the button |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L110](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L110)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L110](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L110)
|
||||
|
||||
#### Example usage of clear_caches
|
||||
|
||||
|
@ -1005,7 +1010,8 @@ Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L110](/src/U
|
|||
|
||||
A button to remove the travelled track information from the device
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L215](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L215)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L215](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L215)
|
||||
|
||||
#### Example usage of clear_location_history
|
||||
|
||||
|
@ -1015,7 +1021,8 @@ Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L215](/src/U
|
|||
|
||||
Shows which questions are disabled for every layer. Used in 'settings'
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L46](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L46)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L46](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L46)
|
||||
|
||||
#### Example usage of disabled_questions
|
||||
|
||||
|
@ -1025,7 +1032,8 @@ Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L46](/src/UI
|
|||
|
||||
Shows the current tags of the GPS-representing object, used for debugging
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L69](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L69)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L69](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L69)
|
||||
|
||||
#### Example usage of gps_all_tags
|
||||
|
||||
|
@ -1035,7 +1043,8 @@ Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L69](/src/UI
|
|||
|
||||
Shows the current tags of the GPS-representing object, used for debugging
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L58](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L58)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L58](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L58)
|
||||
|
||||
#### Example usage of gyroscope_all_tags
|
||||
|
||||
|
@ -1049,7 +1058,8 @@ Only makes sense in the usersettings. Allows to import a mangrove public key and
|
|||
-----|-----|----- |
|
||||
| text | _undefined_ | The text that is shown on the button |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L162](/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L162)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L162](/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L162)
|
||||
|
||||
#### Example usage of import_mangrove_key
|
||||
|
||||
|
@ -1059,7 +1069,8 @@ Defined in [/src/UI/SpecialVisualisations/ReviewSpecialVisualisations.ts#L162](/
|
|||
|
||||
A component to set the language of the user interface
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L26](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L26)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L26](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L26)
|
||||
|
||||
#### Example usage of language_picker
|
||||
|
||||
|
@ -1074,7 +1085,8 @@ Show a login button
|
|||
| force | _undefined_ | Always show this button, even if logged in |
|
||||
| message | _undefined_ | Message to display on the button |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L131](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L131)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L131](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L131)
|
||||
|
||||
#### Example usage of login_button
|
||||
|
||||
|
@ -1084,7 +1096,8 @@ Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L131](/src/U
|
|||
|
||||
Shows a button where the user can log out
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L192](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L192)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L192](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L192)
|
||||
|
||||
#### Example usage of logout
|
||||
|
||||
|
@ -1094,7 +1107,8 @@ Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L192](/src/U
|
|||
|
||||
A module showing the pending changes, with the option to clear the pending changes
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L204](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L204)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L204](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L204)
|
||||
|
||||
#### Example usage of pending_changes
|
||||
|
||||
|
@ -1109,7 +1123,8 @@ A QR-code which shares the current URL and adds the login token. Anyone with thi
|
|||
| text | _undefined_ | Extra text on the side of the QR-code |
|
||||
| textClass | _undefined_ | CSS class of the the side text |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L161](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L161)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L161](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L161)
|
||||
|
||||
#### Example usage of qr_login
|
||||
|
||||
|
@ -1119,7 +1134,8 @@ Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L161](/src/U
|
|||
|
||||
Shows the current state of storage
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L86](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L86)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L86](/src/UI/SpecialVisualisations/SettingsVisualisations.ts#L86)
|
||||
|
||||
#### Example usage of storage_all_tags
|
||||
|
||||
|
@ -1139,7 +1155,8 @@ A collapsable group (accordion)
|
|||
| labels | _undefined_ | A `;`-separated list of either identifiers or label names. All tagRenderings matching this value will be shown in the accordion |
|
||||
| blacklist | _undefined_ | A `;`-separated list of either identifiers or label names. Matching tagrenderings will _not_ be included, even if they are in `labels` |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L176](/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L176)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L176](/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L176)
|
||||
|
||||
#### Example usage of group
|
||||
|
||||
|
@ -1155,7 +1172,8 @@ Given an embedded tagRendering (read only) and a key, will read the keyname as a
|
|||
| tagrendering | _undefined_ | An entire tagRenderingConfig |
|
||||
| classes | _undefined_ | CSS-classes to apply on every individual item. Seperated by `space` |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L96](/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L96)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L96](/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L96)
|
||||
|
||||
#### Example usage of multi
|
||||
|
||||
|
@ -1173,6 +1191,28 @@ Defined in [/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisuali
|
|||
}
|
||||
```
|
||||
|
||||
### open_in_iD
|
||||
|
||||
Opens the current view in the iD-editor
|
||||
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L212](/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L212)
|
||||
|
||||
#### Example usage of open_in_iD
|
||||
|
||||
`{open_in_iD()}`
|
||||
|
||||
### open_in_josm
|
||||
|
||||
Opens the current view in the JOSM-editor
|
||||
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L226](/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L226)
|
||||
|
||||
#### Example usage of open_in_josm
|
||||
|
||||
`{open_in_josm()}`
|
||||
|
||||
### steal
|
||||
|
||||
Shows a tagRendering from a different object as if this was the object itself
|
||||
|
@ -1182,26 +1222,13 @@ Shows a tagRendering from a different object as if this was the object itself
|
|||
| featureId | _undefined_ | The key of the attribute which contains the id of the feature from which to use the tags |
|
||||
| tagRenderingId | _undefined_ | The layer-id and tagRenderingId to render. Can be multiple value if ';'-separated (in which case every value must also contain the layerId, e.g. `layerId.tagRendering0; layerId.tagRendering1`). Note: this can cause layer injection |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L23](/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L23)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L23](/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L23)
|
||||
|
||||
#### Example usage of steal
|
||||
|
||||
`{steal(,)}`
|
||||
|
||||
## ui
|
||||
|
||||
Elements to support the user interface, e.g. 'title', 'translated'
|
||||
|
||||
### preset_type_select
|
||||
|
||||
An editable tag rendering which allows to change the type
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L231](/src/UI/Popup/DataVisualisations.ts#L231)
|
||||
|
||||
#### Example usage of preset_type_select
|
||||
|
||||
`{preset_type_select()}`
|
||||
|
||||
## web_and_communication
|
||||
|
||||
Tools to show data from external websites, which link to external websites or which link to external profiles
|
||||
|
@ -1214,7 +1241,8 @@ Converts a fediverse username or link into a clickable link
|
|||
-----|-----|----- |
|
||||
| key | _undefined_ | The attribute-name containing the link |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L20](/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L20)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L16](/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L16)
|
||||
|
||||
#### Example usage of fediverse_link
|
||||
|
||||
|
@ -1224,16 +1252,17 @@ Defined in [/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisatio
|
|||
|
||||
Construct a link. By using the 'special' visualisation notation, translations should be easier
|
||||
|
||||
| name | default | description |
|
||||
-----|-----|----- |
|
||||
| text | _undefined_ | Text to be shown |
|
||||
| href | _undefined_ | The URL to link to. Note that this will be URI-encoded before and (as everything) supports substitutions of attributes |
|
||||
| class | _undefined_ | CSS-classes to add to the element |
|
||||
| download | _undefined_ | Expects a string which denotes the filename to download the contents of `href` into. If set, this link will act as a download-button. |
|
||||
| arialabel | _undefined_ | If set, this text will be used as aria-label |
|
||||
| icon | _undefined_ | If set, show this icon next to the link. You might want to combine this with `class: button` |
|
||||
| name | default | description |
|
||||
-----------|-------------|---------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| text | _undefined_ | Text to be shown |
|
||||
| href | _undefined_ | The URL to link to. Note that this will be URI-encoded before and (as everything) supports substitutions of attributes |
|
||||
| class | _undefined_ | CSS-classes to add to the element |
|
||||
| download | _undefined_ | Expects a string which denotes the filename to download the contents of `href` into. If set, this link will act as a download-button. |
|
||||
| arialabel | _undefined_ | If set, this text will be used as aria-label |
|
||||
| icon | _undefined_ | If set, show this icon next to the link. You might want to combine this with `class: button` |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L147](/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L147)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L143](/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L143)
|
||||
|
||||
#### Example usage of link
|
||||
|
||||
|
@ -1253,26 +1282,6 @@ Defined in [/src/UI/Popup/MapillaryLinkVis.ts#L7](/src/UI/Popup/MapillaryLinkVis
|
|||
|
||||
`{mapillary_link(18)}`
|
||||
|
||||
### open_in_iD
|
||||
|
||||
Opens the current view in the iD-editor
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L212](/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L212)
|
||||
|
||||
#### Example usage of open_in_iD
|
||||
|
||||
`{open_in_iD()}`
|
||||
|
||||
### open_in_josm
|
||||
|
||||
Opens the current view in the JOSM-editor
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L226](/src/UI/SpecialVisualisations/TagrenderingManipulationSpecialVisualisations.ts#L226)
|
||||
|
||||
#### Example usage of open_in_josm
|
||||
|
||||
`{open_in_josm()}`
|
||||
|
||||
### send_email
|
||||
|
||||
Creates a `mailto`-link where some fields are already set and correctly escaped. The user will be promted to send the email
|
||||
|
@ -1284,7 +1293,7 @@ Creates a `mailto`-link where some fields are already set and correctly escaped.
|
|||
| body | _undefined_ | The text in the email |
|
||||
| button_text | _undefined_ | The text shown on the button in the UI |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L109](/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L109)
|
||||
Defined in [/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L105](/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L105)
|
||||
|
||||
#### Example usage of send_email
|
||||
|
||||
|
@ -1298,7 +1307,8 @@ Shows the label of the corresponding wikidata-item
|
|||
-----|-----|----- |
|
||||
| keyToShowWikidataFor | wikidata | Use the wikidata entry from this key to show the label |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L68](/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L68)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L64](/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L64)
|
||||
|
||||
#### Example usage of wikidata_label
|
||||
|
||||
|
@ -1312,7 +1322,8 @@ A box showing the corresponding wikipedia article(s) - based on the **wikidata**
|
|||
-----|-----|----- |
|
||||
| keyToShowWikipediaFor | wikidata;wikipedia | Use the wikidata entry from this key to show the wikipedia article for. Multiple keys can be given (separated by ';'), in which case the first matching value is used |
|
||||
|
||||
Defined in [/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L39](/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L39)
|
||||
Defined
|
||||
in [/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L35](/src/UI/SpecialVisualisations/WebAndCommunicationSpecialVisualisations.ts#L35)
|
||||
|
||||
#### Example usage of wikipedia
|
||||
|
||||
|
@ -1326,7 +1337,7 @@ Various elements
|
|||
|
||||
Exports the selected feature as GeoJson-file
|
||||
|
||||
Defined in [/src/UI/Popup/DataExportVisualisations.ts#L38](/src/UI/Popup/DataExportVisualisations.ts#L38)
|
||||
Defined in [/src/UI/Popup/DataExportVisualisations.ts#L34](/src/UI/Popup/DataExportVisualisations.ts#L34)
|
||||
|
||||
#### Example usage of export_as_geojson
|
||||
|
||||
|
@ -1336,7 +1347,7 @@ Defined in [/src/UI/Popup/DataExportVisualisations.ts#L38](/src/UI/Popup/DataExp
|
|||
|
||||
Exports the selected feature as GPX-file
|
||||
|
||||
Defined in [/src/UI/Popup/DataExportVisualisations.ts#L12](/src/UI/Popup/DataExportVisualisations.ts#L12)
|
||||
Defined in [/src/UI/Popup/DataExportVisualisations.ts#L8](/src/UI/Popup/DataExportVisualisations.ts#L8)
|
||||
|
||||
#### Example usage of export_as_gpx
|
||||
|
||||
|
@ -1350,7 +1361,7 @@ Create a histogram for a list of given values, read from the properties.
|
|||
-----|-----|----- |
|
||||
| key | _undefined_ | The key to be read and to generate a histogram from |
|
||||
|
||||
Defined in [/src/UI/Popup/HistogramViz.ts#L11](/src/UI/Popup/HistogramViz.ts#L11)
|
||||
Defined in [/src/UI/Popup/HistogramViz.ts#L7](/src/UI/Popup/HistogramViz.ts#L7)
|
||||
|
||||
#### Example usage of histogram
|
||||
|
||||
|
@ -1360,14 +1371,14 @@ Defined in [/src/UI/Popup/HistogramViz.ts#L11](/src/UI/Popup/HistogramViz.ts#L11
|
|||
|
||||
The language element allows to show and pick all known (modern) languages. The key can be set
|
||||
|
||||
| name | default | description |
|
||||
-----|-----|----- |
|
||||
| key | _undefined_ | What key to use, e.g. `language`, `tactile_writing:braille:language`, ... If a language is supported, the language code will be appended to this key, resulting in `<key>:nl=yes` if _nl_ is picked |
|
||||
| question | _undefined_ | What to ask if no questions are known |
|
||||
| render_list_item | {language()} | How a single language will be shown in the list of languages. Use `{language}` to indicate the language (which it must contain). |
|
||||
| render_single_language | _undefined_ | What will be shown if the feature only supports a single language |
|
||||
| render_all | {list()} | The full rendering. U0se `{list}` to show where the list of languages must come. Optional if mode=single |
|
||||
| no_known_languages | _undefined_ | The text that is shown if no languages are known for this key. If this text is omitted, the languages will be prompted instead |
|
||||
| name | default | description |
|
||||
------------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| key | _undefined_ | What key to use, e.g. `language`, `tactile_writing:braille:language`, ... If a language is supported, the language code will be appended to this key, resulting in `<key>:nl=yes` if _nl_ is picked |
|
||||
| question | _undefined_ | What to ask if no questions are known |
|
||||
| render_list_item | {language()} | How a single language will be shown in the list of languages. Use `{language}` to indicate the language (which it must contain). |
|
||||
| render_single_language | _undefined_ | What will be shown if the feature only supports a single language |
|
||||
| render_all | {list()} | The full rendering. U0se `{list}` to show where the list of languages must come. Optional if mode=single |
|
||||
| no_known_languages | _undefined_ | The text that is shown if no languages are known for this key. If this text is omitted, the languages will be prompted instead |
|
||||
|
||||
Defined in [/src/UI/Popup/LanguageElement/LanguageElement.ts#L5](/src/UI/Popup/LanguageElement/LanguageElement.ts#L5)
|
||||
|
||||
|
@ -1403,6 +1414,31 @@ Defined in [/src/UI/Popup/MultiApplyViz.ts#L7](/src/UI/Popup/MultiApplyViz.ts#L7
|
|||
|
||||
{multi_apply(_features_with_the_same_name_within_100m, name:etymology:wikidata;name:etymology, Apply etymology information on all nearby objects with the same name)}
|
||||
|
||||
### preset_description
|
||||
|
||||
Shows the extra description from the presets of the layer, if one matches. It will pick the most specific one (e.g. if preset `A` implies `B`, but `B` does not imply `A`, it'll pick B) or the first one if no ordering can be made. Might be empty
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L207](/src/UI/Popup/DataVisualisations.ts#L207)
|
||||
|
||||
#### Example usage of preset_description
|
||||
|
||||
`{preset_description()}`
|
||||
|
||||
### preset_type_select
|
||||
|
||||
An editable tag rendering which allows to change the type. The options are the presets of the layer, effectively
|
||||
allowing to change act as if the object was made with a different preset. For example
|
||||
|
||||
How this element looks like (in question mode) for [
|
||||
`tourism_accomodation`](./Layers/tourism_accomodation.md): The
|
||||
presets 
|
||||
|
||||
Defined in [/src/UI/Popup/DataVisualisations.ts#L222](/src/UI/Popup/DataVisualisations.ts#L222)
|
||||
|
||||
#### Example usage of preset_type_select
|
||||
|
||||
`{preset_type_select()}`
|
||||
|
||||
### upload_to_osm
|
||||
|
||||
Uploads the GPS-history as GPX to OpenStreetMap.org; clears the history afterwards. The actual feature is ignored.
|
||||
|
|
BIN
Docs/img/Special_preset_type_select_matching_presets.png
Normal file
BIN
Docs/img/Special_preset_type_select_matching_presets.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 106 KiB |
BIN
Docs/img/Special_preset_type_select_preview.png
Normal file
BIN
Docs/img/Special_preset_type_select_preview.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 110 KiB |
|
@ -230,7 +230,10 @@ class PresetDescription extends SpecialVisualizationSvelte {
|
|||
|
||||
class PresetTypeSelect extends SpecialVisualizationSvelte {
|
||||
funcName = "preset_type_select"
|
||||
docs = "An editable tag rendering which allows to change the type"
|
||||
docs = "An editable tag rendering which allows to change the type. The options are the presets of the layer, effectively allowing to change act as if the object was made with a different preset. " +
|
||||
"For example\n\n" +
|
||||
"How this element looks like (in question mode) for [`tourism_accomodation`](./Layers/tourism_accomodation.md): " +
|
||||
"The presets "
|
||||
args = []
|
||||
group = "ui"
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue