:right-sidebar: True

Layer
===================================================================

.. currentmodule:: gi.repository.Shumate





.. class:: Layer(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`


Subclasses: :class:`~gi.repository.Shumate.MapLayer`, :class:`~gi.repository.Shumate.MarkerLayer`, :class:`~gi.repository.Shumate.PathLayer`


Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`



Every layer (overlay that moves together with the map) has to inherit this
class and implement its virtual methods.

You can use the same layer to display many types of maps.  In Shumate they
are called map sources.  You can change the :obj:`~gi.repository.Shumate.MapLayer.props.map_source`
property at any time to replace the current displayed map.




Methods
-------

.. rst-class:: interim-class

.. class:: Layer
   :no-index:


   .. method:: do_get_debug_text(self) -> str | None

      









   .. method:: get_viewport() -> ~gi.repository.Shumate.Viewport

      Gets the :obj:`~gi.repository.Shumate.Viewport` used by this layer.













Properties
----------

.. rst-class:: interim-class

.. class:: Layer
   :no-index:
   

   .. attribute:: props.viewport
      :type: ~gi.repository.Shumate.Viewport

      The type of the None singleton.













Virtual Methods
---------------

.. rst-class:: interim-class

.. class:: Layer
   :no-index:
   

   .. method:: do_get_debug_text() -> str | None

      The type of the None singleton.














Fields
------

.. rst-class:: interim-class

.. class:: Layer
   :no-index:
   

   .. attribute:: parent_instance