mapcomplete/Docs/BuiltinLayers.md

Special and other useful layers

Table of contents

1. Special and other useful layers
2. Priviliged layers
   • gps_location
   • gps_location_history
   • home_location
   • gps_track
   • type_node
   • conflation
   • left_right_style
   • split_point
3. Frequently reused layers
   • bicycle_library
     • Themes using this layer
   • drinking_water
     • Themes using this layer
   • food
     • Themes using this layer
   • map
     • Themes using this layer
   • walls_and_buildings
     • Themes using this layer
   • all_streets
     • Themes using this layer

MapComplete has a few data layers available in the theme which have special properties through builtin-hooks. Furthermore, there are some normal layers (which are built from normal Theme-config files) but are so general that they get a mention here.

Priviliged layers

• gps_location
• gps_location_history
• home_location
• gps_track
• type_node
• conflation
• left_right_style
• split_point

gps_location

Meta layer showing the current location of the user. Add this to your theme and override the icon to change the appearance of the current location. The object will always have id=gps and will have all the properties included in the Coordinates-object returned by the browser.

Go to the source code

• This layer is included automatically in every theme. This layer might contain no points
• Not clickable by default. If you import this layer in your theme, override title to make this clickable
• Not visible in the layer selection by default. If you want to make this layer toggable, override name

gps_location_history

Meta layer which contains the previous locations of the user as single points. This is mainly for technical reasons, e.g. to keep match the distance to the modified object

Go to the source code

• This layer is included automatically in every theme. This layer might contain no points
• Not clickable by default. If you import this layer in your theme, override title to make this clickable
• Not visible in the layer selection by default. If you want to make this layer toggable, override name
• Not rendered on the map by default. If you want to rendering this on the map, override mapRenderings

home_location

Meta layer showing the home location of the user. The home location can be set in the profile settings of OpenStreetMap.

Go to the source code

• This layer is included automatically in every theme. This layer might contain no points
• Not clickable by default. If you import this layer in your theme, override title to make this clickable
• Not visible in the layer selection by default. If you want to make this layer toggable, override name

gps_track

Meta layer showing the previous locations of the user as single line. Add this to your theme and override the icon to change the appearance of the current location.

Go to the source code

• This layer is included automatically in every theme. This layer might contain no points
• Not rendered on the map by default. If you want to rendering this on the map, override mapRenderings

type_node

This is a priviliged meta_layer which exports every point in OSM. This only works if zoomed below the point that the full tile is loaded (and not loaded via Overpass). Note that this point will also contain a property parent_ways which contains all the ways this node is part of as a list. This is mainly used for extremely specialized themes, which do advanced conflations. Expert use only.

Go to the source code

• Not rendered on the map by default. If you want to rendering this on the map, override mapRenderings

conflation

If the import-button is set to conflate two ways, a preview is shown. This layer defines how this preview is rendered. This layer cannot be included in a theme.

Go to the source code

• This layer can not be included in a theme. It is solely used by special renderings showing a minimap with custom data.

left_right_style

Special meta-style which will show one single line, either on the left or on the right depending on the id. This is used in the small popups with left_right roads. Cannot be included in a theme

Go to the source code

• This layer can not be included in a theme. It is solely used by special renderings showing a minimap with custom data.

split_point

Layer rendering the little scissors for the minimap in the 'splitRoadWizard'

Go to the source code

• This layer can not be included in a theme. It is solely used by special renderings showing a minimap with custom data.

Frequently reused layers

The following layers are used by at least 2 mapcomplete themes and might be interesting for your custom theme too

• bicycle_library
• drinking_water
• food
• map
• walls_and_buildings
• all_streets

bicycle_library

A facility where bicycles can be lent for longer period of times

Go to the source code

Themes using this layer

• bicyclelib
• cyclofix

drinking_water

Go to the source code

Themes using this layer

• cyclofix
• drinking_water
• nature

food

Go to the source code

Themes using this layer

• food
• fritures

map

A map, meant for tourists which is permanently installed in the public space

Go to the source code

Themes using this layer

• maps
• nature

walls_and_buildings

Special builtin layer providing all walls and buildings. This layer is useful in presets for objects which can be placed against walls (e.g. AEDs, postboxes, entrances, addresses, surveillance cameras, ...). This layer is invisible by default and not toggleable by the user.

Go to the source code

• Not visible in the layer selection by default. If you want to make this layer toggable, override name
• Not rendered on the map by default. If you want to rendering this on the map, override mapRenderings

Themes using this layer

• aed
• surveillance

all_streets

Go to the source code

• Not rendered on the map by default. If you want to rendering this on the map, override mapRenderings

Themes using this layer

• cyclestreets
• street_lighting

This document is autogenerated from AllKnownLayers.ts