From 00f97131f20a149f0595f94adf7cc56d5e46165f Mon Sep 17 00:00:00 2001 From: Sergey Vartanov Date: Sat, 28 Aug 2021 19:05:57 +0300 Subject: [PATCH] Issue #69: add tile server example. --- README.md | 29 +++++++++++++++++++++++++++++ doc/readme.moi | 25 +++++++++++++++++++++++++ 2 files changed, 54 insertions(+) diff --git a/README.md b/README.md index 2855b84..451d10f 100644 --- a/README.md +++ b/README.md @@ -229,6 +229,35 @@ roentgen server Stop server interrupting process with Ctrl + C. +### Example ### + +Create a minimal amount of tiles that cover specified boundary box for zoom levels 16, 17, 18, and 19: + +```bash +roentgen tile -b 2.364,48.854,2.367,48.857 -s 16-19 +``` + +Run tile server on 127.0.0.1:8080: + +```bash +roentgen server +``` + +Use JavaScript code for [Leaflet](https://leafletjs.com/): + +```js +zxy', { + maxZoom: 19, + attribution: 'Map data © ' + + 'OpenStreetMap ' + + 'contributors, imagery © ' + + 'Röntgen', + id: 'roentgen', + tileSize: 256, + zoomOffset: 0 +}).addTo(map); +``` + Map options ----------- diff --git a/doc/readme.moi b/doc/readme.moi index 723294d..fe9cc87 100644 --- a/doc/readme.moi +++ b/doc/readme.moi @@ -244,6 +244,31 @@ Command \m {server} is used to run tile server for slippy maps. Stop server interrupting process with \kbd {Ctrl} + \kbd {C}. +\3 {Example} {example} + +Create a minimal amount of tiles that cover specified boundary box for zoom levels 16, 17, 18, and 19\: + +\code {roentgen tile -b 2.364,48.854,2.367,48.857 -s 16-19} {bash} + +Run tile server on 127.0.0.1\:8080\: + +\code {roentgen server} {bash} + +Use JavaScript code for \ref {https://leafletjs.com/} {Leaflet}\: + +\code {var map = L.map('mapid').setView([48.8555, 2.3655], 18); + +L.tileLayer('http://127.0.0.1:8080/tiles/{z}/{x}/{y}', \{ + maxZoom: 19, + attribution: 'Map data © ' + + 'OpenStreetMap ' + + 'contributors, imagery © ' + + 'Röntgen', + id: 'roentgen', + tileSize: 256, + zoomOffset: 0 +\}).addTo(map);} {js} + \2 {Map options} {map-options} Map configuration options used by \m {render} and \m {tile} commands: