Shumate.SymbolEvent¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r |
Feature ID |
||
r |
layer |
||
r |
source-layer |
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class Shumate.SymbolEvent(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
An object containing the details of a map feature that has been clicked. It is the argument of the [signal`MapLayer`:py:func:::symbol-clicked<Shumate.SymbolEvent.signals.symbol_clicked>] and [signal`SimpleMap`:py:func:::symbol-clicked<Shumate.SymbolEvent.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.
[class`SymbolEvent`] implements [iface`Location`] so you can get the latitude and longitude of the feature that was clicked.
New in version 1.1.
- get_feature_id()¶
- Returns:
the feature ID
- Return type:
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.
New in version 1.1.
- get_keys()¶
- Returns:
a list of the tag keys
- Return type:
[
str]
Gets a list of the keys of the source feature’s tags.
New in version 1.1.
- get_layer()¶
- Returns:
the layer name
- Return type:
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.
New in version 1.1.
- get_source_layer()¶
- Returns:
the layer name
- Return type:
Gets the name of the source layer the clicked feature is in, as named in the vector tile schema.
New in version 1.1.
- get_tag(tag_name)¶
- Parameters:
tag_name (
str) – the tag to get- Returns:
the tag value, formatted as a string
- Return type:
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.
New in version 1.1.
Property Details¶
- Shumate.SymbolEvent.props.feature_id¶
-
The ID of the feature that this event pertains to, as it was given in the data source.
New in version 1.1.
- Shumate.SymbolEvent.props.layer¶
-
The ID of the style layer of the symbol that this event pertains to.
New in version 1.1.