Class: QgsMapCanvasUtils

Utility functions for working with QgsMapCanvas widgets.

Added in version 3.14.

Static Methods

filterForLayer

Constructs a filter to use for selecting features from the given layer, in order to apply filters which prevent some features from being displayed (e.g. as a result of temporal range of the canvas and the layer's temporal settings).

flashMatchingFeatures

Flashes features from the specified layer which match the given filter expression string with a map canvas.

zoomToMatchingFeatures

Zooms a map canvas to features from the specified layer which match the given filter expression string.
class qgis.gui.QgsMapCanvasUtils[source]

Bases: object

static filterForLayer(canvas: QgsMapCanvas | None, layer: QgsVectorLayer | None) → str[source]

Constructs a filter to use for selecting features from the given layer, in order to apply filters which prevent some features from being displayed (e.g. as a result of temporal range of the canvas and the layer’s temporal settings).

Will return an empty string if no filtering is required, or “False” if ALL features are filtered out by the canvas.

Added in version 3.26.

Parameters:
Return type:

str

static flashMatchingFeatures(canvas: QgsMapCanvas | None, layer: QgsVectorLayer | None, filter: str | None) → int[source]

Flashes features from the specified layer which match the given filter expression string with a map canvas.

The total count of matching features will be returned.

Parameters:
Return type:

int

static zoomToMatchingFeatures(canvas: QgsMapCanvas | None, layer: QgsVectorLayer | None, filter: str | None) → int[source]

Zooms a map canvas to features from the specified layer which match the given filter expression string.

The total count of matching features will be returned.

Parameters:
Return type:

int