:tocdepth: 3

:py:mod:`gws.base.map.action`
=============================

.. py:module:: gws.base.map.action

.. autoapi-nested-parse::

   Map related commands.



**Source code:** :source:`gws.base.map.action<gws/base/map/action.py>`



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



.. py:class:: Config


   Bases: :py:obj:`gws.base.action.Config`

   Configuration for the map action.


.. py:class:: DescribeLayerRequest(*args, **kwargs)


   Bases: :py:obj:`gws.Request`

   Command request.

   .. py:attribute:: layerUid
      :type:  str


.. py:class:: DescribeLayerResponse(*args, **kwargs)


   Bases: :py:obj:`gws.Request`

   Command request.

   .. py:attribute:: content
      :type:  str


.. py:class:: GetBoxRequest(*args, **kwargs)


   Bases: :py:obj:`gws.Request`

   Command request.

   .. py:attribute:: bbox
      :type:  gws.Extent

   .. py:attribute:: compositeLayerUids
      :type:  Optional[list[str]]

   .. py:attribute:: crs
      :type:  Optional[gws.CrsName]

   .. py:attribute:: dpi
      :type:  Optional[int]

   .. py:attribute:: height
      :type:  int

   .. py:attribute:: layerUid
      :type:  str

   .. py:attribute:: width
      :type:  int


.. py:class:: GetFeaturesRequest(*args, **kwargs)


   Bases: :py:obj:`gws.Request`

   Command request.

   .. py:attribute:: bbox
      :type:  Optional[gws.Extent]

   .. py:attribute:: crs
      :type:  Optional[gws.CrsName]

   .. py:attribute:: layerUid
      :type:  str

   .. py:attribute:: limit
      :type:  int
      :value: 0


   .. py:attribute:: modelUid
      :type:  Optional[str]

   .. py:attribute:: resolution
      :type:  Optional[float]

   .. py:attribute:: views
      :type:  Optional[list[str]]


.. py:class:: GetFeaturesResponse(*args, **kwargs)


   Bases: :py:obj:`gws.Response`

   Command response.

   .. py:attribute:: features
      :type:  list[gws.FeatureProps]


.. py:class:: GetLegendRequest(*args, **kwargs)


   Bases: :py:obj:`gws.Request`

   Command request.

   .. py:attribute:: layerUid
      :type:  str


.. py:class:: GetXyzRequest(*args, **kwargs)


   Bases: :py:obj:`gws.Request`

   Command request.

   .. py:attribute:: layerUid
      :type:  str

   .. py:attribute:: x
      :type:  int

   .. py:attribute:: y
      :type:  int

   .. py:attribute:: z
      :type:  int


.. py:class:: ImageResponse(*args, **kwargs)


   Bases: :py:obj:`gws.Response`

   Command response.

   .. py:attribute:: content
      :type:  bytes

   .. py:attribute:: mime
      :type:  str


.. py:class:: Object


   Bases: :py:obj:`gws.base.action.Object`

   .. py:method:: api_get_box(req: gws.WebRequester, p: GetBoxRequest) -> ImageResponse

      Get a part of the map inside a bounding box


   .. py:method:: api_get_features(req: gws.WebRequester, p: GetFeaturesRequest) -> GetFeaturesResponse

      Get a list of features in a bounding box


   .. py:method:: api_get_legend(req: gws.WebRequester, p: GetLegendRequest) -> ImageResponse

      Get a legend for a layer


   .. py:method:: api_get_xyz(req: gws.WebRequester, p: GetXyzRequest) -> ImageResponse

      Get an XYZ tile


   .. py:method:: describe_layer(req: gws.WebRequester, p: DescribeLayerRequest) -> DescribeLayerResponse

   .. py:method:: http_get_box(req: gws.WebRequester, p: GetBoxRequest) -> gws.ContentResponse

   .. py:method:: http_get_features(req: gws.WebRequester, p: GetFeaturesRequest) -> gws.ContentResponse

   .. py:method:: http_get_legend(req: gws.WebRequester, p: GetLegendRequest) -> gws.ContentResponse

   .. py:method:: http_get_xyz(req: gws.WebRequester, p: GetXyzRequest) -> gws.ContentResponse


.. py:class:: Props


   Bases: :py:obj:`gws.base.action.Props`