manual:advanced:customization:online_maps
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
| manual:advanced:customization:online_maps [2015/05/22 14:45] – mstupka | manual:advanced:customization:online_maps [2017/08/14 15:44] – mstupka | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ---- | ---- | ||
| - | <WRAP todo round center 60%>Page under re-construction</ | + | |
| ===== Basic information ===== | ===== Basic information ===== | ||
| - | | + | * **XML file** - contains description of Online map providers (more below). Name and path to this file on storage card (or internal memory) is /// |
| - | | + | * **PNG images (optional)** - for every map provider name. This icon is not required! It's just displayed next to the map name in the Map manager. Name of this icon should be the same as text in name tag. |
| - | * **PNG images (optional)** - for every map provider name. This icon is not required! It's just displayed next to maps in Online | + | |
| - | ===== Example | + | ===== Sample |
| - | Example | + | A example |
| - | + | ||
| - | - layer is background, which is not visible in list but required. | + | |
| - | - layer is contour layer, which is visible but not really required. On some places should not be this layer, so when server return 404 code for tile, you can still see background layer! | + | |
| - | - layer is shade. This layer will be visible is map list, so fill correct " | + | |
| + | - background layer not visible in the map list but required. | ||
| + | - contour layer, visible but not really required. If this layer is not visible on some places and when the server returns 404 code for missing tiles you can still see background layer. | ||
| + | - shade layer, also not required. This layer is visible in the map list - fill correct " | ||
| + | Referer added to the header is not recommended in this case. | ||
| ==== Map code in providers.xml file ==== | ==== Map code in providers.xml file ==== | ||
| - | |||
| - | Example of OpenPiste map (OSM based) created from two layers here (in app is together with third shade layer). First layer is background, which is not visible in list but required. Second is contour layer, which is visible but not really required. On some places should not be this layer so when server return 404 code for tile, you can still see background layer! Referer added to header is not recommended in this case. It's only as example. | ||
| <code xml providers.xml> | <code xml providers.xml> | ||
| Line 61: | Line 58: | ||
| ==== Specifications of map definition ==== | ==== Specifications of map definition ==== | ||
| - | * **id** - required | + | * **id** - required |
| * **type** - type of map provider | * **type** - type of map provider | ||
| * **0** - Spherical mercator, projection Spheric, inverse Y | * **0** - Spherical mercator, projection Spheric, inverse Y | ||
| Line 68: | Line 65: | ||
| * **3** - Spherical mercator, projection Ellipsoid, normal Y | * **3** - Spherical mercator, projection Ellipsoid, normal Y | ||
| * **4** - Spherical Mercator, projection Spheric, Y from center | * **4** - Spherical Mercator, projection Spheric, Y from center | ||
| - | * **5** - Spherical mercator, projection Spheric, Quadkey map system (more info http:// | + | * **5** - Spherical mercator, projection Spheric, Quadkey map system (more info here: http:// |
| * use {c} for coordinate part only. There are no X, Y, Z coordinates in URL, just {c}! | * use {c} for coordinate part only. There are no X, Y, Z coordinates in URL, just {c}! | ||
| - | * **visible** - if provider | + | * **visible** - visibility of provider in the list |
| - | * **required** - is tile from this provider required? When server returns 404, use rest of multilayer map or not? | + | * **required** - is tile from this provider required? When the server returns 404, use rest of multilayer map or not? |
| * **background** - ID of background layer | * **background** - ID of background layer | ||
| * **name** - name of provider | * **name** - name of provider | ||
| - | * **mode** - little | + | * **mode** - short description |
| * < | * < | ||
| - | * **url** - http:// | + | * **url** - http:// |
| - | * **{x}** - replace by X tile | + | * **{x}** - replaces |
| - | * **{y}** - replace by Y tile | + | * **{y}** - replaces |
| - | * **{z}** - replace by zoom level after applied | + | * **{z}** - replaces |
| - | * **{s}** (optional) - replace by server text | + | * **{s}** (optional) - replaces the server text |
| - | * **serverPart** - you can define | + | * **serverPart** - {s} item can be defined |
| - | * **zoomPart** - {z}-8 - syntax for recompute | + | * **zoomPart** - {z}-8 - syntax for recomputing |
| * **zoomMin** - minimum zoom | * **zoomMin** - minimum zoom | ||
| * **zoomMax** - maximum zoom | * **zoomMax** - maximum zoom | ||
| - | * **tileSize** - size of tiles in pixel | + | * **tileSize** - size of tiles in pixels |
| - | * **countries** - list of countries (separated by comma), where map may be used. These values are used for separating maps in " | + | * **countries** - list of countries (separated by commas) relevant for the map. These values are used for separating maps in " |
| - | * **usage** - list of possible | + | * **usage** - list of possible |
| - | * **extraHeader** - extra Http request that will be added to tile request on server. These additional data consist of two parts with syntax part1# | + | * **extraHeader** - extra Http request that is added to the tile request on server. These additional data consist of two parts with syntax part1# |
| - | * **attribution** - small text displayed at map screen | + | * **attribution** - short text displayed at the bottom of the map screen. Please use this when you're using copyrighted |
| - | ZoomValues (zoomMin, zoomMax) have to be counted as valid zoom level by 2^x. So whole world have one tile 256x256 px, which means 2^8, so X = 8!. That's why almost all maps in Locus start with zoomMin = 8 but have zoomPart {z} - 8. This is because in URL, zooms usually | + | ZoomValues (zoomMin, zoomMax) have to be counted as valid zoom level by 2^x. So the whole World has one tile 256x256 px, which means 2^8, so X = 8!. That's why almost all maps in Locus start with zoomMin = 8 but have zoomPart {z} - 8. This is because in URLs zooms usually |
| - | I'm sure that this solution should be improved so if you have any ideas, tell me. Also if here will be any little bit experienced developer on android, we should | + | This solution should be improved so if you have any ideas, tell us. Also, an experienced |
| - | Now you know syntax of providers, so you should add your custom ones. Please, share links with others and enjoy | + | Now you know syntax of providers so you should add your custom ones. Please, share links with others and enjoy! |
| ==== Hints ==== | ==== Hints ==== | ||
| - | * providers with same name will be grouped together! | + | * providers with the same name will be grouped together |
| - | * if you add PNG icon into custom directory with same name as provider name, icon will be attached | + | * if you add a PNG icon into custom directory with the same name as provider name, it will be attached |
| ===== How to obtain required info ===== | ===== How to obtain required info ===== | ||
| - | Suggested is to use Firefox browser with extension HttpFox | + | We recommend |
| - | * Start Firefox browser and open webpage with map. Nice example | + | * Start Firefox browser and open a webpage with map. Nice example |
| * Open HttpFox from Tools menu or by SHIFT-F2. And press top green Start button. | * Open HttpFox from Tools menu or by SHIFT-F2. And press top green Start button. | ||
| - | * Now zoom by one level and you'll see list of requests on map server. | + | * Now zoom by one level and you'll see the list of requests on the map server. |
| - | * So I' | + | * take selected URL line. Required |
| - | * Rest will be url part, so it will look http:// | + | * the rest is url part so it will look like http:// |
| - | * These are main values needed to add map. Tilesize is usually | + | * These are main values needed to add map. Tilesize is usually |
| {{ : | {{ : | ||
| + | <WRAP center round tip > | ||
| + | Another sample of custom online map can be Strava Global Heatmap XML file that we prepared together with our users. It contains cycling and running layers and can be downloaded {{: | ||
| + | </ | ||
| + | ===== Own Open Map Tile Server ===== | ||
| + | ==== Disabling map downloading limit ==== | ||
| + | If you operate your own map tile server you may need to **cancel tile downloading limit** that is set in Locus by default in order to maintain decent downloading traffic per application: | ||
| + | - Enable mod_headers: | ||
| + | - Edit the Apache configuration file (/ | ||
manual/advanced/customization/online_maps.txt · Last modified: 2023/07/19 08:12 by mstupka
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
