Class: QgsLayoutItemMapItem

class qgis.core.QgsLayoutItemMapItem

Bases: QgsLayoutObject

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

New in version 3.0.

QgsLayoutItemMapItem(name: str, map: QgsLayoutItemMap) Constructor for QgsLayoutItemMapItem, attached to the specified map.

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

Methods

accept

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

childEvent

connectNotify

createExpressionContext

rtype

QgsExpressionContext

customEvent

disconnectNotify

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.

isSignalConnected

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.

readObjectPropertiesFromElement

Sets object properties from a DOM element

readXml

Sets the map item state from a DOM document, where element is the DOM node corresponding to a ‘LayoutMapGrid’ tag.

receivers

sender

senderSignalIndex

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.

timerEvent

usesAdvancedEffects

Returns True if the item is drawn using advanced effects, such as blend modes.

writeObjectPropertiesToElement

Stores object properties within an XML DOM element.

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

StackAboveMapLabels = 4
StackAboveMapLayer = 2
StackBelowMap = 0
StackBelowMapLabels = 3
StackBelowMapLayer = 1
class StackingPosition

Bases: int

accept(self, visitor: QgsStyleEntityVisitorInterface)bool

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.

New in version 3.10.

Parameters

visitor (QgsStyleEntityVisitorInterface) –

Return type

bool

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
createExpressionContext(self)QgsExpressionContext
Return type

QgsExpressionContext

customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
draw(self, painter: QPainter)

Draws the item on to a destination painter.

Parameters

painter (QPainter) –

enabled(self)bool

Returns whether the item will be drawn.

See also

setEnabled()

Return type

bool

finalizeRestoreFromXml(self)

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

id(self)str

Returns the unique id for the map item.

Return type

str

isSignalConnected(self, QMetaMethod)bool
map(self)QgsLayoutItemMap

Returns the layout item map for the item.

See also

setMap()

Return type

QgsLayoutItemMap

mapLayer(self)QgsMapLayer

Returns the internal map layer used by this item, if available.

New in version 3.10.1.

Return type

QgsMapLayer

name(self)str

Returns the friendly display name for the item.

See also

setName()

Return type

str

readObjectPropertiesFromElement(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext)bool

Sets object properties from a DOM element

Parameters
  • parentElement – is the parent DOM element for the object

  • document – DOM document

  • context – read write context

Returns

True if read was successful

readXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext)bool

Sets the map item state from a DOM document, where element is the DOM node corresponding to a ‘LayoutMapGrid’ tag.

See also

writeXml()

Parameters
Return type

bool

receivers(self, PYQT_SIGNAL)int
sender(self)QObject
senderSignalIndex(self)int
setEnabled(self, enabled: bool)

Controls whether the item will be drawn. Set enabled to True to enable drawing of the item.

See also

enabled()

Parameters

enabled (bool) –

setMap(self, map: QgsLayoutItemMap)

Sets the corresponding layout map for the item.

See also

map()

Parameters

map (QgsLayoutItemMap) –

setName(self, name: str)

Sets the friendly display name for the item.

See also

name()

Parameters

name (str) –

setStackingLayer(self, layer: QgsMapLayer)

Sets the item’s stacking layer, which specifies where the in the map’s stack the item should be rendered.

This setting is only used when stackingPosition() is StackBelowMapLayer or StackAboveMapLayer.

See also

stackingLayer()

New in version 3.6.

Parameters

layer (QgsMapLayer) –

setStackingPosition(self, position: QgsLayoutItemMapItem.StackingPosition)

Sets the item’s stacking position, which specifies where the in the map’s stack the item should be rendered.

New in version 3.6.

Parameters

position (QgsLayoutItemMapItem.StackingPosition) –

stackingLayer(self)QgsMapLayer

Returns the item’s stacking layer, which specifies where the in the map’s stack the item should be rendered.

This setting is only used when stackingPosition() is StackBelowMapLayer or StackAboveMapLayer.

New in version 3.6.

Return type

QgsMapLayer

stackingPosition(self)QgsLayoutItemMapItem.StackingPosition

Returns the item’s stacking position, which specifies where the in the map’s stack the item should be rendered.

See also

stackingLayer()

New in version 3.6.

Return type

QgsLayoutItemMapItem.StackingPosition

timerEvent(self, QTimerEvent)
usesAdvancedEffects(self)bool

Returns True if the item is drawn using advanced effects, such as blend modes.

Return type

bool

writeObjectPropertiesToElement(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext)bool

Stores object properties within an XML DOM element.

Parameters
  • parentElement – is the parent DOM element to store the object’s properties in

  • document – DOM document

  • context – read write context

Returns

True if write was successful

writeXml(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext)bool

Stores map item state in a DOM element, where element is the DOM element corresponding to a ‘LayoutMap’ tag.

See also

readXml()

Parameters
Return type

bool