132 lines
No EOL
4.3 KiB
TypeScript
132 lines
No EOL
4.3 KiB
TypeScript
import {TagRenderingConfigJson} from "./TagRenderingConfigJson";
|
|
import {AndOrTagConfigJson} from "./TagConfigJson";
|
|
|
|
/**
|
|
* Configuration for a single layer
|
|
*/
|
|
export interface LayerConfigJson {
|
|
/**
|
|
* The id of this layer.
|
|
* This should be a simple, lowercase, human readable string that is used to identify the layer.
|
|
*/
|
|
id: string;
|
|
|
|
/**
|
|
* The name of this layer
|
|
* Used in the layer control panel and the 'Personal theme'
|
|
*/
|
|
name: string | any
|
|
|
|
/**
|
|
* A description for this layer.
|
|
* Shown in the layer selections and in the personal theme
|
|
*/
|
|
description?: string | any;
|
|
|
|
|
|
/**
|
|
* The tags to load from overpass. Either a simple 'key=value'-string, otherwise an advanced configuration
|
|
*/
|
|
overpassTags: AndOrTagConfigJson | string;
|
|
|
|
/**
|
|
* If set, this layer will not query overpass; but it'll still match the tags above which are by chance returned by other layers.
|
|
* Works well together with 'passAllFeatures', to add decoration
|
|
*/
|
|
doNotDownload?: boolean;
|
|
|
|
/**
|
|
* The zoomlevel at which point the data is shown and loaded.
|
|
*/
|
|
minzoom: number;
|
|
|
|
|
|
|
|
/**
|
|
* The title shown in a popup for elements of this layer.
|
|
*/
|
|
title?: string | TagRenderingConfigJson;
|
|
|
|
/**
|
|
* Small icons shown next to the title.
|
|
* If not specified, the OsmLink and wikipedia links will be used by default.
|
|
* Use an empty array to hide them
|
|
*/
|
|
titleIcons?: (string | TagRenderingConfigJson)[];
|
|
|
|
/**
|
|
* The icon for an element.
|
|
* Note that this also doubles as the icon for this layer (rendered with the overpass-tags) ánd the icon in the presets.
|
|
*/
|
|
icon?: string | TagRenderingConfigJson;
|
|
|
|
/**
|
|
* A string containing "width,height" or "width,height,anchorpoint" where anchorpoint is any of 'center', 'top', 'bottom', 'left', 'right', 'bottomleft','topright', ...
|
|
* Default is '40,40,center'
|
|
*/
|
|
iconSize?: string | TagRenderingConfigJson;
|
|
/**
|
|
* The rotation of an icon, useful for e.g. directions.
|
|
* Usage: as if it were a css property for 'rotate', thus has to end with 'deg', e.g. `90deg`, `{direction}deg`, `calc(90deg - {camera:direction}deg)``
|
|
*/
|
|
rotation?: string | TagRenderingConfigJson;
|
|
|
|
/**
|
|
* The color for way-elements and SVG-elements.
|
|
* If the value starts with "--", the style of the body element will be queried for the corresponding variable instead
|
|
*/
|
|
color?: string | TagRenderingConfigJson;
|
|
/**
|
|
* The stroke-width for way-elements
|
|
*/
|
|
width?: string | TagRenderingConfigJson;
|
|
|
|
/**
|
|
* A dasharray, e.g. "5 6"
|
|
* The dasharray defines 'pixels of line, pixels of gap, pixels of line, pixels of gap',
|
|
* Default value: "" (empty string == full line)
|
|
*/
|
|
dashArray?: string | TagRenderingConfigJson
|
|
|
|
/**
|
|
* Wayhandling: should a way/area be displayed as:
|
|
* 0) The way itself
|
|
* 1) The centerpoint and the way
|
|
* 2) Only the centerpoint
|
|
*/
|
|
wayHandling?: number;
|
|
|
|
/**
|
|
* Consider that we want to show 'Nature Reserves' and 'Forests'. Now, ofter, there are pieces of forest mapped _in_ the nature reserve.
|
|
* Now, showing those pieces of forest overlapping with the nature reserve truly clutters the map and is very user-unfriendly.
|
|
*
|
|
* The features are placed layer by layer. If a feature below a feature on this layer overlaps for more then 'x'-percent, the underlying feature is hidden.
|
|
*/
|
|
hideUnderlayingFeaturesMinPercentage?:number;
|
|
|
|
/**
|
|
* If set, this layer will pass all the features it receives onto the next layer
|
|
*/
|
|
passAllFeatures?:boolean
|
|
|
|
/**
|
|
* Presets for this layer
|
|
*/
|
|
presets?: {
|
|
title: string | any,
|
|
tags: string[],
|
|
description?: string | any,
|
|
}[],
|
|
|
|
/**
|
|
* All the tag renderings.
|
|
* A tag rendering is a block that either shows the known value or asks a question.
|
|
*
|
|
* Refer to the class `TagRenderingConfigJson` to see the possibilities.
|
|
*
|
|
* Note that we can also use a string here - where the string refers to a tagrenering defined in `assets/questions/questions.json`,
|
|
* where a few very general questions are defined e.g. website, phone number, ...
|
|
*
|
|
*/
|
|
tagRenderings?: (string | TagRenderingConfigJson) []
|
|
} |