output.rst 2.1 KB

1234567891011121314151617181920212223242526272829303132
  1. MBTiles Output Format
  2. ============================
  3. MBTiles WMS Output Format
  4. --------------------------
  5. Any WMS :ref:`wms_getmap` request can be returned in the form of a Geopackage by specifying ``format=mbtiles`` as output format (see :ref:`wms_output_formats`). \
  6. The returned result will be an MBTiles file with a single tile layer.
  7. The following additional parameters can be passed on using :ref:`format_options`:
  8. * ``tileset_name``: name to be used for tileset in mbtiles file (default is name of layer(s)).
  9. * ``min_zoom``, ``max_zoom``, ``min_column``, ``max_column``, ``min_row``, ``max_row``: set the minimum and maximum zoom level, column, and rows
  10. * ``gridset``: name of gridset to use (otherwise default for CRS is used)
  11. .. warning:: The GetMap request won't be subject to any execution time limit, a client can thus make request that will takes very long times to execute by providing a high max_zoom value.
  12. MBTiles WPS Process
  13. ----------------------
  14. It is possible to generate an ``mbtiles`` file by calling the WPS process ``gs:MBTiles``. This process requires the following parameters:
  15. * ``layername``: Name of the input layer.
  16. * ``format`` : format of the final images composing the file.
  17. * ``minZoom``, ``maxZoom``, ``minColumn``, ``maxColumn``, ``minRow``, ``maxRow``: *(Optional)* set the minimum and maximum zoom level, column, and rows.
  18. * ``boundingbox``: *(Optional)* Bounding box of the final mbtiles. If CRS is not set, the layer native one is used.
  19. * ``filename``: *(Optional)* name of the mbtiles file created.
  20. * ``bgColor``: *(Optional)* value associated to the background colour.
  21. * ``transparency``: *(Optional)* parameter indicating if the transparency must be present.
  22. * ``stylename``, ``stylepath``, ``stylebody``: *(Optional)* style to associate to the layer. Only one of these 3 parameters can be used.
  23. The process returns an URL containing the path of the generated file.
  24. .. warning:: The process implementation does not currently support cancellation, a client can thus make request that will takes very long times to execute by providing a high max_zoom value.