:right-sidebar: True

SymbolEvent
===================================================================

.. currentmodule:: gi.repository.Shumate


.. versionadded:: 1.1




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


Superclasses: :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Shumate.Location`



An object containing the details of a map feature that has been clicked.
It is the argument of the :obj:`~gi.repository.Shumate.MapLayer.signals.symbol_clicked` and
:obj:`~gi.repository.Shumate.SimpleMap.signals.symbol_clicked` signals.

When vector maps are rendered, they may contain labels and icons. When one
of these symbols is clicked, these signals are emitted to give the
application access to the original location and details of the map feature.

:obj:`~gi.repository.Shumate.SymbolEvent` implements :obj:`~gi.repository.Shumate.Location` so you can get the latitude
and longitude of the feature that was clicked.




Methods
-------

.. rst-class:: interim-class

.. class:: SymbolEvent
   :no-index:


   .. method:: get_feature_id() -> str

      Gets the feature ID as specified in the data source. The meaning of the
      ID, if any, is up to the source.

      Feature IDs in Mapbox Vector Tile format are integers, but they are
      formatted as a string here for futureproofing.


      .. versionadded:: 1.1








   .. method:: get_keys() -> list[str]

      Gets a list of the keys of the source feature's tags.


      .. versionadded:: 1.1








   .. method:: get_layer() -> str

      Gets the name of the layer the clicked symbol is in, as named in the vector
      stylesheet.

      Note that this is distinct from the name of the layer in the vector tile
      schema. Some styles have multiple symbol layers derived from the same
      data source layer.


      .. versionadded:: 1.1








   .. method:: get_source_layer() -> str

      Gets the name of the source layer the clicked feature is in,
      as named in the vector tile schema.


      .. versionadded:: 1.1








   .. method:: get_tag(tag_name: str) -> str

      Gets a tag from the source feature.

      The available tags depend on the vector tile schema and the source layer.
      Check the documentation for the tiles you're using to see what information
      is available.


      .. versionadded:: 1.1





      :param tag_name: the tag to get








Properties
----------

.. rst-class:: interim-class

.. class:: SymbolEvent
   :no-index:
   

   .. attribute:: props.feature_id
      :type: str

      The type of the None singleton.



      .. versionadded:: 1.1





   .. attribute:: props.layer
      :type: str

      The type of the None singleton.



      .. versionadded:: 1.1





   .. attribute:: props.source_layer
      :type: str

      The type of the None singleton.