Subgroup: Map
Class: QgsMapRendererTask¶
-
class
qgis.core.
QgsMapRendererTask
(ms: QgsMapSettings, fileName: str, fileFormat: str = '', forceRaster: bool = False)¶ Bases:
qgis._core.QgsTask
Constructor for QgsMapRendererTask to render a map to an image file.
QgsMapRendererTask(ms: QgsMapSettings, p: QPainter) Constructor for QgsMapRendererTask to render a map to a QPainter object.
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: Methods
addAnnotations
Adds annotations
to be rendered on the map.addDecorations
Adds decorations
to be rendered on the map.cancel
childEvent
connectNotify
customEvent
disconnectNotify
finished
isCanceled
isSignalConnected
receivers
run
sender
senderSignalIndex
setProgress
setSaveWorldFile
Sets whether a world file will be created alongside an image file. timerEvent
Signals
errorOccurred
Emitted when map rendering failed. renderingComplete
Emitted when the map rendering is successfully completed. Attributes
ImageAllocationFail
ImageSaveFail
-
class
ErrorType
¶ Bases:
int
-
ImageAllocationFail
= 1¶
-
ImageSaveFail
= 2¶
-
addAnnotations
(self, annotations: object)¶ Adds
annotations
to be rendered on the map.
-
addDecorations
(self, decorations: object)¶ Adds
decorations
to be rendered on the map.
-
cancel
(self)¶
-
childEvent
()¶
-
connectNotify
()¶
-
customEvent
()¶
-
disconnectNotify
()¶
-
errorOccurred
¶ Emitted when map rendering failed. [signal]
-
finished
(self, result: bool)¶
-
isCanceled
()¶
-
isSignalConnected
()¶
-
receivers
()¶
-
renderingComplete
¶ Emitted when the map rendering is successfully completed. [signal]
-
run
(self) → bool¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setProgress
()¶
-
setSaveWorldFile
(self, save: bool)¶ Sets whether a world file will be created alongside an image file.
-
timerEvent
()¶
-
class