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