Subgroup: Layout

Class: QgsLayoutItemMapOverview¶

class qgis.core.QgsLayoutItemMapOverview¶

Bases: qgis._core.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.

See also

QgsLayoutItemMapOverviewStack

Methods

`blendMode`	Retrieves the blending mode used for drawing the overview.
`blockSignals`
`centered`	Returns whether the extent of the map is forced to center on the overview.
`childEvent`
`children`
`connectNotify`
`connectSignals`	Reconnects signals for overview map, so that overview correctly follows changes to source map’s extent.
`createExpressionContext`	Creates an expression context relating to the objects’ current state.
`customEvent`
`customProperties`	Return list of keys stored in custom properties for the object.
`customProperty`	Read a custom property from the object.
`dataDefinedProperties`	Returns a reference to the object’s property collection, used for data defined overrides.
`deleteLater`
`disconnect`
`disconnectNotify`
`draw`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`enabled`	Returns whether the item will be drawn.
`event`
`eventFilter`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`frameSymbol`	Returns the fill symbol used for drawing the overview extent.
`id`	Returns the unique id for the map item.
`inherits`
`installEventFilter`
`inverted`	Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.
`isSignalConnected`
`isWidgetType`
`isWindowType`
`killTimer`
`layout`	Returns the layout the object is attached to.
`linkedMap`	Returns the source map to show the overview extent of.
`map`	Returns the layout item map for the item.
`metaObject`
`moveToThread`
`name`	Returns the friendly display name for the item.
`objectName`
`overviewExtentChanged`	Handles recentering of the map and redrawing of the map’s overview
`parent`
`property`
`propertyDefinitions`	Returns the layout object property definitions.
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`readObjectPropertiesFromElement`
`readXml`
`receivers`
`refresh`	Refreshes the object, causing a recalculation of any property overrides.
`removeCustomProperty`	Remove a custom property from the object.
`removeEventFilter`
`sender`
`senderSignalIndex`
`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
`setCustomProperty`	Set a custom property for the object.
`setDataDefinedProperties`	Sets the objects’s property collection, used for data defined overrides.
`setEnabled`	Controls whether the item will be drawn.
`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.
`setMap`	Sets the corresponding layout `map` for the item.
`setName`	Sets the friendly display `name` for the item.
`setObjectName`
`setParent`
`setProperty`
`signalsBlocked`
`startTimer`
`thread`
`timerEvent`
`tr`
`usesAdvancedEffects`
`writeObjectPropertiesToElement`
`writeXml`

Attributes

`AllProperties`
`BackgroundColor`
`BlendMode`
`EvaluatedValue`
`ExcludeFromExports`
`FrameColor`
`ItemHeight`
`ItemRotation`
`ItemWidth`
`LegendColumnCount`
`LegendTitle`
`MapAtlasMargin`
`MapLayers`
`MapRotation`
`MapScale`
`MapStylePreset`
`MapXMax`
`MapXMin`
`MapYMax`
`MapYMin`
`NoProperty`
`NumPages`
`Opacity`
`OriginalValue`
`PageNumber`
`PaperHeight`
`PaperOrientation`
`PaperWidth`
`PictureSource`
`PictureSvgBackgroundColor`
`PictureSvgStrokeColor`
`PictureSvgStrokeWidth`
`PositionX`
`PositionY`
`PresetPaperSize`
`ScalebarFillColor`
`ScalebarFillColor2`
`ScalebarLineColor`
`ScalebarLineWidth`
`SourceUrl`
`TestProperty`
`Transparency`
`changed`	Emitted when the object’s properties change.
`destroyed`	destroyed(self, QObject = None) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`staticMetaObject`

blendMode(self) → QPainter.CompositionMode¶: Retrieves the blending mode used for drawing the overview.

See also

setBlendMode()

centered(self) → bool¶: Returns whether the extent of the map is forced to center on the overview.

See also

setCentered()

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

frameSymbol(self) → QgsFillSymbol¶: Returns the fill symbol used for drawing the overview extent.

See also

setFrameSymbol()

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

isSignalConnected()¶

linkedMap(self) → QgsLayoutItemMap¶: Returns the source map to show the overview extent of.

See also

setLinkedMap()

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

blendMode()

setCentered(self, centered: bool)¶: Sets whether the extent of the map is forced to center on the overview

See also

centered()

setFrameSymbol(self, symbol: QgsFillSymbol)¶: Sets the fill symbol used for drawing the overview extent. Ownership is transferred to the overview.

See also

frameSymbol()

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

setLinkedMap(self, map: QgsLayoutItemMap)¶: Sets the map to show the overview extent of.

See also

linkedMap()

timerEvent()¶

usesAdvancedEffects(self) → bool¶

writeObjectPropertiesToElement()¶

writeXml(self, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool¶