Class: QgsLayoutItemMapOverview¶
-
class
qgis.core.
QgsLayoutItemMapOverview
(name: str, map: QgsLayoutItemMap)¶ Bases:
QgsLayoutItemMapItem
Constructor for QgsLayoutItemMapOverview.
- Parameters
name (str) – friendly display name for overview
map (QgsLayoutItemMap) –
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
Methods
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.
- param painter
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
- param itemElem
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.- rtype
bool
- param elem
-
blendMode
(self) → QPainter.CompositionMode¶ Retrieves the blending mode used for drawing the overview.
See also
- Return type
QPainter.CompositionMode
-
centered
(self) → bool¶ Returns whether the extent of the map is forced to center on the overview.
See also
- Return type
bool
-
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)¶ - Parameters
painter (QPainter) –
-
finalizeRestoreFromXml
(self)¶
-
frameSymbol
(self) → QgsFillSymbol¶ Returns the fill symbol used for drawing the overview extent.
See also
- Return type
-
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
- Return type
bool
-
isSignalConnected
()¶
-
linkedMap
(self) → QgsLayoutItemMap¶ Returns the source map to show the overview extent of.
See also
- Return type
-
overviewExtentChanged
(self)¶ Handles recentering of the map and redrawing of the map’s overview
-
readObjectPropertiesFromElement
()¶
-
readXml
(self, itemElem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool¶ - Parameters
itemElem (QDomElement) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool
-
receivers
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setBlendMode
(self, mode: QPainter.CompositionMode)¶ Sets the blending
mode
used for drawing the overview.See also
- Parameters
mode (QPainter.CompositionMode) –
-
setCentered
(self, centered: bool)¶ Sets whether the extent of the map is forced to center on the overview
See also
- 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
- 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
- Parameters
inverted (bool) –
-
setLinkedMap
(self, map: QgsLayoutItemMap)¶ Sets the
map
to show the overview extent of.See also
- Parameters
map (QgsLayoutItemMap) –
-
timerEvent
()¶
-
usesAdvancedEffects
(self) → bool¶ - Return type
bool
-
writeObjectPropertiesToElement
()¶
-
writeXml
(self, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool¶ - Parameters
elem (QDomElement) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool