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.If the output
fileFormat
is set to PDF, thegeoPdf
argument controls whether a GeoPDF file is created. See QgsAbstractGeoPdfExporter.geoPDFCreationAvailable() for conditions on GeoPDF creation availability.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¶
-
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
¶ Emitted when map rendering failed. [signal]
- Parameters
error (int) –
-
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
¶ Emitted when the map rendering is successfully completed. [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)¶