Class: QgsLayoutItemMapItem¶

An item which is drawn inside a QgsLayoutItemMap, e.g., a grid or map overview.

Class Hierarchy¶

Base classes¶

`QgsLayoutObject`	A base class for objects which belong to a layout.
QObject
`QgsExpressionContextGenerator`	Abstract interface for generating an expression context.

Subclasses¶

`QgsLayoutItemMapGrid`	An individual grid which is drawn above the map content in a `QgsLayoutItemMap`.
`QgsLayoutItemMapOverview`	An individual overview which is drawn above the map content in a `QgsLayoutItemMap`, and shows the extent of another `QgsLayoutItemMap`.

Methods

`accept`	Accepts the specified style entity visitor, causing it to visit all style entities associated with the map item.
`draw`	Draws the item on to a destination painter.
`enabled`	Returns whether the item will be drawn.
`finalizeRestoreFromXml`	Called after all pending items have been restored from XML.
`id`	Returns the unique id for the map item.
`map`	Returns the layout item map for the item.
`mapLayer`	Returns the internal map layer used by this item, if available.
`name`	Returns the friendly display name for the item.
`readXml`	Sets the map item state from a DOM document, where element is the DOM node corresponding to a 'LayoutMapGrid' tag.
`setEnabled`	Controls whether the item will be drawn.
`setMap`	Sets the corresponding layout map for the item.
`setName`	Sets the friendly display name for the item.
`setStackingLayer`	Sets the item's stacking layer, which specifies where the in the map's stack the item should be rendered.
`setStackingPosition`	Sets the item's stacking position, which specifies where the in the map's stack the item should be rendered.
`stackingLayer`	Returns the item's stacking layer, which specifies where the in the map's stack the item should be rendered.
`stackingPosition`	Returns the item's stacking position, which specifies where the in the map's stack the item should be rendered.
`usesAdvancedEffects`	Returns `True` if the item is drawn using advanced effects, such as blend modes.
`writeXml`	Stores map item state in a DOM element, where element is the DOM element corresponding to a 'LayoutMap' tag.

Attributes

`StackAboveMapLabels`
`StackAboveMapLayer`
`StackBelowMap`
`StackBelowMapLabels`
`StackBelowMapLayer`

class qgis.core.QgsLayoutItemMapItem[source]¶

Bases: QgsLayoutObject

__init__(name: str | None, map: QgsLayoutItemMap | None)

Constructor for QgsLayoutItemMapItem, attached to the specified map.

The name argument gives a friendly display name for the item.

Parameters:

name (Optional[str])
map (Optional[QgsLayoutItemMap])

StackAboveMapLabels = 4¶

StackAboveMapLayer = 2¶

StackBelowMap = 0¶

StackBelowMapLabels = 3¶

StackBelowMapLayer = 1¶

class StackingPosition¶: Bases: int

accept(self, visitor: QgsStyleEntityVisitorInterface | None) → bool[source]¶

Accepts the specified style entity visitor, causing it to visit all style entities associated with the map item.

Returns True if the visitor should continue visiting other objects, or False if visiting should be canceled.

Added in version 3.10.

Parameters:: visitor (Optional[QgsStyleEntityVisitorInterface])
Return type:: bool

draw(self, painter: QPainter | None)[source]¶

Draws the item on to a destination painter.

Parameters:: painter (Optional[QPainter])

enabled(self) → bool[source]¶

Returns whether the item will be drawn.

See also

setEnabled()

Return type:: bool

finalizeRestoreFromXml(self)[source]¶: Called after all pending items have been restored from XML. Map items can use this method to run steps which must take place after all items have been restored to the layout, such as connecting to signals emitted by other items, which may not have existed in the layout at the time readXml() was called. E.g. an overview can use this to connect to its linked map item after restoration from XML.

See also

readXml()