461 lines
No EOL
22 KiB
JSON
461 lines
No EOL
22 KiB
JSON
{
|
|
"description": "The LineRenderingConfig gives all details onto how to render a single line of a feature.\n\nThis can be used if:\n\n- The feature is a line\n- The feature is an area",
|
|
"type": "object",
|
|
"properties": {
|
|
"color": {
|
|
"description": "question: What color should lines be drawn in?\n\nFor an area, this will be the colour of the outside line.\nIf the value starts with \"--\", the style of the body element will be queried for the corresponding variable instead\n\ntypes: dynamic value ; string\ntitle: Line Colour\ninline: The line colour always is <b>{value}</b>\ntype: color",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/MinimalTagRenderingConfigJson"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"width": {
|
|
"description": "question: How wide should the line be?\nThe stroke-width for way-elements\n\ntypes: dynamic value ; string\ntitle: Line width\ninline: The line width is <b>{value} pixels</b>\ntype: pnat\nifunset: Use the default-linewidth of 7 pixels",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/MinimalTagRenderingConfigJson"
|
|
},
|
|
{
|
|
"type": [
|
|
"string",
|
|
"number"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"dashArray": {
|
|
"description": "question: Should a dasharray be used to render the lines?\nThe dasharray defines 'pixels of line, pixels of gap, pixels of line, pixels of gap, ...'. For example, `5 6` will be 5 pixels of line followed by a 6 pixel gap.\nCannot be a dynamic property due to a mapbox limitation\nifunset: Ways are rendered with a full line",
|
|
"type": "string"
|
|
},
|
|
"lineCap": {
|
|
"description": "question: What form should the line-ending have?\nsuggestions: return [{if:\"value=round\",then:\"Round endings\"}, {if: \"value=square\", then: \"square endings\"}, {if: \"value=butt\", then: \"no ending (square ending at the end, without padding)\"}]\ntypes: dynamic value ; string\ntitle: Line Cap\nifunset: Use the default value (round ending)",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/MinimalTagRenderingConfigJson"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"fillColor": {
|
|
"description": "question: What colour should be used as fill colour for polygons?\nifunset: The polygon fill colour will be a more transparent version of the stroke colour\nsuggestions: return [{if: \"value=#00000000\", then: \"Use a transparent fill (only render the outline)\"}]\ninline: The fill colour is <b>{value}</b>\ntypes: dynamic value ; string\ntype: color",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/MinimalTagRenderingConfigJson"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"offset": {
|
|
"description": "question: Should the lines be moved (offsetted) with a number of pixels against the geographical lines?\nThe number of pixels this line should be moved.\nUse a positive number to move to the right in the drawing direction or a negative to move to the left (left/right as defined by the drawing direction of the line).\n\nIMPORTANT: MapComplete will already normalize 'key:both:property' and 'key:both' into the corresponding 'key:left' and 'key:right' tagging (same for 'sidewalk=left/right/both' which is rewritten to 'sidewalk:left' and 'sidewalk:right')\nThis simplifies programming. Refer to the CalculatedTags.md-documentation for more details\nifunset: don't offset lines on the map\ninline: Pixel offset by <b>{value}</b> pixels\ntypes: dynamic value ; number\ntype: int",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/MinimalTagRenderingConfigJson"
|
|
},
|
|
{
|
|
"type": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"definitions": {
|
|
"TagConfigJson": {
|
|
"description": "The main representation of Tags.\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for more documentation\n\ntype: tag",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/{and:TagConfigJson[];}"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"or": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/TagConfigJson"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"or"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"{and:TagConfigJson[];}": {
|
|
"type": "object",
|
|
"properties": {
|
|
"and": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/TagConfigJson"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"and"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
"{or:TagConfigJson[];}": {
|
|
"type": "object",
|
|
"properties": {
|
|
"or": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/TagConfigJson"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"or"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
"Record<string,string>": {
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"Record<string,string|Record<string,string>>": {
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"DenominationConfigJson": {
|
|
"type": "object",
|
|
"properties": {
|
|
"useIfNoUnitGiven": {
|
|
"description": "If this evaluates to true and the value to interpret has _no_ unit given, assumes that this unit is meant.\nAlternatively, a list of country codes can be given where this acts as the default interpretation\n\nE.g., a denomination using \"meter\" would probably set this flag to \"true\";\na denomination for \"mp/h\" will use the condition \"_country=gb\" to indicate that it is the default in the UK.\n\nIf none of the units indicate that they are the default, the first denomination will be used instead",
|
|
"anyOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
}
|
|
]
|
|
},
|
|
"canonicalDenomination": {
|
|
"description": "The canonical value for this denomination which will be added to the value in OSM.\ne.g. \"m\" for meters\nIf the user inputs '42', the canonical value will be added and it'll become '42m'.\n\nImportant: often, _no_ canonical values are expected, e.g. in the case of 'maxspeed' where 'km/h' is the default.\nIn this case, an empty string should be used",
|
|
"type": "string"
|
|
},
|
|
"canonicalDenominationSingular": {
|
|
"description": "The canonical denomination in the case that the unit is precisely '1'.\nUsed for display purposes only.\n\nE.g.: for duration of something in minutes: `2 minutes` but `1 minute`; the `minute` goes here",
|
|
"type": "string"
|
|
},
|
|
"alternativeDenomination": {
|
|
"description": "A list of alternative values which can occur in the OSM database - used for parsing.\nE.g.: while 'm' is canonical, `meter`, `mtrs`, ... can occur as well",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"human": {
|
|
"description": "The value for humans in the dropdown. This should not use abbreviations and should be translated, e.g.\n{\n \"en\": \"meter\",\n \"fr\": \"metre\"\n}",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/Record<string,string>"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"humanSingular": {
|
|
"description": "The value for humans in the dropdown. This should not use abbreviations and should be translated, e.g.\n{\n \"en\": \"minute\",\n \"nl\": \"minuut\"\n}",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/Record<string,string>"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"prefix": {
|
|
"description": "If set, then the canonical value will be prefixed instead, e.g. for '€'\nNote that if all values use 'prefix', the dropdown might move to before the text field",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"canonicalDenomination"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
"MinimalTagRenderingConfigJson": {
|
|
"description": "Mostly used for lineRendering and pointRendering",
|
|
"type": "object",
|
|
"properties": {
|
|
"render": {
|
|
"description": "question: What value should be shown (if no predifined option matches)?\n\nThis piece of text will be shown in the infobox.\nNote that \"&LBRACEkey&RBRACE\"-parts are substituted by the corresponding values of the element.\n\nThis value will be used if there is no mapping which matches (or there are no matches)\nNote that this is a HTML-interpreted value, so you can add links as e.g. '<a href='{website}'>{website}</a>' or include images such as `This is of type A <br><img src='typeA-icon.svg' />`",
|
|
"type": "string"
|
|
},
|
|
"mappings": {
|
|
"description": "Allows fixed-tag inputs, shown either as radiobuttons or as checkboxes",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"if": {
|
|
"$ref": "#/definitions/TagConfigJson",
|
|
"description": "question: When should this single mapping match?\n\nIf this condition is met, then the text under `then` will be shown.\nIf no value matches, and the user selects this mapping as an option, then these tags will be uploaded to OSM.\n\nFor example: {'if': 'diet:vegetarion=yes', 'then':'A vegetarian option is offered here'}\n\nThis can be an substituting-tag as well, e.g. {'if': 'addr:street:={_calculated_nearby_streetname}', 'then': '{_calculated_nearby_streetname}'}"
|
|
},
|
|
"then": {
|
|
"description": "question: What text should be shown?\n\nIf the condition `if` is met, the text `then` will be rendered.\nIf not known yet, the user will be presented with `then` as an option",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"if",
|
|
"then"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"IconConfigJson": {
|
|
"type": "object",
|
|
"properties": {
|
|
"icon": {
|
|
"description": "question: What icon should be used?\ntype: icon\nsuggestions: return [\"pin\",\"square\",\"circle\",\"checkmark\",\"clock\",\"close\",\"crosshair\",\"help\",\"home\",\"invalid\",\"location\",\"location_empty\",\"location_locked\",\"note\",\"resolved\",\"ring\",\"scissors\",\"teardrop\",\"teardrop_with_hole_green\",\"triangle\"].map(i => ({if: \"value=\"+i, then: i, icon: i}))",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/MinimalTagRenderingConfigJson"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"builtin": {
|
|
"type": "string"
|
|
},
|
|
"override": {}
|
|
},
|
|
"required": [
|
|
"builtin",
|
|
"override"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"color": {
|
|
"description": "question: What colour should the icon be?\nThis will only work for the default icons such as `pin`,`circle`,...\ntype: color",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/MinimalTagRenderingConfigJson"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"builtin": {
|
|
"type": "string"
|
|
},
|
|
"override": {}
|
|
},
|
|
"required": [
|
|
"builtin",
|
|
"override"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"icon"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
"TagRenderingConfigJson": {
|
|
"description": "A TagRenderingConfigJson is a single piece of code which converts one ore more tags into a HTML-snippet.\nFor an _editable_ tagRendering, use 'QuestionableTagRenderingConfigJson' instead, which extends this one",
|
|
"type": "object",
|
|
"properties": {
|
|
"render": {
|
|
"description": "question: What text should be rendered?\n\nThis piece of text will be shown in the infobox.\nIn this text, values within braces (such as {braced(key)}) are replaced by the corresponding `value` in the object.\nFor example, if the object contains tags `amenity=school; name=Windy Hill School`, the render string `This school is named {name}` will be shown to the user as `This school is named Windy Hill School`\n\nThis text will be shown if:\n- there is no mapping which matches (or there are no matches)\n- no question, no mappings and no 'freeform' is set\n\nNote that this is a HTML-interpreted value, so you can add links as e.g. '<a href='{website}'>{website}</a>' or include images such as `This is of type A <br><img src='typeA-icon.svg' />`\ntype: rendered\nifunset: No text is shown if no predefined options match.",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/Record<string,string>"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"special": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/Record<string,string|Record<string,string>>"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"special"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"icon": {
|
|
"description": "question: what icon should be shown next to the 'render' value?\nAn icon shown next to the rendering; typically shown pretty small\nThis is only shown next to the \"render\" value\nType: icon\nifunset: No additional icon is shown next to the always shown text",
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"description": "The path to the icon\nType: icon",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "A hint to mapcomplete on how to render this icon within the mapping.\nThis is translated to 'mapping-icon-<classtype>', so defining your own in combination with a custom CSS is possible (but discouraged)",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"condition": {
|
|
"description": "question: When should this item be shown?\ntype: tag\nifunset: No specific condition set; always show this tagRendering or ask the question if unkown\n\nOnly show this tagrendering (or ask the question) if the selected object also matches the tags specified as `condition`.\n\nThis is useful to ask a follow-up question.\nFor example, within toilets, asking _where_ the diaper changing table is is only useful _if_ there is one.\nThis can be done by adding `\"condition\": \"changing_table=yes\"`\n\nA full example would be:\n```json\n {\n \"question\": \"Where is the changing table located?\",\n \"render\": \"The changing table is located at {changing_table:location}\",\n \"condition\": \"changing_table=yes\",\n \"freeform\": {\n \"key\": \"changing_table:location\",\n \"inline\": true\n },\n \"mappings\": [\n {\n \"then\": \"The changing table is in the toilet for women.\",\n \"if\": \"changing_table:location=female_toilet\"\n },\n {\n \"then\": \"The changing table is in the toilet for men.\",\n \"if\": \"changing_table:location=male_toilet\"\n },\n {\n \"if\": \"changing_table:location=wheelchair_toilet\",\n \"then\": \"The changing table is in the toilet for wheelchair users.\",\n },\n {\n \"if\": \"changing_table:location=dedicated_room\",\n \"then\": \"The changing table is in a dedicated room. \",\n }\n ],\n \"id\": \"toilet-changing_table:location\"\n },\n```",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/{and:TagConfigJson[];}"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/{or:TagConfigJson[];}"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"metacondition": {
|
|
"description": "question: When should this item be shown (including special conditions)?\ntype: tag\n\nIf set, this tag will be evaluated agains the _usersettings/application state_ table.\nEnable 'show debug info' in user settings to see available options.\nNote that values with an underscore depicts _application state_ (including metainfo about the user) whereas values without an underscore depict _user settings_",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/{and:TagConfigJson[];}"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/{or:TagConfigJson[];}"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"freeform": {
|
|
"description": "question: Should a freeform text field be shown?\nAllow freeform text input from the user\nifunset: Do not add a freeform text field",
|
|
"type": "object",
|
|
"properties": {
|
|
"key": {
|
|
"description": "What attribute should be filled out\nIf this key is present in the feature, then 'render' is used to display the value.\nIf this is undefined, the rendering is _always_ shown",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"mappings": {
|
|
"description": "Allows fixed-tag inputs, shown either as radiobuttons or as checkboxes",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"if": {
|
|
"$ref": "#/definitions/TagConfigJson",
|
|
"description": "question: When should this single mapping match?\n\nIf this condition is met, then the text under `then` will be shown.\nIf no value matches, and the user selects this mapping as an option, then these tags will be uploaded to OSM.\n\nFor example: {'if': 'diet:vegetarion=yes', 'then':'A vegetarian option is offered here'}\n\nThis can be an substituting-tag as well, e.g. {'if': 'addr:street:={_calculated_nearby_streetname}', 'then': '{_calculated_nearby_streetname}'}"
|
|
},
|
|
"then": {
|
|
"description": "question: What text should be shown?\n\nIf the condition `if` is met, the text `then` will be rendered.\nIf not known yet, the user will be presented with `then` as an option\nType: rendered",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/Record<string,string>"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"icon": {
|
|
"description": "question: What icon should be added to this mapping?\nifunset: Do not show an extra icon next to the render value\n\nAn icon supporting this mapping; typically shown pretty small.\nThis can be used to show a 'phone'-icon next to the phone number\ninline: <img src='{icon}' class=\"w-8 h-8\" /> {icon}\nType: icon",
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"description": "The path to the icon\nType: icon",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "A hint to mapcomplete on how to render this icon within the mapping.\nThis is translated to 'mapping-icon-<classtype>', so defining your own in combination with a custom CSS is possible (but discouraged)",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"if",
|
|
"then"
|
|
]
|
|
}
|
|
},
|
|
"description": {
|
|
"description": "A human-readable text explaining what this tagRendering does.\nMostly used for the shared tagrenderings",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/Record<string,string>"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"classes": {
|
|
"description": "question: What css-classes should be applied to showing this attribute?\n\nA list of css-classes to apply to the entire tagRendering.\nThese classes are applied in 'answer'-mode, not in question mode\nThis is only for advanced users.\n\nValues are split on ` ` (space)",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
},
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"additionalProperties": false
|
|
} |