143 lines
No EOL
6.8 KiB
Markdown
143 lines
No EOL
6.8 KiB
Markdown
|
|
### 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_fcs 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
|
|
### all_tags
|
|
|
|
Prints all key-value pairs of the object - used for debugging
|
|
|
|
name | default | description
|
|
------ | --------- | -------------
|
|
|
|
|
|
#### Example usage
|
|
|
|
`{all_tags()}`
|
|
### image_carousel
|
|
|
|
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/prefix | 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...
|
|
smart search | true | Also include images given via 'Wikidata', 'wikimedia_commons' and 'mapillary
|
|
|
|
#### Example usage
|
|
|
|
`{image_carousel(image,true)}`
|
|
### 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)
|
|
|
|
#### Example usage
|
|
|
|
`{image_upload(image)}`
|
|
### minimap
|
|
|
|
A small map showing the selected feature. Note that no styling is applied, wrap this in a div
|
|
|
|
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.
|
|
|
|
#### Example usage
|
|
|
|
`{minimap()}`, `{minimap(17, id, _list_of_embedded_feature_ids_calculated_by_calculated_tag):height:10rem; border: 2px solid black}`
|
|
### 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 <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
|
|
|
|
#### Example usage
|
|
|
|
`{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.
|
|
|
|
#### Example usage
|
|
|
|
`{opening_hours_table(opening_hours)}`
|
|
### 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
|
|
|
|
{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)}
|
|
### 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 | | The text to put above the given values column
|
|
countHeader | | The text to put above the counts
|
|
colors* | undefined | (Matches all resting arguments - optional) Matches a regex onto a color value, e.g. `3[a-zA-Z+-]*:#33cc33`
|
|
|
|
#### Example usage
|
|
|
|
`{histogram('some_key')}` with properties being `{some_key: ['a','b','a','c']} to create a histogram
|
|
### share_link
|
|
|
|
Creates a link that (attempts to) open the native 'share'-screen
|
|
|
|
name | default | description
|
|
------ | --------- | -------------
|
|
url | undefined | The url to share (default: current URL)
|
|
|
|
#### Example usage
|
|
|
|
{share_link()} to share the current page, {share_link(<some_url>)} to share the given url
|
|
### canonical
|
|
|
|
Converts a short, canonical value into the long, translated text
|
|
|
|
name | default | description
|
|
------ | --------- | -------------
|
|
key | undefined | The key of the tag to give the canonical text for
|
|
|
|
#### Example usage
|
|
|
|
{canonical(length)} will give 42 metre (in french)
|
|
### import_button
|
|
|
|
This button will copy the data from an external dataset into OpenStreetMap. It is only functional in official themes but can be tested in unofficial themes.
|
|
|
|
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. The theme will filter out duplicate nodes4. All other requirements of the [import guidelines](https://wiki.openstreetmap.org/wiki/Import/Guidelines) have been followed
|
|
|
|
name | default | description
|
|
------ | --------- | -------------
|
|
tags | undefined | Tags to copy-specification. This contains one or more pairs (seperated by a `;`), e.g. `amenity=fast_food; 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. (Hint: prepare these values, e.g. with calculatedTags)
|
|
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
|
|
|
|
#### Example usage
|
|
|
|
`{import_button(,Import this data into OpenStreetMap,./assets/svg/addSmall.svg)}`
|
|
|
|
Generated from UI/SpecialVisualisations.ts |