Class: QgsMapHitTestTask

class qgis.core.QgsMapHitTestTask

Bases: QgsTask

Executes a QgsMapHitTest in a background thread.

New in version 3.32.

QgsMapHitTestTask(settings: QgsLayerTreeFilterSettings) Constructor for QgsMapHitTestTask, using the specified filter settings.

Methods

cancel

childEvent

connectNotify

customEvent

disconnectNotify

finished

If the task is managed by a QgsTaskManager, this will be called after the task has finished (whether through successful completion or via early termination).

isCanceled

Will return True if task should terminate ASAP.

isSignalConnected

receivers

results

Returns the hit test results, which are a map of layer ID to visible symbol legend keys.

run

rtype:

bool

sender

senderSignalIndex

setProgress

Sets the task's current progress.

timerEvent

cancel(self)
childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
finished(self, result: bool)

If the task is managed by a QgsTaskManager, this will be called after the task has finished (whether through successful completion or via early termination). The result argument reflects whether the task was successfully completed or not. This method is always called from the main thread, so it is safe to create widgets and perform other operations which require the main thread. However, the GUI will be blocked for the duration of this method so tasks should avoid performing any lengthy operations here.

isCanceled(self) bool

Will return True if task should terminate ASAP. If the task reports the CanCancel flag, then derived classes’ run() methods should periodically check this and terminate in a safe manner.

isSignalConnected(self, QMetaMethod) bool
receivers(self, PYQT_SIGNAL) int
results(self) object

Returns the hit test results, which are a map of layer ID to visible symbol legend keys.

Return type:

object

run(self) bool
Return type:

bool

sender(self) QObject
senderSignalIndex(self) int
setProgress(self, progress: float)

Sets the task’s current progress. The derived class should call this method whenever the task wants to update its progress. Calling will automatically emit the progressChanged signal.

Parameters:

progress – percent of progress, from 0.0 - 100.0

timerEvent(self, QTimerEvent)