Class: QgsLayoutItemMapOverview

class qgis.core.QgsLayoutItemMapOverview

Bases: QgsLayoutItemMapItem

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.

QgsLayoutItemMapOverview(name: str, map: QgsLayoutItemMap) Constructor for QgsLayoutItemMapOverview.

Parameters
accept(self, visitor: QgsStyleEntityVisitorInterface)bool
Parameters

visitor (QgsStyleEntityVisitorInterface) –

Return type

bool

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.

Return type

QgsVectorLayer

blendMode(self)QPainter.CompositionMode

Retrieves the blending mode used for drawing the overview.

See also

setBlendMode()

Return type

QPainter.CompositionMode

centered(self)bool

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

See also

setCentered()

Return type

bool

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
connectSignals(self)

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

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

painter (QPainter) –

finalizeRestoreFromXml(self)
frameSymbol(self)QgsFillSymbol

Returns the fill symbol used for drawing the overview extent.

See also

setFrameSymbol()

Return type

QgsFillSymbol

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

Return type

bool

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

Returns the source map to show the overview extent of.

See also

setLinkedMap()

Return type

QgsLayoutItemMap

mapLayer(self)QgsMapLayer
Return type

QgsMapLayer

overviewExtentChanged(self)

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

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, itemElem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext)bool
Parameters
Return type

bool

receivers(self, PYQT_SIGNAL)int
sender(self)QObject
senderSignalIndex(self)int
setBlendMode(self, mode: QPainter.CompositionMode)

Sets the blending mode used for drawing the overview.

See also

blendMode()

Parameters

mode (QPainter.CompositionMode) –

setCentered(self, centered: bool)

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

See also

centered()

Parameters

centered (bool) –

setFrameSymbol(self, symbol: QgsFillSymbol)

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

See also

frameSymbol()

Parameters

symbol (QgsFillSymbol) –

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

Parameters

inverted (bool) –

setLinkedMap(self, map: QgsLayoutItemMap)

Sets the map to show the overview extent of.

See also

linkedMap()

Parameters

map (QgsLayoutItemMap) –

timerEvent(self, QTimerEvent)
usesAdvancedEffects(self)bool
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, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext)bool
Parameters
Return type

bool