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 anotherQgsLayoutItemMap
.See also
New in version 3.0: Enums
Methods
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() ).
Retrieves the blending mode used for drawing the overview.
Returns whether the extent of the map is forced to center on the overview.
Reconnects signals for overview map, so that overview correctly follows changes to source map’s extent.
Returns the fill symbol used for drawing the overview extent.
Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.
Returns the source map to show the overview extent of.
Handles recentering of the map and redrawing of the map’s overview
Sets the blending
mode
used for drawing the overview.Sets whether the extent of the map is forced to center on the overview
Sets the fill
symbol
used for drawing the overview extent.Sets whether the overview frame is
inverted
, ie, whether the shaded area is drawn outside the extent of the overview map.Sets the
map
to show the overview extent of.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
-
centered
(self) → bool¶ Returns whether the extent of the map is forced to center on the overview.
See also
-
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
-
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
-
isSignalConnected
()¶
-
linkedMap
(self) → QgsLayoutItemMap¶ Returns the source map to show the overview extent of.
See also
-
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
-
setCentered
(self, centered: bool)¶ Sets whether the extent of the map is forced to center on the overview
See also
-
setFrameSymbol
(self, symbol: QgsFillSymbol)¶ Sets the fill
symbol
used for drawing the overview extent. Ownership is transferred to the overview.See also
-
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
-
setLinkedMap
(self, map: QgsLayoutItemMap)¶ Sets the
map
to show the overview extent of.See also
-
timerEvent
()¶
-
usesAdvancedEffects
(self) → bool¶
-
writeObjectPropertiesToElement
()¶
-
writeXml
(self, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool¶