mapcomplete/Docs/BuiltinLayers.md
2021-11-08 02:36:01 +01:00

5 KiB

Special and other useful layers

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

This layer is included automatically in every theme. This layer might contain no points Go to the source code 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.

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

home_location

This layer is included automatically in every theme. This layer might contain no points Go to the source code Meta layer showing the home location of the user. The home location can be set in the profile settings of OpenStreetMap.

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

type_node

Go to the source code 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.

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

conflation

Go to the source code 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.

left_right_style

Go to the source code 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

  • 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

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

Go to the source code A facility where bicycles can be lent for longer period of times

Themes using this layer

drinking_water

Go to the source code

Themes using this layer

food

Go to the source code

Themes using this layer

map

Go to the source code A map, meant for tourists which is permanently installed in the public space

Themes using this layer

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

This document is autogenerated from AllKnownLayers.ts