:tocdepth: 3

:py:mod:`gws.gis.mpx.util`
==========================

.. py:module:: gws.gis.mpx.util

.. autoapi-nested-parse::

   Utility functions for MapProxy integration.

   This module provides utilities for annotating and decorating MapProxy images.



**Source code:** :source:`gws.gis.mpx.util<gws/gis/mpx/util.py>`



Module Contents
---------------



.. py:function:: annotate(image: Any, service: str, layers: List[str], environ: Dict[str, Any], query_extent: Tuple[Any, Any], **kw: Any) -> mapproxy.image.ImageSource

   Annotate a MapProxy image with request information.

   This function is used as a callback for MapProxy's decorate_img middleware.
   It adds text information about the request to the image.

   :param image: The MapProxy image object to annotate.
   :param service: The OWS service name (WMS, WMTS, etc.).
   :param layers: List of requested layer names.
   :param environ: The WSGI environment dictionary.
   :param query_extent: A tuple containing SRS and coordinate information.
   :param \*\*kw: Additional keyword arguments.

   :returns: An ImageSource object with the annotated image.


.. py:class:: AnnotationFilter(app: Any)


   Bases: :py:obj:`object`

   Simple MapProxy decorate_img middleware.

   This middleware annotates map images with information about the request.
   It can be used to debug MapProxy requests by adding visual information
   to the returned images.

   .. py:attribute:: app