:tocdepth: 3

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

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


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


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   action/index.rst
   core/index.rst



Package Contents
----------------



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


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

   Map configuration

   .. py:attribute:: center
      :type:  Optional[gws.Point]

      Map center.

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

      Precision for coordinates.

   .. py:attribute:: crs
      :type:  Optional[gws.CrsName]
      :value: 'EPSG:3857'


      Crs for this map.

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

      Map extent.

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

      Extent buffer.

   .. py:attribute:: layers
      :type:  list[gws.ext.config.layer]

      Collection of layers for this map.

   .. py:attribute:: title
      :type:  str
      :value: ''


      Map title.

   .. py:attribute:: wrapX
      :type:  bool
      :value: False


      Wrap the world horizontally.

   .. py:attribute:: zoom
      :type:  Optional[gws.gis.zoom.Config]

      Map scales and resolutions.


.. py:class:: Object


   Bases: :py:obj:`gws.Map`

   Map object.

   .. py:attribute:: wrapX
      :type:  bool

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: props(user)

      Generate a ``Props`` struct for this object.

      :param user: The user for which the props should be generated.



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


   Bases: :py:obj:`gws.Data`

   Basic data object.

   This object can be instantiated by passing one or or ``dict`` arguments
   and/or keyword args. All dicts keys and keywords become attributes of the object.

   Accessing an undefined attribute returns ``None`` and no error is raised,
   unless the attribute name starts with an underscore.

   .. py:attribute:: center
      :type:  gws.Point

   .. py:attribute:: coordinatePrecision
      :type:  int

   .. py:attribute:: crs
      :type:  str

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

   .. py:attribute:: extent
      :type:  gws.Extent

   .. py:attribute:: initResolution
      :type:  float

   .. py:attribute:: resolutions
      :type:  list[float]

   .. py:attribute:: rootLayer
      :type:  gws.base.layer.Props

   .. py:attribute:: title
      :type:  str
      :value: ''


   .. py:attribute:: wrapX
      :type:  bool