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, the geoPdf argument controls whether a GeoPDF file is created. See QgsAbstractGeoPdfExporter.geoPDFCreationAvailable() for conditions on GeoPDF creation availability.

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.

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()
connectNotify()
customEvent()
disconnectNotify()
errorOccurred

Emitted when map rendering failed. [signal]

Parameters

error (int) –

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()
setExportMetadata(self, exportMetadata: bool)

Sets whether metadata such as title and subject will be exported whenever possible.

Parameters

exportMetadata (bool) –

setProgress()
setSaveWorldFile(self, save: bool)

Sets whether the image file will be georeferenced (embedded or via a world file).

Parameters

save (bool) –

timerEvent()