Aontnio Cereicllo
09cb2c07bd
* - refactored mvt classes to support all implemented metadata formats, regardless of the provider * - fixed formatting issues * Implementing basic tile metadata methods * Fixing yml models * Adding additional format * Fixing schema set on load * Removing unused field from documentation * Change method name to generic vendor * Keeping extra metadata info for tippecanoe provider * Fix flake validations error --------- Co-authored-by: doublebyte <doublebyte@hushmail.com>
110 lines
4.1 KiB
ReStructuredText
110 lines
4.1 KiB
ReStructuredText
.. _ogcapi-tiles:
|
|
|
|
Publishing tiles to OGC API - Tiles
|
|
=======================================
|
|
|
|
`OGC API - Tiles`_ provides access to geospatial data in the form of tiles
|
|
(map, vector, coverage, etc.).
|
|
|
|
pygeoapi can publish tiles from local or remote data sources (including cloud
|
|
object storage or a tile service).
|
|
|
|
Providers
|
|
---------
|
|
|
|
pygeoapi core tile providers are listed below, along with supported features.
|
|
|
|
.. csv-table::
|
|
:header: Provider, rendered on-the-fly, properties
|
|
:align: left
|
|
|
|
`MVT-tippecanoe`_,❌,✅
|
|
`MVT-elastic`_,✅,❌
|
|
|
|
Below are specific connection examples based on supported providers.
|
|
|
|
.. note::
|
|
Currently only `Mapbox Vector Tiles (MVT) <https://github.com/mapbox/vector-tile-spec>`_ are supported in pygeoapi.
|
|
|
|
Connection examples
|
|
-------------------
|
|
|
|
MVT-tippecanoe
|
|
^^^^^^^^^^^^^^
|
|
|
|
This provider gives support to serving tiles generated using `Mapbox Tippecanoe <https://github.com/mapbox/tippecanoe>`_.
|
|
The tiles can be integrated from a path on disk, or from a static url (e.g.: from an S3 or MinIO bucket).
|
|
In both cases, they have to be rendered before using pygeoapi.
|
|
|
|
This code block shows how to configure pygeoapi to read Mapbox vector tiles generated with tippecanoe, from disk or a URL.
|
|
|
|
.. code-block:: yaml
|
|
|
|
providers:
|
|
- type: tile
|
|
name: MVT-tippecanoe
|
|
data: tests/data/tiles/ne_110m_lakes # local directory tree
|
|
# data: http://localhost:9000/ne_110m_lakes/{z}/{x}/{y}.pbf # tiles stored on a MinIO bucket
|
|
options:
|
|
zoom:
|
|
min: 0
|
|
max: 5
|
|
schemes:
|
|
- WorldCRS84Quad
|
|
format:
|
|
name: pbf
|
|
mimetype: application/vnd.mapbox-vector-tile
|
|
|
|
.. tip::
|
|
On `this tutorial <https://dive.pygeoapi.io/publishing/ogcapi-tiles/#publish-pre-rendered-vector-tiles>`_ you can find detailed instructions on how-to generate tiles using tippecanoe and integrate them into pygeoapi.
|
|
|
|
MVT-elastic
|
|
^^^^^^^^^^^^
|
|
|
|
This provider gives support to serving tiles generated using `Elasticsearch <https://www.elastic.co/>`_.
|
|
These tiles are rendered on-the-fly using the `Elasticsearch Vector tile search API <https://www.elastic.co/guide/en/elasticsearch/reference/current/search-vector-tile-api.html>`_.
|
|
In order to use it, the only requirement is to have the data stored in an Elasticsearch index.
|
|
|
|
This code block shows how to configure pygeoapi to read Mapbox vector tiles from an Elasticsearch endpoint.
|
|
|
|
.. code-block:: yaml
|
|
|
|
providers:
|
|
- type: tile
|
|
name: MVT-elastic
|
|
data: http://localhost:9200/ne_110m_populated_places_simple2/_mvt/geometry/{z}/{x}/{y}?grid_precision=0
|
|
# if you don't use precision 0, you will be requesting for aggregations which are not supported in the
|
|
# free version of elastic
|
|
options:
|
|
zoom:
|
|
min: 0
|
|
max: 5
|
|
schemes:
|
|
- WorldCRS84Quad
|
|
format:
|
|
name: pbf
|
|
mimetype: application/vnd.mapbox-vector-tile
|
|
|
|
.. tip::
|
|
On `this tutorial <https://dive.pygeoapi.io/publishing/ogcapi-tiles/#publish-vector-tiles-from-elasticsearch>`_ you can find detailed instructions on publish tiles stored in an Elasticsearch endpoint.
|
|
|
|
Data access examples
|
|
--------------------
|
|
|
|
* list all collections
|
|
* http://localhost:5000/collections
|
|
* overview of dataset
|
|
* http://localhost:5000/collections/foo
|
|
* overview of dataset tiles
|
|
* http://localhost:5000/collections/foo/tiles
|
|
* tile matrix metadata
|
|
* http://localhost:5000/collections/lakes/tiles/WorldCRS84Quad/metadata
|
|
* tiles URI template
|
|
* `http://localhost:5000/collections/lakes/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}?f=mvt <http://localhost:5000/collections/lakes/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}?f=mvt>`_
|
|
|
|
|
|
.. _`OGC API - Tiles`: https://github.com/opengeospatial/ogcapi-tiles
|
|
.. _`tippecanoe`: https://github.com/mapbox/tippecanoe
|
|
.. _`Elasticsearch`: https://www.elastic.co/
|
|
.. _`Mapbox Vector Tiles`: https://docs.mapbox.com/data/tilesets/guides/vector-tiles-introduction/
|