From d35d3df5ec6a2cd6665c4377fbbc5d7a931ab697 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Antonia=20P=C3=A9rez-Cerezo?= <antonia@antonia.is>
Date: Fri, 13 Sep 2024 22:34:50 +0200
Subject: [PATCH] Add adjustable maxzoom level, expand documentation

---
 README.md             | 40 ++++++++++++++++++++++++++++++++++++++++
 frontend/map.js       | 18 ++++++++----------
 scripts/mapbuilder.sh |  3 ++-
 3 files changed, 50 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index c891722..8be3fae 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@ A tool to display maps of lines as vector tiles using leaflet.
 
 * Tippecanoe 
 * ogrmerge (part of gdal-bin in Debian)
+* jq
 
 ## Usage
 
@@ -42,6 +43,44 @@ to be displayed on the map can be deposited in any format understood
 by [ogrmerge](https://gdal.org/programs/ogrmerge.html), for instance,
 GeoJSON or gpx. 
 
+#### layers.json
+
+The metadata for the layers to be rendered is given by the
+`layers.json` file in the input directory. An example layers.json file
+is given below:
+
+```
+{
+		"name" : "My map", 
+		"tilelayer" : {
+				"attribution" : "Map data ©  <a href=\"http://osm.org/copyright\" >OpenStreetMap contributors</a>",
+				"url_template" : "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
+		},
+		"layers": {
+				"tram": {"color": "red", "width": 1.5, "humanname": "Tram"},
+				"train": {"color": "blue", "width": 2, "humanname": "Train"}
+		},
+		"maxZoom": 12
+}
+```
+
+The `name` attribute sets the title of the map. The `tilelayer` sets
+the background tile layer to be displayed (currently only raster tiles
+are supported), with `attribution` stating where the tiles came from,
+while `url_template` tells leaflet where to look for the tiles. 
+
+The `layers` object includes an entry for each layer, indexed by the
+name that each layer has in the `strecken.pmtiles` file (use the
+[PMTiles Viewer](https://pmtiles.io/) for troubleshooting), with
+`color` and `width` specifying how the layer should be rendered, and
+`humanname` being the layer name that should be displayed in the legend.
+
+The `maxZoom` parameter is given to `tippecanoe`, and determines the
+maximum zoom level for which tiles should be rendered, increasing this
+value also increases the size of the `strecken.pmtiles` file. If not
+given explicitly `maxZoom` defaults to 10.
+
+
 ## Troubleshooting
 
 ### My pmtiles file is huge (hundreds of megabytes)
@@ -59,3 +98,4 @@ jq 'del( .features[] .properties )'
 on the input file with excessive metadata. 
 
 
+b
diff --git a/frontend/map.js b/frontend/map.js
index 0e77bfd..7736e51 100644
--- a/frontend/map.js
+++ b/frontend/map.js
@@ -11,15 +11,6 @@ legend.onAdd = function (map) {
 };
 
 
-var strecken = protomapsL.leafletLayer({
-    url: "strecken.pmtiles",
-		maxDataZoom: 10,
-		maxZoom: 19,
-    paintRules: rules,
-		
-});
-
-
 const map = L.map("map", {  center: [52,13], zoom: 3, minZoom: 0 });
 fetch("layers.json")
 		.then((response) => response.json())
@@ -40,7 +31,14 @@ fetch("layers.json")
 								maxZoom: 19,
 								attribution: tiles["attribution"]
 						}
-				)
+				);
+				var strecken = protomapsL.leafletLayer({
+						url: "strecken.pmtiles",
+						maxDataZoom: data["maxZoom"] ?? 10,
+						maxZoom: 19,
+						paintRules: rules,	
+				});
+
 				osm.addTo(map);
 				legend.addTo(map);
 				strecken.addTo(map);
diff --git a/scripts/mapbuilder.sh b/scripts/mapbuilder.sh
index 64c2bdc..c653e6c 100755
--- a/scripts/mapbuilder.sh
+++ b/scripts/mapbuilder.sh
@@ -3,6 +3,7 @@
 
 
 temp=$(mktemp -d)
+zoom=$(jq '.maxZoom // 10' "$1/layers.json")
 
 mkdir "$temp/data"
 for i in "$1/data/"*
@@ -11,7 +12,7 @@ do
 done
 
 
-tippecanoe -aN -z10 -o "$temp/strecken.pmtiles" $temp/*.json
+tippecanoe -aN -z"$zoom" -o "$temp/strecken.pmtiles" $temp/*.json
 
 mv $temp/strecken.pmtiles "$2"