Class: QgsMapRendererTask¶
- class qgis.core.QgsMapRendererTask¶
Bases:
QgsTask
QgsTask
task which draws a map to an image file or a painter as a background task. This can be used to draw maps without blocking the QGIS interface.New in version 3.0.
QgsMapRendererTask(ms:
QgsMapSettings
, fileName: str, fileFormat: str = ‘’, forceRaster: bool = False, flags: Union[QgsTask.Flags, QgsTask.Flag] = QgsTask.CanCancel) Constructor forQgsMapRendererTask
to render a map to an image file.Since QGIS 3.26 the optional
flags
argument can be used to control the task flags.QgsMapRendererTask(ms:
QgsMapSettings
, p: QPainter) Constructor forQgsMapRendererTask
to render a map to a QPainter object.Methods
Adds
annotations
to be rendered on the map.Adds
decorations
to be rendered on the map.- param result:
Will return
True
if task should terminate ASAP.- rtype:
bool
Sets whether metadata such as title and subject will be exported whenever possible.
Sets the task's current progress.
Sets whether the image file will be georeferenced (embedded or via a world file).
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
Attributes
- class ErrorType¶
Bases:
int
- ImageAllocationFail = 1¶
- ImageSaveFail = 2¶
- ImageUnsupportedFormat = 3¶
- addAnnotations(self, annotations: Iterable[QgsAnnotation])¶
Adds
annotations
to be rendered on the map.- Parameters:
annotations (Iterable[QgsAnnotation]) –
- addDecorations(self, decorations: Iterable[QgsMapDecoration])¶
Adds
decorations
to be rendered on the map.- Parameters:
decorations (Iterable[QgsMapDecoration]) –
- cancel(self)¶
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- errorOccurred¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- finished(self, result: bool)¶
- Parameters:
result (bool) –
- 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 ¶
- renderingComplete¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- run(self) bool ¶
- Return type:
bool
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setExportMetadata(self, exportMetadata: bool)¶
Sets whether metadata such as title and subject will be exported whenever possible.
- Parameters:
exportMetadata (bool) –
- 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
- setSaveWorldFile(self, save: bool)¶
Sets whether the image file will be georeferenced (embedded or via a world file).
- Parameters:
save (bool) –
- timerEvent(self, QTimerEvent)¶