mirror of
https://github.com/maptiler/tileserver-gl.git
synced 2024-09-11 12:05:41 +03:00
Add undocumented options to docs (#1063)
* chore: add undocumented options to docs, more details, small fixes Signed-off-by: Martin d'Allens <martin.dallens@liberty-rider.com> * docs: update readthedocs.io URL Signed-off-by: Martin d'Allens <martin.dallens@liberty-rider.com> --------- Signed-off-by: Martin d'Allens <martin.dallens@liberty-rider.com>
This commit is contained in:
parent
7d06f216a8
commit
cef150431b
@ -28,8 +28,8 @@ docker build -t tileserver-gl-light .
|
|||||||
[Download from OpenMapTiles.com](https://openmaptiles.com/downloads/planet/) or [create](https://github.com/openmaptiles/openmaptiles) your vector tile, and run following in directory contains your *.mbtiles.
|
[Download from OpenMapTiles.com](https://openmaptiles.com/downloads/planet/) or [create](https://github.com/openmaptiles/openmaptiles) your vector tile, and run following in directory contains your *.mbtiles.
|
||||||
|
|
||||||
```
|
```
|
||||||
docker run --rm -it -v $(pwd):/data -p 8000:80 tileserver-gl-light
|
docker run --rm -it -v $(pwd):/data -p 8080:8080 tileserver-gl-light
|
||||||
```
|
```
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
You can read full documentation of this project at https://tileserver.readthedocs.io/.
|
You can read full documentation of this project at https://maptiler-tileserver.readthedocs.io/
|
||||||
|
@ -132,6 +132,19 @@ If you have plenty of memory, try setting these equal to or slightly above your
|
|||||||
If you need to conserve memory, try lower values for scale factors that are less common.
|
If you need to conserve memory, try lower values for scale factors that are less common.
|
||||||
Default is ``[16, 8, 4]``.
|
Default is ``[16, 8, 4]``.
|
||||||
|
|
||||||
|
``pbfAlias``
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
Some CDNs did not handle .pbf extension as a static file correctly.
|
||||||
|
The default URLs (with .pbf) are always available, but an alternative can be set.
|
||||||
|
An example extension suffix would be ".pbf.pict".
|
||||||
|
|
||||||
|
``serveAllFonts``
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
If this option is enabled, all the fonts from the ``paths.fonts`` will be served.
|
||||||
|
Otherwise only the fonts referenced by available styles will be served.
|
||||||
|
|
||||||
``serveAllStyles``
|
``serveAllStyles``
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
@ -139,10 +152,16 @@ If this option is enabled, all the styles from the ``paths.styles`` will be serv
|
|||||||
The process will also watch for changes in this directory and remove/add more styles dynamically.
|
The process will also watch for changes in this directory and remove/add more styles dynamically.
|
||||||
It is recommended to also use the ``serveAllFonts`` option when using this option.
|
It is recommended to also use the ``serveAllFonts`` option when using this option.
|
||||||
|
|
||||||
|
``serveStaticMaps``
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
If this option is enabled, all the static map endpoints will be served.
|
||||||
|
Default is ``true``.
|
||||||
|
|
||||||
``watermark``
|
``watermark``
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
Optional string to be rendered into the raster tiles (and static maps) as watermark (bottom-left corner).
|
Optional string to be rendered into the raster tiles and static maps as watermark (bottom-left corner).
|
||||||
Not used by default.
|
Not used by default.
|
||||||
|
|
||||||
``staticAttributionText``
|
``staticAttributionText``
|
||||||
|
@ -52,14 +52,14 @@ Static images
|
|||||||
|
|
||||||
* can be provided multiple times
|
* can be provided multiple times
|
||||||
|
|
||||||
* ``latlng`` - indicates coordinates are in ``lat,lng`` order rather than the usual ``lng,lat``
|
* ``latlng`` - indicates coordinates are in ``lat,lng`` order rather than the usual ``lng,lat`` for paths and markers
|
||||||
* ``fill`` - color to use as the fill (e.g. ``red``, ``rgba(255,255,255,0.5)``, ``#0000ff``)
|
* ``fill`` - default color to use as the fill (e.g. ``red``, ``rgba(255,255,255,0.5)``, ``#0000ff``) for all paths
|
||||||
* ``stroke`` - color of the path stroke
|
* ``stroke`` - default color of the path stroke for all paths
|
||||||
* ``width`` - width of the stroke
|
* ``width`` - default width of the stroke for all paths
|
||||||
* ``linecap`` - rendering style for the start and end points of the path
|
* ``linecap`` - rendering style for the start and end points of all paths - see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
|
||||||
* ``linejoin`` - rendering style for overlapping segments of the path with differing directions
|
* ``linejoin`` - rendering style for joining successive segments of all paths when the direction changes - see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
|
||||||
* ``border`` - color of the optional border path stroke
|
* ``border`` - color of the optional border stroke for all paths ; the border is like a halo around the stroke
|
||||||
* ``borderwidth`` - width of the border stroke (default 10% of width)
|
* ``borderwidth`` - width of the border stroke (default 10% of stroke width) for all paths
|
||||||
* ``marker`` - Marker in format ``lng,lat|iconPath|option|option|...``
|
* ``marker`` - Marker in format ``lng,lat|iconPath|option|option|...``
|
||||||
|
|
||||||
* Will be rendered with the bottom center at the provided location
|
* Will be rendered with the bottom center at the provided location
|
||||||
|
Loading…
Reference in New Issue
Block a user