Class: QgsMapDecoration¶

class qgis.core.QgsMapDecoration¶

Bases: sip.wrapper

Interface for map decorations.

New in version 3.0.

QgsMapDecoration() Constructor for QgsMapDecoration.

QgsMapDecoration(QgsMapDecoration)

Methods

displayName

Returns the map decoration display name.

hasFixedMapPosition

Returns True if the decoration is attached to a fixed map position (e.g grid, layout extent), or False if the annotation uses a position relative to the map canvas (e.g. title, copyright...).

render

Renders a map decoration.

setDisplayName

Sets the map decoration display name.

displayName(self) → str¶

Returns the map decoration display name.

New in version 3.14.

Return type:: str

hasFixedMapPosition(self) → bool¶

Returns True if the decoration is attached to a fixed map position (e.g grid, layout extent), or False if the annotation uses a position relative to the map canvas (e.g. title, copyright…)

New in version 3.34.

Return type:: bool

render(self, mapSettings: QgsMapSettings, context: QgsRenderContext)¶

Renders a map decoration.

Parameters:

mapSettings (QgsMapSettings) –
context (QgsRenderContext) –

setDisplayName(self, name: str)¶

Sets the map decoration display name.

New in version 3.14.

Parameters:: name (str) –