Skip to content

Commit 9f14d31

Browse files
Add more detail about the zoom level of detail
Co-Authored-By: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
1 parent d74f878 commit 9f14d31

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

pygmt/datasets/tile_map.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,17 @@ def load_tile_map(region, zoom="auto", source=None, lonlat=True, wait=0, max_ret
2929
*ymin*, *ymax*]. These coordinates should be in longitude/latitude if
3030
``lonlat=True`` or Spherical Mercator (EPSG:3857) if ``lonlat=False``.
3131
32-
zoom : int
33-
Optional. Level of detail. [Default is 'auto'].
32+
zoom : int or str
33+
Optional. Level of detail. Higher levels (e.g. ``22``) means a zoom
34+
level closer to the Earth's surface, with more tiles covering a smaller
35+
geographical area and thus more detail. Lower levels (e.g. ``0``) means
36+
a zoom level further from the Earth's surface, with less tiles covering
37+
a larger geographical area and thus less detail. [Default is
38+
``"auto"`` to automatically determine the zoom level based on the
39+
bounding box region extent].
40+
41+
Note: the maximum possible zoom level may be smaller than 22, and
42+
depends on what is supported by the chosen web tile provider source.
3443
3544
source : xyzservices.TileProvider or str
3645
Optional. The tile source: web tile provider or path to a local file.

0 commit comments

Comments
 (0)