Class: QgsLayoutItemMapOverview

class qgis.core.QgsLayoutItemMapOverview(name: str, map: QgsLayoutItemMap)

Bases: qgis._core.QgsLayoutItemMapItem

Constructor for QgsLayoutItemMapOverview.

Parameters:
  • name – friendly display name for overview
  • map – QgsLayoutItemMap the overview is attached to

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

New in version 3.0: Methods

asMapLayer Returns a vector layer to render as part of the QgsLayoutItemMap render, containing a feature representing the overview extent (and with an appropriate renderer set matching the overview’s frameSymbol() ).
blendMode Retrieves the blending mode used for drawing the overview.
centered Returns whether the extent of the map is forced to center on the overview.
childEvent
connectNotify
connectSignals Reconnects signals for overview map, so that overview correctly follows changes to source map’s extent.
customEvent
disconnectNotify
draw
finalizeRestoreFromXml
frameSymbol Returns the fill symbol used for drawing the overview extent.
inverted Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.
isSignalConnected
linkedMap Returns the source map to show the overview extent of.
overviewExtentChanged Handles recentering of the map and redrawing of the map’s overview
readObjectPropertiesFromElement
readXml
receivers
sender
senderSignalIndex
setBlendMode Sets the blending mode used for drawing the overview.
setCentered Sets whether the extent of the map is forced to center on the overview
setFrameSymbol Sets the fill symbol used for drawing the overview extent.
setInverted Sets whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.
setLinkedMap Sets the map to show the overview extent of.
timerEvent
usesAdvancedEffects
writeObjectPropertiesToElement
writeXml

Signals

Attributes

asMapLayer(self) → QgsVectorLayer

Returns a vector layer to render as part of the QgsLayoutItemMap render, containing a feature representing the overview extent (and with an appropriate renderer set matching the overview’s frameSymbol() ).

Ownership of the layer remain with the overview item.

New in version 3.6.

blendMode(self) → QPainter.CompositionMode

Retrieves the blending mode used for drawing the overview.

See also

setBlendMode()

centered(self) → bool

Returns whether the extent of the map is forced to center on the overview.

See also

setCentered()

childEvent()
connectNotify()
connectSignals(self)

Reconnects signals for overview map, so that overview correctly follows changes to source map’s extent.

customEvent()
disconnectNotify()
draw(self, painter: QPainter)
finalizeRestoreFromXml(self)
frameSymbol(self) → QgsFillSymbol

Returns the fill symbol used for drawing the overview extent.

See also

setFrameSymbol()

inverted(self) → bool

Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.

See also

setInverted()

isSignalConnected()
linkedMap(self) → QgsLayoutItemMap

Returns the source map to show the overview extent of.

See also

setLinkedMap()

overviewExtentChanged(self)

Handles recentering of the map and redrawing of the map’s overview

readObjectPropertiesFromElement()
readXml(self, itemElem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool
receivers()
sender()
senderSignalIndex()
setBlendMode(self, mode: QPainter.CompositionMode)

Sets the blending mode used for drawing the overview.

See also

blendMode()

setCentered(self, centered: bool)

Sets whether the extent of the map is forced to center on the overview

See also

centered()

setFrameSymbol(self, symbol: QgsFillSymbol)

Sets the fill symbol used for drawing the overview extent. Ownership is transferred to the overview.

See also

frameSymbol()

setInverted(self, inverted: bool)

Sets whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.

See also

inverted()

setLinkedMap(self, map: QgsLayoutItemMap)

Sets the map to show the overview extent of.

See also

linkedMap()

timerEvent()
usesAdvancedEffects(self) → bool
writeObjectPropertiesToElement()
writeXml(self, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool