Skip to content

add landcover layer docs #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 28, 2024
Merged

add landcover layer docs #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
028d63c
ignore hidden mac files
nvkelso Mar 28, 2024
35ee25e
[docs] add new landcover layer for #154
nvkelso Mar 28, 2024
179c89a
flesh out landuse kinds and basic layer description
nvkelso Mar 28, 2024
e7e5489
add sport tag, and deprecation note about other OSM tag > key mapping…
nvkelso Mar 28, 2024
31ebf51
add natural, places, pois layers
nvkelso Mar 28, 2024
0352c24
roads, transit, water docs
nvkelso Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.vitepress/cache
.vitepress/dist
.DS_Store
97 changes: 83 additions & 14 deletions basemaps/layers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,39 @@ Polygons from the Natural Earth 50m `land` theme for z0-z4, 10m for z5, preproce
| ----------- | :-------: | -----------: |
| `pmap:kind` | `earth` | |

## landcover

Polygons from the Daylight distribution's [landcover](https://daylightmap.org/2023/10/11/landcover.html) theme, for z0-z7.

| Key | Values | Description |
| ----------- | :-------: | -----------: |
| `pmap:kind` | `barren`, `farmland`, `forest`, `glacier`, `grassland`, `scrub`, `urban_area` | |

_NOTE: It's recommended to pair with **natural** layer polygons from OpenStreetMap at mid- and high-zooms._

## landuse

`kind`
Polygons from OpenStreetMap, from a curated subset of aeroway, amenity, area:aeroway, boundary, highway, landuse, leisure, man_made, natural, place, railway, tourism tags, for all zooms.

| Key | Values | Description |
| ----------- | :-------: | -----------: |
| `pmap:kind` | `aerodrome`, `attraction`, `beach`, `cafe`, `camp_site`, `cemetery`, `college`, `commercial`, `dog_park`, `farmland`, `farmyard`, `footway`, `forest`, `garden`, `golf_course`, `grass`, `grocery`, `hospital`, `hotel`, `industrial`, `kindergarten`, `library`, `marina`, `military`, `national_park`, `nature_reserve`, `neighbourhood`, `orchard`, `other`, `park`, `pedestrian`, `pier`, `pitch`, `platform`, `playground`, `post_office`, `protected_area`, `railway`, `recreation_ground`, `residential`, `runway`, `school`, `stadium`, `supermarket`, `taxiway`, `townhall`, `university`, `zoo` | |
| `sport` | string | Which sports are played on a pitch. |

_NOTE: Additional keys are available for each original OSM tags (when available), but those will be deprecated in the next major version so should not be used for styling._

## natural

Polygons from OpenStreetMap, from a curated subset of natural and landuse tags, for all zooms.

<MaplibreMap/>

| Key | Values | Description |
| ----------- | :-------: | -----------: |
| `pmap:kind` | `wood`, `glacier`, `grass`, `scrub`, `sand`, `wetland`, `bare_rock`, `forest`, `meadow`, `grass` | |

_NOTE: It's recommended to pair with **landcover** layer polygons from Daylight at low-zooms._

## physical_line

::: warning
Expand All @@ -68,35 +93,79 @@ physical_line will be deprecated in v4.0.
physical_point will be deprecated in v4.0.
:::


## places

`kind`
Points from OpenStreetMap and Natural Earth, from a curated subset of place tags, for all zooms.


| Key | Values | Description |
| ----------- | :-------: | -----------: |
| `pmap:kind` | `country`, `region`, `locality`, `macrohood`, `neighbourhood` | |
| `pmap:kind_detail` | `city`, `country`, `hamlet`, `neighbourhood`, `province`, `quarter`, `scientific_station`, `state`, `town`, `village` | |
| `capital` | string | |
| `population` | int | |
| `pmap:population_rank` | int | |
| `wikidata` | string | |

_NOTE: Additional keys are available for each original OSM tags (when available), but those will be deprecated in the next major version so should not be used for styling._

## pois

`kind`
Points from OpenStreetMap, from a curated subset of aeroway, amenity, attraction, boundary, craft, highway, historic, landuse, leisure, natural, railway, shop, tourism tags, for all zooms.

| Key | Values | Description |
| ----------- | :-------: | -----------: |
| `pmap:kind` | `aerodrome`, `adult_gaming_centre`, `airfield`, `alpine_hut`, `amusement_ride`, `animal`, `art`, `artwork`, `atm`, `attraction`, `atv`, `baby_hatch`, `bakery`, `bbq`, `beauty`, `bed_and_breakfast`, `bench`, `bicycle_parking`, `bicycle_rental`, `bicycle_repair_station`, `boat_storage`, `bookmaker`, `books`, `bureau_de_change`, `bus_stop`, `butcher`, `cafe`, `camp_site`, `car_parts`, `car_rental`, `car_repair`, `car_sharing`, `car_wash`, `car`, `carousel`, `cemetery`, `chalet`, `charging_station`, `childcare`, `clinic`, `clothes`, `college`, `computer`, `convenience`, `customs`, `dentist`, `district`, `doctors`, `dog_park`, `drinking_water`, `emergency_phone`, `fashion`, `firepit`, `fishing`, `florist`, `forest`, `fuel`, `gambling`, `garden_centre`, `gift`, `golf_course`, `golf`, `greengrocer`, `grocery`, `guest_house`, `hairdresser`, `hanami`, `harbourmaster`, `hifi`, `hospital`, `hostel`, `hotel`, `hunting_stand`, `information`, `jewelry`, `karaoke_box`, `karaoke`, `landmark`, `library`, `life_ring`, `lottery`, `marina`, `maze`, `memorial`, `military`, `mobile_phone`, `money_transfer`, `motorcycle_parking`, `motorcycle`, `national_park`, `naval_base`, `newsagent`, `optician`, `park`, `parking`, `perfumery`, `picnic_site`, `picnic_table`, `pitch`, `playground`, `post_box`, `post_office`, `ranger_station`, `recycling`, `roller_coaster`, `sanitary_dump_station`, `school`, `scuba_diving`, `shelter`, `ship_chandler`, `shower`, `slipway`, `snowmobile`, `social_facility`, `stadium`, `stationery`, `studio`, `summer_toboggan`, `supermarket`, `swimming_area`, `taxi`, `telephone`, `tobacco`, `toilets`, `townhall`, `trail_riding_station`, `travel_agency`, `university`, `viewpoint`, `waste_basket`, `waste_disposal`, `water_point`, `water_slide`, `watering_place`, `wayside_cross`, `wilderness_hut` | |
| `cuisine` | string | |
| `religion` | string | |
| `sport` | string | |
| `iata` | string | |

_NOTE: The list of kind values is not comprehensive as some raw OSM tag values are passed through in the current version._

## roads

`kind`
Lines from OpenStreetMap, from a curated subset of highway tags, for mid- and high-zooms.

| Key | Values | Description |
| ----------- | :-------: | -----------: |
| `pmap:kind` | `highway`, `major_road`, `medium_road`, `minor_road`, `path`, `other` | |
| `pmap:kind_detail` | `motorway`, `motorway_link`, `trunk`, `trunk_link`, `primary`, `primary_link`, `secondary`, `secondary_link`, `tertiary`, `tertiary_link`, `residential`, `service`, `unclassified`, `road`, `raceway`, `pedestrian`, `track`, `path`, `cycleway`, `bridleway`, `steps`, `corridor`, `sidewalk`, `crossing`, `driveway`, `parking_aisle`, `alley`, `drive-through`, `emergency_access`, `utility`, `irrigation`, `slipway` | |
| `ref` | string | |
| `shield_text_length` | int | |
| `network` | string | |
| `layer` | int | |
| `oneway` | string | |
| `service` | string | |
| `pmap:link` | int | |
| `pmap:level` | `-1`, `0`, `1` | |


## transit

`kind`
Lines from OpenStreetMap, from a curated subset of railway, aerialway, man_made, route, and aeroway tags, for mid- and high-zooms.

| Key | Values | Description |
| ----------- | :-------: | -----------: |
| `pmap:kind` | `aerialway`, `cable_car`, `crossover`, `ferry`, `pier`, `rail`, `runway`, `siding`, `taxiway`, `yard` | |
| `pmap:kind_detail` | `disused`, `funicular`, `light_rail`, `miniature`, `monorail`, `narrow_gauge`, `preserved`, `railway`, `subway`, `tram` | |
| `ref` | string | |
| `network` | string | |
| `layer` | int | |
| `route` | string | |
| `service` | string | |

## water

Polygons from the Natural Earth 50m `lakes` and `ocean` themes for z0-z4, 10m for z5, preprocessed land polygons from [OSMCoastline](https://osmdata.openstreetmap.de) for z6+.


| Key | Values | Description |
| ------------------ | :------------------------------------------: | -----------: |
| `pmap:kind` | `water`, `lake`, `playa`, `ocean`, `other` | |
| `pmap:kind_detail` | | |
| `reservoir` | | |
| `alkaline` | | |
| `intermittent` | | |
| `bridge` | | |
| `tunnel` | | |
| `layer` | | |
| `pmap:kind_detail` | `basin`, `canal`, `ditch`, `dock`, `drain`, `lake`, `reservoir`, `river`, `riverbank`, `stream` | |
| `reservoir` | boolean | |
| `alkaline` | boolean | |
| `intermittent` | boolean | |
| `bridge` | string | |
| `tunnel` | string | |
| `layer` | int | |
Loading