From 4dce43f66bc00440a19677f557b309d12effa6ca Mon Sep 17 00:00:00 2001 From: "Nathaniel V. KELSO" Date: Thu, 28 Mar 2024 14:57:27 -0700 Subject: [PATCH] add landcover layer docs (#33) * ignore hidden mac files * [docs] add new landcover layer for #154 * flesh out landuse kinds and basic layer description * add sport tag, and deprecation note about other OSM tag > key mappings without listing them all * add natural, places, pois layers * roads, transit, water docs --- .gitignore | 1 + basemaps/layers.md | 97 +++++++++++++++++++++++++++++++++++++++------- 2 files changed, 84 insertions(+), 14 deletions(-) diff --git a/.gitignore b/.gitignore index b733034..7a7021f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .vitepress/cache .vitepress/dist +.DS_Store diff --git a/basemaps/layers.md b/basemaps/layers.md index 433dda0..151aad6 100644 --- a/basemaps/layers.md +++ b/basemaps/layers.md @@ -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. + +| 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 @@ -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 | |