Class: QgsMapDecoration¶

Interface for map decorations.

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.

class qgis.core.QgsMapDecoration[source]¶

Bases: object

displayName(self) → str[source]¶

Returns the map decoration display name.

Added in version 3.14.

Return type:: str

hasFixedMapPosition(self) → bool[source]¶

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…)

Added in version 3.34.

Return type:: bool

render(self, mapSettings: QgsMapSettings, context: QgsRenderContext)[source]¶

Renders a map decoration.

Parameters:

mapSettings (QgsMapSettings)
context (QgsRenderContext)

setDisplayName(self, name: str | None)[source]¶

Sets the map decoration display name.

Added in version 3.14.

Parameters:: name (Optional[str])