SymbolEvent

Added in version 1.1.

class SymbolEvent(**properties: Any)

Superclasses: Object

Implemented Interfaces: Location

An object containing the details of a map feature that has been clicked. It is the argument of the symbol_clicked and 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.

SymbolEvent implements Location so you can get the latitude and longitude of the feature that was clicked.

Methods

class SymbolEvent

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.

Added in version 1.1.

get_keys() → list[str]: Gets a list of the keys of the source feature’s tags.

Added in version 1.1.

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.

Added in version 1.1.

get_source_layer() → str: Gets the name of the source layer the clicked feature is in, as named in the vector tile schema.

Added in version 1.1.

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.

Added in version 1.1.

Parameters:: tag_name – the tag to get

Properties

class SymbolEvent

props.feature_id: str: The ID of the feature that this event pertains to, as it was given in the data source.

Added in version 1.1.

props.layer: str: The ID of the style layer of the symbol that this event pertains to.

Added in version 1.1.

props.source_layer: str: The ID of the source layer of the symbol that this event pertains to.