Class: QgsMapToolIdentify¶
-
class
qgis.gui.
QgsMapToolIdentify
(canvas: QgsMapCanvas)¶ Bases:
QgsMapTool
constructor
Map tool for identifying features in layers
after selecting a point, performs the identification: - for raster layers shows value of underlying pixel - for vector layers shows feature attributes within search radius (allows editing values when vector layer is in editing mode)
- Parameters
canvas –
-
ActiveLayer
= 0¶
-
AllLayers
= 3¶
-
DefaultQgsSetting
= -1¶
-
class
IdentifyMode
¶ Bases:
int
-
baseClass
¶ alias of
QgsMapToolIdentify
-
-
class
IdentifyResult
¶ Bases:
sip.wrapper
Constructor for IdentifyResult
QgsMapToolIdentify.IdentifyResult(layer:
QgsMapLayer
, feature:QgsFeature
, derivedAttributes: Dict[str, str])QgsMapToolIdentify.IdentifyResult(layer:
QgsMapLayer
, label: str, attributes: Dict[str, str], derivedAttributes: Dict[str, str])QgsMapToolIdentify.IdentifyResult(layer:
QgsMapLayer
, label: str, fields:QgsFields
, feature:QgsFeature
, derivedAttributes: Dict[str, str])QgsMapToolIdentify.IdentifyResult(QgsMapToolIdentify.IdentifyResult)
-
mAttributes
¶
-
mDerivedAttributes
¶
-
mFeature
¶
-
mFields
¶
-
mLabel
¶
-
mLayer
¶
-
mParams
¶
-
-
LayerSelection
= 3¶
-
class
LayerType
¶ Bases:
sip.wrapper
QgsMapToolIdentify.LayerType(Union[QgsMapToolIdentify.LayerType, QgsMapToolIdentify.Type]) QgsMapToolIdentify.LayerType(QgsMapToolIdentify.LayerType)
-
baseClass
¶ alias of
QgsMapToolIdentify
-
-
RasterLayer
= 2¶
-
TopDownAll
= 2¶
-
TopDownStopAtFirst
= 1¶
-
class
Type
¶ Bases:
int
-
VectorLayer
= 1¶
-
activate
(self)¶
-
canvasMoveEvent
(self, e: QgsMapMouseEvent)¶ - Parameters
e (QgsMapMouseEvent) –
-
canvasPressEvent
(self, e: QgsMapMouseEvent)¶ - Parameters
e (QgsMapMouseEvent) –
-
canvasReleaseEvent
(self, e: QgsMapMouseEvent)¶ - Parameters
e (QgsMapMouseEvent) –
-
changedRasterResults
¶ changedRasterResults(self, Iterable[QgsMapToolIdentify.IdentifyResult]) [signal]
-
childEvent
()¶
-
connectNotify
()¶
-
customEvent
()¶
-
deactivate
(self)¶
-
derivedAttributesForPoint
(self, point: QgsPoint) → Dict[str, str]¶ Returns derived attributes map for a clicked point in map coordinates. May be 2D or 3D point.
- Parameters
point (QgsPoint) –
- Return type
Dict[str, str]
-
disconnectNotify
()¶
-
flags
(self) → QgsMapTool.Flags¶ - Return type
-
formatChanged
(self, layer: QgsRasterLayer)¶ - Parameters
layer (QgsRasterLayer) –
-
identify
(self, x: int, y: int, layerList: Iterable[QgsMapLayer] = [], mode: QgsMapToolIdentify.IdentifyMode = QgsMapToolIdentify.DefaultQgsSetting) → List[QgsMapToolIdentify.IdentifyResult]¶ Performs the identification.
- Parameters
x (int) – x coordinates of mouseEvent
y (int) – y coordinates of mouseEvent
layerList (Iterable[QgsMapLayer] = []) – Performs the identification within the given list of layers. Default value is an empty list, i.e. uses all the layers.
mode (QgsMapToolIdentify.IdentifyMode = QgsMapToolIdentify.DefaultQgsSetting) – Identification mode. Can use Qgis default settings or a defined mode. Default mode is DefaultQgsSetting.
- Returns
a list of IdentifyResult*
identify(self, x: int, y: int, mode: QgsMapToolIdentify.IdentifyMode, layerType: Union[QgsMapToolIdentify.LayerType, QgsMapToolIdentify.Type] = QgsMapToolIdentify.AllLayers) -> List[QgsMapToolIdentify.IdentifyResult] Performs the identification. To avoid being forced to specify IdentifyMode with a list of layers this has been made private and two publics methods are offered
- Parameters
x – x coordinates of mouseEvent
y – y coordinates of mouseEvent
mode – Identification mode. Can use Qgis default settings or a defined mode.
layerType – Only performs identification in a certain type of layers (raster, vector). Default value is AllLayers.
- Returns
a list of IdentifyResult*
identify(self, geometry:
QgsGeometry
, mode: QgsMapToolIdentify.IdentifyMode, layerType: Union[QgsMapToolIdentify.LayerType, QgsMapToolIdentify.Type]) -> List[QgsMapToolIdentify.IdentifyResult] Performs identification based on a geometry (in map coordinates)identify(self, geometry:
QgsGeometry
, mode: QgsMapToolIdentify.IdentifyMode, layerList: Iterable[QgsMapLayer], layerType: Union[QgsMapToolIdentify.LayerType, QgsMapToolIdentify.Type]) -> List[QgsMapToolIdentify.IdentifyResult] Performs identification based on a geometry (in map coordinates)identify(self, x: int, y: int, mode: QgsMapToolIdentify.IdentifyMode, layerList: Iterable[QgsMapLayer], layerType: Union[QgsMapToolIdentify.LayerType, QgsMapToolIdentify.Type] = QgsMapToolIdentify.AllLayers) -> List[QgsMapToolIdentify.IdentifyResult] Performs the identification. To avoid being forced to specify IdentifyMode with a list of layers this has been made private and two publics methods are offered
- Parameters
x – x coordinates of mouseEvent
y – y coordinates of mouseEvent
mode – Identification mode. Can use Qgis default settings or a defined mode.
layerList – Performs the identification within the given list of layers.
layerType – Only performs identification in a certain type of layers (raster, vector).
- Return type
- Returns
a list of IdentifyResult*
-
identifyLayer
(self, results: Iterable[QgsMapToolIdentify.IdentifyResult], layer: QgsMapLayer, point: QgsPointXY, viewExtent: QgsRectangle, mapUnitsPerPixel: float, layerType: Union[QgsMapToolIdentify.LayerType, QgsMapToolIdentify.Type] = QgsMapToolIdentify.AllLayers) → bool¶ Call the right method depending on layer type
- Parameters
results (Iterable[QgsMapToolIdentify.IdentifyResult]) –
layer (QgsMapLayer) –
point (QgsPointXY) –
viewExtent (QgsRectangle) –
mapUnitsPerPixel (float) –
layerType (Union[QgsMapToolIdentify.LayerType) –
- Return type
bool
-
identifyMenu
(self) → QgsIdentifyMenu¶ Returns a pointer to the identify menu which will be used in layer selection mode this menu can also be customized
- Return type
-
identifyMessage
¶ identifyMessage(self, str) [signal]
-
identifyProgress
¶ identifyProgress(self, int, int) [signal]
-
identifyRasterLayer
(self, results: Iterable[QgsMapToolIdentify.IdentifyResult], layer: QgsRasterLayer, point: QgsPointXY, viewExtent: QgsRectangle, mapUnitsPerPixel: float) → bool¶ - Parameters
results (Iterable[QgsMapToolIdentify.IdentifyResult]) –
layer (QgsRasterLayer) –
point (QgsPointXY) –
viewExtent (QgsRectangle) –
mapUnitsPerPixel (float) –
- Return type
bool
-
identifyVectorLayer
(self, results: Iterable[QgsMapToolIdentify.IdentifyResult], layer: QgsVectorLayer, point: QgsPointXY) → bool¶ - Parameters
results (Iterable[QgsMapToolIdentify.IdentifyResult]) –
layer (QgsVectorLayer) –
point (QgsPointXY) –
- Return type
bool
-
isSignalConnected
()¶
-
receivers
()¶
-
restoreCanvasPropertiesOverrides
(self)¶ Clears canvas properties overrides previously set with setCanvasPropertiesOverrides()
See also
New in version 3.4.
-
sender
()¶
-
senderSignalIndex
()¶
-
setCanvasPropertiesOverrides
(self, searchRadiusMapUnits: float)¶ Overrides some map canvas properties inside the map tool for the upcoming identify requests.
This is useful when the identification is triggered by some other piece of GUI like a 3D map view and some properties like search radius need to be adjusted so that identification returns correct results. Currently only search radius may be overridden.
When the custom identification has finished, restoreCanvasPropertiesOverrides() should be called to erase any overrides.
See also
New in version 3.4.
- Parameters
searchRadiusMapUnits (float) –
-
timerEvent
()¶
-
toCanvasCoordinates
()¶
-
toLayerCoordinates
()¶
-
toMapCoordinates
()¶
-
toMapCoordinatesV2
()¶