QGIS API Documentation
3.0.2-Girona (307d082)
|
An individual overview which is drawn above the map content in a QgsLayoutItemMap, and shows the extent of another QgsLayoutItemMap. More...
#include <qgslayoutitemmapoverview.h>
Public Slots | |
void | overviewExtentChanged () |
Handles recentering of the map and redrawing of the map's overview. More... | |
Public Slots inherited from QgsLayoutObject | |
virtual void | refresh () |
Refreshes the object, causing a recalculation of any property overrides. More... | |
Public Member Functions | |
QgsLayoutItemMapOverview (const QString &name, QgsLayoutItemMap *map) | |
Constructor for QgsLayoutItemMapOverview. More... | |
QPainter::CompositionMode | blendMode () const |
Retrieves the blending mode used for drawing the overview. More... | |
bool | centered () const |
Returns whether the extent of the map is forced to center on the overview. More... | |
void | connectSignals () |
Reconnects signals for overview map, so that overview correctly follows changes to source map's extent. More... | |
void | draw (QPainter *painter) override |
Draws the item on to a destination painter. More... | |
void | finalizeRestoreFromXml () override |
Called after all pending items have been restored from XML. More... | |
QgsFillSymbol * | frameSymbol () |
Returns the fill symbol used for drawing the overview extent. More... | |
const QgsFillSymbol * | frameSymbol () const |
Returns the fill symbol used for drawing the overview extent. More... | |
bool | inverted () const |
Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map. More... | |
QgsLayoutItemMap * | linkedMap () |
Returns the source map to show the overview extent of. More... | |
bool | readXml (const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context) override |
Sets the map item state from a DOM document, where element is the DOM node corresponding to a 'LayoutMapGrid' tag. More... | |
void | setBlendMode (const QPainter::CompositionMode mode) |
Sets the blending mode used for drawing the overview. More... | |
void | setCentered (const bool centered) |
Sets whether the extent of the map is forced to center on the overview. More... | |
void | setFrameSymbol (QgsFillSymbol *symbol) |
Sets the fill symbol used for drawing the overview extent. More... | |
void | setInverted (const bool inverted) |
Sets whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map. More... | |
void | setLinkedMap (QgsLayoutItemMap *map) |
Sets the map to show the overview extent of. More... | |
bool | usesAdvancedEffects () const override |
Returns true if the item is drawn using advanced effects, such as blend modes. More... | |
bool | writeXml (QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const override |
Stores map item state in a DOM element, where element is the DOM element corresponding to a 'LayoutMap' tag. More... | |
Public Member Functions inherited from QgsLayoutItemMapItem | |
QgsLayoutItemMapItem (const QString &name, QgsLayoutItemMap *map) | |
Constructor for QgsLayoutItemMapItem, attached to the specified map. More... | |
bool | enabled () const |
Returns whether the item will be drawn. More... | |
QString | id () const |
Returns the unique id for the map item. More... | |
const QgsLayoutItemMap * | map () const |
Returns the layout item map for the item. More... | |
QString | name () const |
Returns the friendly display name for the item. More... | |
void | setEnabled (bool enabled) |
Controls whether the item will be drawn. More... | |
void | setMap (QgsLayoutItemMap *map) |
Sets the corresponding layout map for the item. More... | |
void | setName (const QString &name) |
Sets the friendly display name for the item. More... | |
Public Member Functions inherited from QgsLayoutObject | |
QgsLayoutObject (QgsLayout *layout) | |
Constructor for QgsLayoutObject, with the specified parent layout. More... | |
QgsExpressionContext | createExpressionContext () const override |
Creates an expression context relating to the objects' current state. More... | |
QStringList | customProperties () const |
Return list of keys stored in custom properties for the object. More... | |
QVariant | customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const |
Read a custom property from the object. More... | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the object's property collection, used for data defined overrides. More... | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the object's property collection, used for data defined overrides. More... | |
const QgsLayout * | layout () const |
Returns the layout the object is attached to. More... | |
QgsLayout * | layout () |
Returns the layout the object is attached to. More... | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from the object. More... | |
void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for the object. More... | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the objects's property collection, used for data defined overrides. More... | |
Public Member Functions inherited from QgsExpressionContextGenerator | |
virtual | ~QgsExpressionContextGenerator ()=default |
Additional Inherited Members | |
Public Types inherited from QgsLayoutObject | |
enum | DataDefinedProperty { NoProperty = 0, AllProperties, TestProperty, PresetPaperSize, PaperWidth, PaperHeight, NumPages, PaperOrientation, PageNumber, PositionX, PositionY, ItemWidth, ItemHeight, ItemRotation, Transparency, Opacity, BlendMode, ExcludeFromExports, FrameColor, BackgroundColor, MapRotation, MapScale, MapXMin, MapYMin, MapXMax, MapYMax, MapAtlasMargin, MapLayers, MapStylePreset, PictureSource, PictureSvgBackgroundColor, PictureSvgStrokeColor, PictureSvgStrokeWidth, SourceUrl, LegendTitle, LegendColumnCount, ScalebarFillColor, ScalebarFillColor2, ScalebarLineColor, ScalebarLineWidth } |
Data defined properties for different item types. More... | |
enum | PropertyValueType { EvaluatedValue = 0, OriginalValue } |
Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More... | |
Signals inherited from QgsLayoutObject | |
void | changed () |
Emitted when the object's properties change. More... | |
Static Public Member Functions inherited from QgsLayoutObject | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the layout object property definitions. More... | |
Protected Member Functions inherited from QgsLayoutObject | |
bool | readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context) |
Sets object properties from a DOM element. More... | |
bool | writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores object properties within an XML DOM element. More... | |
Protected Attributes inherited from QgsLayoutItemMapItem | |
bool | mEnabled |
True if item is to be displayed on map. More... | |
QgsLayoutItemMap * | mMap = nullptr |
Associated map. More... | |
QString | mName |
Friendly display name. More... | |
QString | mUuid |
Unique id. More... | |
Protected Attributes inherited from QgsLayoutObject | |
QgsObjectCustomProperties | mCustomProperties |
Custom properties for object. More... | |
QgsPropertyCollection | mDataDefinedProperties |
QPointer< QgsLayout > | mLayout |
An individual overview which is drawn above the map content in a QgsLayoutItemMap, and shows the extent of another QgsLayoutItemMap.
Definition at line 122 of file qgslayoutitemmapoverview.h.
QgsLayoutItemMapOverview::QgsLayoutItemMapOverview | ( | const QString & | name, |
QgsLayoutItemMap * | map | ||
) |
Constructor for QgsLayoutItemMapOverview.
name | friendly display name for overview |
map | QgsLayoutItemMap the overview is attached to |
Definition at line 32 of file qgslayoutitemmapoverview.cpp.
|
inline |
Retrieves the blending mode used for drawing the overview.
Definition at line 177 of file qgslayoutitemmapoverview.h.
|
inline |
Returns whether the extent of the map is forced to center on the overview.
Definition at line 203 of file qgslayoutitemmapoverview.h.
void QgsLayoutItemMapOverview::connectSignals | ( | ) |
Reconnects signals for overview map, so that overview correctly follows changes to source map's extent.
Definition at line 234 of file qgslayoutitemmapoverview.cpp.
|
overridevirtual |
Draws the item on to a destination painter.
Implements QgsLayoutItemMapItem.
Definition at line 47 of file qgslayoutitemmapoverview.cpp.
|
overridevirtual |
Called after all pending items have been restored from XML.
Map items can use this method to run steps which must take place after all items have been restored to the layout, such as connecting to signals emitted by other items, which may not have existed in the layout at the time readXml() was called. E.g. an overview can use this to connect to its linked map item after restoration from XML.
Reimplemented from QgsLayoutItemMapItem.
Definition at line 196 of file qgslayoutitemmapoverview.cpp.
QgsFillSymbol * QgsLayoutItemMapOverview::frameSymbol | ( | ) |
Returns the fill symbol used for drawing the overview extent.
Definition at line 253 of file qgslayoutitemmapoverview.cpp.
const QgsFillSymbol * QgsLayoutItemMapOverview::frameSymbol | ( | ) | const |
Returns the fill symbol used for drawing the overview extent.
Definition at line 258 of file qgslayoutitemmapoverview.cpp.
|
inline |
Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.
Definition at line 190 of file qgslayoutitemmapoverview.h.
QgsLayoutItemMap * QgsLayoutItemMapOverview::linkedMap | ( | ) |
Returns the source map to show the overview extent of.
Definition at line 229 of file qgslayoutitemmapoverview.cpp.
|
slot |
Handles recentering of the map and redrawing of the map's overview.
Definition at line 279 of file qgslayoutitemmapoverview.cpp.
|
overridevirtual |
Sets the map item state from a DOM document, where element is the DOM node corresponding to a 'LayoutMapGrid' tag.
Reimplemented from QgsLayoutItemMapItem.
Definition at line 171 of file qgslayoutitemmapoverview.cpp.
void QgsLayoutItemMapOverview::setBlendMode | ( | const QPainter::CompositionMode | mode | ) |
Sets the blending mode used for drawing the overview.
Definition at line 263 of file qgslayoutitemmapoverview.cpp.
void QgsLayoutItemMapOverview::setCentered | ( | const bool | centered | ) |
Sets whether the extent of the map is forced to center on the overview.
Definition at line 273 of file qgslayoutitemmapoverview.cpp.
void QgsLayoutItemMapOverview::setFrameSymbol | ( | QgsFillSymbol * | symbol | ) |
Sets the fill symbol used for drawing the overview extent.
Ownership is transferred to the overview.
Definition at line 248 of file qgslayoutitemmapoverview.cpp.
void QgsLayoutItemMapOverview::setInverted | ( | const bool | inverted | ) |
Sets whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.
Definition at line 268 of file qgslayoutitemmapoverview.cpp.
void QgsLayoutItemMapOverview::setLinkedMap | ( | QgsLayoutItemMap * | map | ) |
Sets the map to show the overview extent of.
Definition at line 209 of file qgslayoutitemmapoverview.cpp.
|
overridevirtual |
Returns true if the item is drawn using advanced effects, such as blend modes.
Reimplemented from QgsLayoutItemMapItem.
Definition at line 204 of file qgslayoutitemmapoverview.cpp.
|
overridevirtual |
Stores map item state in a DOM element, where element is the DOM element corresponding to a 'LayoutMap' tag.
Reimplemented from QgsLayoutItemMapItem.
Definition at line 148 of file qgslayoutitemmapoverview.cpp.