20d9e1028c
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Bart Louwers <bart@emeel.net>
110 lines
4.5 KiB
Plaintext
110 lines
4.5 KiB
Plaintext
<%
|
||
const os = locals.os;
|
||
const iOS = os === 'iOS';
|
||
//const macOS = os === 'macOS';
|
||
//const cocoaPrefix = iOS ? 'UI' : 'NS';
|
||
-%>
|
||
<!--
|
||
This file is generated.
|
||
Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`.
|
||
-->
|
||
# Tile URL Templates
|
||
|
||
`MLNTileSource` objects, specifically `MLNRasterTileSource` and
|
||
`MLNVectorTileSource` objects, can be created using an initializer that accepts
|
||
an array of tile URL templates. Tile URL templates are strings that specify the
|
||
URLs of the vector tiles or raster tile images to load. A template resembles an
|
||
absolute URL, but with any number of placeholder strings that the source
|
||
evaluates based on the tile it needs to load. For example:
|
||
|
||
* `http://www.example.com/tiles/{z}/{x}/{y}.pbf` could be
|
||
evaluated as `http://www.example.com/tiles/14/6/9.pbf`.
|
||
* `http://www.example.com/tiles/{z}/{x}/{y}{ratio}.png` could be
|
||
evaluated as `http://www.example.com/tiles/14/6/9@2x.png`.
|
||
|
||
Tile URL templates are also used to define tilesets in TileJSON manifests or
|
||
[`raster`](https://maplibre.org/maplibre-style-spec/sources/#raster-tiles)
|
||
and
|
||
[`vector`](https://maplibre.org/maplibre-style-spec/sources/#vector-tiles)
|
||
sources in style JSON files. See the
|
||
[TileJSON specification](https://github.com/mapbox/tilejson-spec/tree/master/2.2.0)
|
||
for information about tile URL templates in the context of a TileJSON or style
|
||
JSON file.
|
||
|
||
Tile sources support the following placeholder strings in tile URL templates,
|
||
all of which are optional:
|
||
|
||
<table>
|
||
<thead>
|
||
<tr><th>Placeholder string</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code>{x}</code></td>
|
||
<td>The index of the tile along the map’s x axis according to Spherical
|
||
Mercator projection. If the value is 0, the tile’s left edge corresponds
|
||
to the 180th meridian west. If the value is 2<sup><var>z</var></sup>−1,
|
||
the tile’s right edge corresponds to the 180th meridian east.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>{y}</code></td>
|
||
<td>The index of the tile along the map’s y axis according to Spherical
|
||
Mercator projection. If the value is 0, the tile’s tile edge corresponds
|
||
to arctan(sinh(π)), or approximately 85.0511 degrees north. If the value
|
||
is 2<sup><var>z</var></sup>−1, the tile’s bottom edge corresponds to
|
||
−arctan(sinh(π)), or approximately 85.0511 degrees south. The y axis is
|
||
inverted if the <code>options</code> parameter contains
|
||
<code>MLNTileSourceOptionTileCoordinateSystem</code> with a value of
|
||
<code>MLNTileCoordinateSystemTMS</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>{z}</code></td>
|
||
<td>The tile’s zoom level. At zoom level 0, each tile covers the entire
|
||
world map; at zoom level 1, it covers ¼ of the world; at zoom level 2,
|
||
<sup>1</sup>⁄<sub>16</sub> of the world, and so on. For tiles loaded by
|
||
a <code>MLNRasterTileSource</code> object, whether the tile zoom level
|
||
matches the map’s current zoom level depends on the value of the
|
||
source’s tile size as specified in the
|
||
<code>MLNTileSourceOptionTileSize</code> key of the <code>options</code>
|
||
parameter.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>{bbox-epsg-3857}</code></td>
|
||
<td>The tile’s bounding box, expressed as a comma-separated list of the
|
||
tile’s western, southern, eastern, and northern extents according to
|
||
Spherical Mercator (EPSG:3857) projection. The bounding box is typically
|
||
used with map services conforming to the
|
||
<a href="http://www.opengeospatial.org/standards/wms">Web Map Service</a>
|
||
protocol.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>{quadkey}</code></td>
|
||
<td>A quadkey indicating both the tile’s location and its zoom level. The
|
||
quadkey is typically used with
|
||
<a href="https://msdn.microsoft.com/en-us/library/bb259689.aspx">Bing Maps</a>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>{ratio}</code></td>
|
||
<td>A suffix indicating the resolution of the tile image. The suffix is the
|
||
empty string for standard resolution displays and <code>@2x</code> for
|
||
<% if (iOS) { -%>
|
||
Retina displays, including displays for which <code>UIScreen.scale</code>
|
||
is 3.
|
||
<% } else { -%>
|
||
Retina displays.
|
||
<% } -%>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>{prefix}</code></td>
|
||
<td>Two hexadecimal digits chosen such that each visible tile has a
|
||
different prefix. The prefix is typically used for domain sharding.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
For more information about the `{x}`, `{y}`, and `{z}` placeholder strings,
|
||
consult the
|
||
[OpenStreetMap Wiki](https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames).
|