Class: QgsLayoutItemMapOverview¶

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

See also

QgsLayoutItemMapOverviewStack

Class Hierarchy¶

Base classes¶

`QgsLayoutItemMapItem`	An item which is drawn inside a `QgsLayoutItemMap`, e.g., a grid or map overview.
`QgsLayoutObject`	A base class for objects which belong to a layout.
QObject
`QgsExpressionContextGenerator`	Abstract interface for generating an expression context.

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.
`connectSignals`	Reconnects signals for overview map, so that overview correctly follows changes to source map's extent.
`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.
`linkedMap`	Returns the source map to show the overview extent of.
`overviewExtentChanged`	Handles recentering of the map and redrawing of the map's overview
`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.

class qgis.core.QgsLayoutItemMapOverview[source]¶

Bases: QgsLayoutItemMapItem

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

Constructor for QgsLayoutItemMapOverview.

Parameters:

name (Optional[str]) – friendly display name for overview
map (Optional[QgsLayoutItemMap]) – QgsLayoutItemMap the overview is attached to

asMapLayer(self) → QgsVectorLayer | None[source]¶

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.

Added in version 3.6.