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.

class qgis.core.QgsLayoutItemMapOverview

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

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.

Return type:

Optional[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

connectSignals(self)

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

frameSymbol(self) → QgsFillSymbol | None

Returns the fill symbol used for drawing the overview extent.

See also

setFrameSymbol()

Return type:

Optional[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

linkedMap(self) → QgsLayoutItemMap | None

Returns the source map to show the overview extent of.

See also

setLinkedMap()

Return type:

Optional[QgsLayoutItemMap]

overviewExtentChanged(self)

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

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

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

See also

frameSymbol()

Parameters:

symbol (Optional[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 | None)

Sets the map to show the overview extent of.

See also

linkedMap()

Parameters:

map (Optional[QgsLayoutItemMap])