mapcomplete/Docs/SpecialRenderings.md

42 KiB

Special tag renderings

In a tagrendering, some special values are substituted by an advanced UI-element. This allows advanced features and visualizations to be reused by custom themes or even to query third-party API's.

General usage is {func_name()}, {func_name(arg, someotherarg)} or {func_name(args):cssStyle}. Note that you do not need to use quotes around your arguments, the comma is enough to separate them. This also implies you cannot use a comma in your args

Using expanded syntax

Instead of using {"render": {"en": "{some_special_visualisation(some_arg, some other really long message, more args)} , "nl": "{some_special_visualisation(some_arg, een boodschap in een andere taal, more args)}}, one can also write

{
  "render": {
    "special": {
      "type": "some_special_visualisation",
      "argname": "some_arg",
      "message": {
        "en": "some other really long message",
        "nl": "een boodschap in een andere taal"
      },
      "other_arg_name": "more args"
    },
    "before": {
      "en": "Some text to prefix before the special element (e.g. a title)",
      "nl": "Een tekst om voor het element te zetten (bv. een titel)"
    },
    "after": {
      "en": "Some text to put after the element, e.g. a footer"
    }
  }
}

In other words: use { "before": ..., "after": ..., "special": {"type": ..., "argname": ...argvalue...}. The args are in the special block; an argvalue can be a string, a translation or another value. (Refer to class RewriteSpecial in case of problems)

Table of contents

  1. Special tag renderings

questions

The special element which shows the questions which are unkown. Added by default if not yet there

name default description
labels undefined One or more ';'-separated labels. If these are given, only questions with these labels will be given. Use unlabeled for all questions that don't have an explicit label. If none given, all questions will be shown
blacklisted-labels undefined One or more ';'-separated labels of questions which should not be included

Example usage of questions

{questions(,)}

add_new_point

An element which allows to add a new point on the 'last_click'-location. Only makes sense in the layer last_click

Example usage of add_new_point

{add_new_point()}

user_profile

A component showing information about the currently logged in user (username, profile description, profile picture + link to edit them). Mostly meant to be used in the 'user-settings'

Example usage of user_profile

{user_profile()}

language_picker

A component to set the language of the user interface

Example usage of language_picker

{language_picker()}

logout

Shows a button where the user can log out

Example usage of logout

{logout()}

histogram

Create a histogram for a list of given values, read from the properties.

name default description
key undefined The key to be read and to generate a histogram from
title empty string This text will be placed above the texts (in the first column of the visulasition)
countHeader empty string This text will be placed above the bars
colors* undefined (Matches all resting arguments - optional) Matches a regex onto a color value, e.g. 3[a-zA-Z+-]*:#33cc33

Example usage of histogram

{histogram('some_key')} with properties being `{some_key: ["a","b","a","c"]} to create a histogram

steal

Shows a tagRendering from a different object as if this was the object itself

name default description
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

Example usage of steal

{steal(,)}

minimap

A small map showing the selected feature.

name default description
zoomlevel 18 The (maximum) zoomlevel: the target zoomlevel after fitting the entire feature. The minimap will fit the entire feature, then zoom out to this zoom level. The higher, the more zoomed in with 1 being the entire world and 19 being really close
idKey id (Matches all resting arguments) This argument should be the key of a property of the feature. 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. (Note: if the key is 'id', list interpration is disabled)

Example usage of minimap

{minimap(18,id)}

split_button

Adds a button which allows to split a way

Example usage of split_button

{split_button()}

move_button

Adds a button which allows to move the object to another location. The config will be read from the layer config

Example usage of move_button

{move_button()}

delete_button

Adds a button which allows to delete the object at this location. The config will be read from the layer config

Example usage of delete_button

{delete_button()}

Creates a link that (attempts to) open the native 'share'-screen

name default description
url undefined The url to share (default: current URL)

{share_link()} to share the current page, {share_link(<some_url>)} to share the given url

export_as_gpx

Exports the selected feature as GPX-file

Example usage of export_as_gpx

{export_as_gpx()}

upload_to_osm

Uploads the GPS-history as GPX to OpenStreetMap.org; clears the history afterwards. The actual feature is ignored.

Example usage of upload_to_osm

{upload_to_osm()}

multi_apply

A button to apply the tagging of this object onto a list of other features. This is an advanced feature for which you'll need calculatedTags

name default description
feature_ids undefined A JSON-serialized list of IDs of features to apply the tagging on
keys undefined One key (or multiple keys, seperated by ';') of the attribute that should be copied onto the other features.
text undefined The text to show on the button
autoapply undefined A boolean indicating wether this tagging should be applied automatically if the relevant tags on this object are changed. A visual element indicating the multi_apply is still shown
overwrite undefined If set to 'true', the tags on the other objects will always be overwritten. The default behaviour will be to only change the tags on other objects if they are either undefined or had the same value before the change

Example usage of multi_apply

{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)}

add_note_comment

A textfield to add a comment to a node (with the option to close the note).

name default description
Id-key id The property name where the ID of the note to close can be found

Example usage of add_note_comment

{add_note_comment(id)}

open_note

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

Example usage of open_note

{open_note()}

close_note

Button to close a note. A predifined text can be defined to close the note with. If the note is already closed, will show a small text.

name default description
text undefined Text to show on this button
icon checkmark.svg Icon to show
idkey id The property name where the ID of the note to close can be found
comment undefined Text to add onto the note when closing
minZoom undefined If set, only show the closenote button if zoomed in enough
zoomButton undefined Text to show if not zoomed in enough

Example usage of close_note

{close_note(,checkmark.svg,id,,,)}

plantnet_detection

Sends the images linked to the current object to plantnet.org and asks it what plant species is shown on it. The user can then select the correct species; the corresponding wikidata-identifier will then be added to the object (together with source:species:wikidata=plantnet.org AI).

name default description
image_key image,mapillary,image,wikidata,wikimedia_commons,image,image The keys given to the images, e.g. if image is given, the first picture URL will be added as image, the second as image:0, the third as image:1, etc... Multiple values are allowed if ';'-separated

Example usage of plantnet_detection

{plantnet_detection(image,mapillary,image,wikidata,wikimedia_commons,image,image)}

tag_apply

Shows a big button; clicking this button will apply certain tags onto the feature.

The first argument takes a specification of which tags to add. These can either be a tag to add, such as amenity=fast_food or can use a substitution, e.g. addr:housenumber=$number. This new point will then have the tags amenity=fast_food and addr:housenumber with the value that was saved in number in the original feature.

If a value to substitute is undefined, empty string will be used instead.

This supports multiple values, e.g. ref=$source:geometry:type/$source:geometry:ref

Remark that the syntax is slightly different then expected; it uses '$' to note a value to copy, followed by a name (matched with [a-zA-Z0-9_:]*). Sadly, delimiting with {} as these already mark the boundaries of the special rendering...

Note that these values can be prepare with javascript in the theme by using a calculatedTag

name default description
tags_to_apply undefined A specification of the tags to apply. This is either hardcoded in the layer or the $name of a property containing the tags to apply. If redirected and the value of the linked property starts with {, the other property will be interpreted as a json object
message undefined The text to show to the contributor
image undefined An image to show to the contributor on the button
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_task_id undefined If specified, this maproulette-challenge will be closed when the tags are applied

Example usage of tag_apply

{tag_apply(survey_date=$_now:date, Surveyed today!)}, `{tag_apply(addr:street=$addr:street, Apply the address, apply_icon.svg, _closest_osm_id)

import_button

This button will copy the point from an external dataset into OpenStreetMap

Note that the contributor must zoom to at least zoomlevel 18 to be able to use this functionality. It is only functional in official themes, but can be tested in unoffical themes.

Specifying which tags to copy or add

The argument `tags` of the import button takes a `;`-seperated list of tags to add (or the name of a property which contains a JSON-list of properties).

These can either be a tag to add, such as amenity=fast_food or can use a substitution, e.g. addr:housenumber=$number. This new point will then have the tags amenity=fast_food and addr:housenumber with the value that was saved in number in the original feature.

If a value to substitute is undefined, empty string will be used instead.

This supports multiple values, e.g. ref=$source:geometry:type/$source:geometry:ref

Remark that the syntax is slightly different then expected; it uses '$' to note a value to copy, followed by a name (matched with [a-zA-Z0-9_:]*). Sadly, delimiting with {} as these already mark the boundaries of the special rendering...

Note that these values can be prepare with javascript in the theme by using a calculatedTag

Importing a dataset into OpenStreetMap: requirements

If you want to import a dataset, make sure that:

  1. The dataset to import has a suitable license
  2. The community has been informed of the import
  3. All other requirements of the import guidelines have been followed

There are also some technicalities in your theme to keep in mind:

  1. The new feature will be added and will flow through the program as any other new point as if it came from OSM. This means that there should be a layer which will match the new tags and which will display it.
  2. The original feature from your geojson layer will gain the tag '_imported=yes'. This should be used to change the appearance or even to hide it (eg by changing the icon size to zero)
  3. There should be a way for the theme to detect previously imported points, even after reloading. A reference number to the original dataset is an excellent way to do this
  4. When importing ways, the theme creator is also responsible of avoiding overlapping ways.

Disabled in unofficial themes

The import button can be tested in an unofficial theme by adding test=true or backend=osm-test as URL-paramter. The import button will show up then. If in testmode, you can read the changeset-XML directly in the web console. In the case that MapComplete is pointed to the testing grounds, the edit will be made on https://master.apis.dev.openstreetmap.org

name default description
targetLayer undefined The id of the layer where this point should end up. This is not very strict, it will simply result in checking that this layer is shown preventing possible duplicate elements
tags undefined The tags to add onto the new object - see specification above. If this is a key (a single word occuring in the properties of the object), the corresponding value is taken and expanded instead
text Import this data into OpenStreetMap The text to show on the button
icon ./assets/svg/addSmall.svg A nice icon to show in the button
snap_onto_layers undefined If a way of the given layer(s) is closeby, will snap the new point onto this way (similar as preset might snap). To show multiple layers to snap onto, use a ;-seperated list
max_snap_distance 5 The maximum distance that the imported point will be moved to snap onto a way in an already existing layer (in meters). This is previewed to the contributor, similar to the 'add new point'-action of MapComplete
note_id undefined If given, this key will be read. The corresponding note on OSM will be closed, stating 'imported'
maproulette_id undefined The property name of the maproulette_id - this is probably mr_taskId. If given, the maproulette challenge will be marked as fixed. Only use this if part of a maproulette-layer.

Example usage of import_button

{import_button(,,Import this data into OpenStreetMap,./assets/svg/addSmall.svg,,5,,)}

import_way_button

This button will copy the data from an external dataset into OpenStreetMap, copying the geometry and adding it as a 'line'

Note that the contributor must zoom to at least zoomlevel 18 to be able to use this functionality. It is only functional in official themes, but can be tested in unoffical themes.

Specifying which tags to copy or add

The argument `tags` of the import button takes a `;`-seperated list of tags to add (or the name of a property which contains a JSON-list of properties).

These can either be a tag to add, such as amenity=fast_food or can use a substitution, e.g. addr:housenumber=$number. This new point will then have the tags amenity=fast_food and addr:housenumber with the value that was saved in number in the original feature.

If a value to substitute is undefined, empty string will be used instead.

This supports multiple values, e.g. ref=$source:geometry:type/$source:geometry:ref

Remark that the syntax is slightly different then expected; it uses '$' to note a value to copy, followed by a name (matched with [a-zA-Z0-9_:]*). Sadly, delimiting with {} as these already mark the boundaries of the special rendering...

Note that these values can be prepare with javascript in the theme by using a calculatedTag

Importing a dataset into OpenStreetMap: requirements

If you want to import a dataset, make sure that:

  1. The dataset to import has a suitable license
  2. The community has been informed of the import
  3. All other requirements of the import guidelines have been followed

There are also some technicalities in your theme to keep in mind:

  1. The new feature will be added and will flow through the program as any other new point as if it came from OSM. This means that there should be a layer which will match the new tags and which will display it.
  2. The original feature from your geojson layer will gain the tag '_imported=yes'. This should be used to change the appearance or even to hide it (eg by changing the icon size to zero)
  3. There should be a way for the theme to detect previously imported points, even after reloading. A reference number to the original dataset is an excellent way to do this
  4. When importing ways, the theme creator is also responsible of avoiding overlapping ways.

Disabled in unofficial themes

The import button can be tested in an unofficial theme by adding test=true or backend=osm-test as URL-paramter. The import button will show up then. If in testmode, you can read the changeset-XML directly in the web console. In the case that MapComplete is pointed to the testing grounds, the edit will be made on https://master.apis.dev.openstreetmap.org

name default description
targetLayer undefined The id of the layer where this point should end up. This is not very strict, it will simply result in checking that this layer is shown preventing possible duplicate elements
tags undefined The tags to add onto the new object - see specification above. If this is a key (a single word occuring in the properties of the object), the corresponding value is taken and expanded instead
text Import this data into OpenStreetMap The text to show on the button
icon ./assets/svg/addSmall.svg A nice icon to show in the button
snap_to_point_if undefined Points with the given tags will be snapped to or moved
max_snap_distance 0.05 If the imported object is a LineString or (Multi)Polygon, already existing OSM-points will be reused to construct the geometry of the newly imported way
move_osm_point_if undefined Moves the OSM-point to the newly imported point if these conditions are met
max_move_distance 0.05 If an OSM-point is moved, the maximum amount of meters it is moved. Capped on 20m
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

Example usage of import_way_button

{import_way_button(,,Import this data into OpenStreetMap,./assets/svg/addSmall.svg,,0.05,,0.05,,0.1)}

conflate_button

This button will modify the geometry of an existing OSM way to match the specified geometry. This can conflate OSM-ways with LineStrings and Polygons (only simple polygons with one single ring). An attempt is made to move points with special values to a decent new location (e.g. entrances)

Note that the contributor must zoom to at least zoomlevel 18 to be able to use this functionality. It is only functional in official themes, but can be tested in unoffical themes.

Specifying which tags to copy or add

The argument `tags` of the import button takes a `;`-seperated list of tags to add (or the name of a property which contains a JSON-list of properties).

These can either be a tag to add, such as amenity=fast_food or can use a substitution, e.g. addr:housenumber=$number. This new point will then have the tags amenity=fast_food and addr:housenumber with the value that was saved in number in the original feature.

If a value to substitute is undefined, empty string will be used instead.

This supports multiple values, e.g. ref=$source:geometry:type/$source:geometry:ref

Remark that the syntax is slightly different then expected; it uses '$' to note a value to copy, followed by a name (matched with [a-zA-Z0-9_:]*). Sadly, delimiting with {} as these already mark the boundaries of the special rendering...

Note that these values can be prepare with javascript in the theme by using a calculatedTag

Importing a dataset into OpenStreetMap: requirements

If you want to import a dataset, make sure that:

  1. The dataset to import has a suitable license
  2. The community has been informed of the import
  3. All other requirements of the import guidelines have been followed

There are also some technicalities in your theme to keep in mind:

  1. The new feature will be added and will flow through the program as any other new point as if it came from OSM. This means that there should be a layer which will match the new tags and which will display it.
  2. The original feature from your geojson layer will gain the tag '_imported=yes'. This should be used to change the appearance or even to hide it (eg by changing the icon size to zero)
  3. There should be a way for the theme to detect previously imported points, even after reloading. A reference number to the original dataset is an excellent way to do this
  4. When importing ways, the theme creator is also responsible of avoiding overlapping ways.

Disabled in unofficial themes

The import button can be tested in an unofficial theme by adding test=true or backend=osm-test as URL-paramter. The import button will show up then. If in testmode, you can read the changeset-XML directly in the web console. In the case that MapComplete is pointed to the testing grounds, the edit will be made on https://master.apis.dev.openstreetmap.org

name default description
targetLayer undefined The id of the layer where this point should end up. This is not very strict, it will simply result in checking that this layer is shown preventing possible duplicate elements
tags undefined The tags to add onto the new object - see specification above. If this is a key (a single word occuring in the properties of the object), the corresponding value is taken and expanded instead
text Import this data into OpenStreetMap The text to show on the button
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

Example usage of conflate_button

{conflate_button(,,Import this data into OpenStreetMap,./assets/svg/addSmall.svg,)}

nearby_images

A component showing nearby images loaded from various online services such as Mapillary. In edit mode and when used on a feature, the user can select an image to add to the feature

name default description
mode closed Either open or closed. If open, then the image carousel will always be shown

Example usage of nearby_images

{nearby_images(closed)}

wikipedia

A box showing the corresponding wikipedia article(s) - based on the wikidata tag.

name default description
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

Example usage of wikipedia

{wikipedia()} is a basic example, {wikipedia(name:etymology:wikidata)} to show the wikipedia page of whom the feature was named after. Also remember that these can be styled, e.g. {wikipedia():max-height: 10rem} to limit the height

wikidata_label

Shows the label of the corresponding wikidata-item

name default description
keyToShowWikidataFor wikidata Use the wikidata entry from this key to show the label

Example usage of wikidata_label

{wikidata_label()} is a basic example, {wikipedia(name:etymology:wikidata)} to show the label itself

Adds a button to open mapillary on the specified location

name default description
zoom 18 The startzoom of mapillary

{mapillary_link(18)}

language_chooser

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 language: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. Use {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
mode multi If one or many languages can be selected. Should be 'multi' or 'single'

Example usage of language_chooser

{language_chooser(,,{language()},,{list()},,multi)}

all_tags

Prints all key-value pairs of the object - used for debugging

Example usage of all_tags

{all_tags()}

Creates an image carousel for the given sources. An attempt will be made to guess what source is used. Supported: Wikidata identifiers, Wikipedia pages, Wikimedia categories, IMGUR (with attribution, direct links)

name default description
image_key image,mapillary,image,wikidata,wikimedia_commons,image,image The keys given to the images, e.g. if image is given, the first picture URL will be added as image, the second as image:0, the third as image:1, etc... Multiple values are allowed if ';'-separated

{image_carousel(image,mapillary,image,wikidata,wikimedia_commons,image,image)}

image_upload

Creates a button where a user can upload an image to IMGUR

name default description
image-key image Image tag to add the URL to (or image-tag:0, image-tag:1 when multiple images are added)
label Add image The text to show on the button

Example usage of image_upload

{image_upload(image,Add image)}

reviews

Adds an overview of the mangrove-reviews of this object. Mangrove.Reviews needs - in order to identify the reviewed object - a coordinate and a name. By default, the name of the object is given, but this can be overwritten

name default description
subjectKey name The key to use to determine the subject. If specified, the subject will be tags[subjectKey]
fallback undefined The identifier to use, if tags[subjectKey] as specified above is not available. This is effectively a fallback value

Example usage of reviews

{reviews()} for a vanilla review, {reviews(name, play_forest)} to review a play forest. If a name is known, the name will be used as identifier, otherwise 'play_forest' is used

opening_hours_table

Creates an opening-hours table. Usage: {opening_hours_table(opening_hours)} to create a table of the tag 'opening_hours'.

name default description
key opening_hours The tagkey from which the table is constructed.
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

Example usage of opening_hours_table

A normal opening hours table can be invoked with {opening_hours_table()}. A table for e.g. conditional access with opening hours can be {opening_hours_table(access:conditional, no @ &LPARENS, &RPARENS)}

live

Downloads a JSON from the given URL, e.g. '{live(example.org/data.json, shorthand:x.y.z, other:a.b.c, shorthand)}' will download the given file, will create an object {shorthand: json[x][y][z], other: json[a][b][c] out of it and will return 'other' or 'json[a][b][c]. This is made to use in combination with tags, e.g. {live({url}, {url:format}, needed_value)}

name default description
Url undefined The URL to load
Shorthands undefined A list of shorthands, of the format 'shorthandname:path.path.path'. separated by ;
path undefined The path (or shorthand) that should be returned

Example usage of live

{live({url},{url:format},hour)} {live(https://data.mobility.brussels/bike/api/counts/?request=live&featureID=CB2105,hour:data.hour_cnt;day:data.day_cnt;year:data.year_cnt,hour)}

canonical

Converts a short, canonical value into the long, translated text including the unit. This only works if a unit is defined for the corresponding value. The unit specification will be included in the text.

name default description
key undefined The key of the tag to give the canonical text for

Example usage of canonical

If the object has length=42, then {canonical(length)} will be shown as 42 meter (in english), 42 metre (in french), ...

export_as_geojson

Exports the selected feature as GeoJson-file

Example usage of export_as_geojson

{export_as_geojson()}

open_in_iD

Opens the current view in the iD-editor

Example usage of open_in_iD

{open_in_iD()}

open_in_josm

Opens the current view in the JOSM-editor

Example usage of open_in_josm

{open_in_josm()}

clear_location_history

A button to remove the travelled track information from the device

Example usage of clear_location_history

{clear_location_history()}

visualize_note_comments

Visualises the comments for notes

name default description
commentsKey comments The property name of the comments, which should be stringified json
start 0 Drop the first 'start' comments

Example usage of visualize_note_comments

{visualize_note_comments(comments,0)}

add_image_to_note

Adds an image to a node

name default description
Id-key id The property name where the ID of the note to close can be found

Example usage of add_image_to_note

{add_image_to_note(id)}

title

Shows the title of the popup. Useful for some cases, e.g. 'What is phone number of {title()}?'

Example usage of title

What is the phone number of {title()}, which might automatically become What is the phone number of XYZ.

maproulette_task

Fetches the metadata of MapRoulette campaign that this task is part of and shows those details (namely title, description and instruction).

This reads the property mr_challengeId to detect the parent campaign.

Example usage of maproulette_task

{maproulette_task()}

maproulette_set_status

Change the status of the given MapRoulette task

name default description
message undefined A message to show to the user
image confirm Image to show
message_confirm undefined What to show when the task is closed, either by the user or was already closed.
status 1 A statuscode to apply when the button is clicked. 1 = close, 2 = false_positive, 3 = skip, 4 = deleted, 5 = already fixed (on the map, e.g. for duplicates), 6 = too hard
maproulette_id mr_taskId The property name containing the maproulette id

Example usage of maproulette_set_status

The following example sets the status to '2' (false positive)

{
   "id": "mark_duplicate",
   "render": {
      "special": {
         "type": "maproulette_set_status",
         "message": {
            "en": "Mark as not found or false positive"
         },
         "status": "2",
         "image": "close"
      }
   }
}

statistics

Show general statistics about the elements currently in view. Intended to use on the current_view-layer

Example usage of statistics

{statistics()}

send_email

Creates a mailto-link where some fields are already set and correctly escaped. The user will be promted to send the email

name default description
to undefined Who to send the email to?
subject undefined The subject of the email
body undefined The text in the email
button_text undefined The text shown on the button in the UI

Example usage of send_email

{send_email(,,,)}

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
class undefined CSS-classes to add to the element
download undefined If set, this link will act as a download-button. The contents of href will be offered for download; this parameter will act as the proposed filename

{link(,,,)}

multi

Given an embedded tagRendering (read only) and a key, will read the keyname as a JSON-list. Every element of this list will be considered as tags and rendered with the tagRendering

name default description
key undefined The property to read and to interpret as a list of properties
tagrendering undefined An entire tagRenderingConfig

Example usage of multi

{
 "render": {
   "special": {
     "type": "multi",
     "key": "_doors_from_building_properties",
     "tagrendering": {
       "en": "The building containing this feature has a <a href='#{id}'>door</a> of width {entrance:width}"
     }
   }
 }
}

Converts a fediverse username or link into a clickable link

name default description
key undefined The attribute-name containing the link

{fediverse_link()}

auto_apply

A button to run many actions for many features at once. To effectively use this button, you'll need some ingredients:

  • A target layer with features for which an action is defined in a tag rendering. The following special visualisations support an autoAction: tag_apply, import_way_button, conflate_button
  • A host feature to place the auto-action on. This can be a big outline (such as a city). Another good option for this is the layer
  • current_view
  • Then, use a calculated tag on the host feature to determine the overlapping object ids
  • At last, add this component
name default description
target_layer undefined The layer that the target features will reside in
target_feature_ids undefined The key, of which the value contains a list of ids
tag_rendering_id undefined The ID of the tagRendering containing the autoAction. This tagrendering will be calculated. The embedded actions will be executed
text undefined The text to show on the button
icon ./assets/svg/robot.svg The icon to show on the button

Example usage of auto_apply

{auto_apply(,,,,./assets/svg/robot.svg)}

This document is autogenerated from src/UI/SpecialVisualizations.ts