Class: QgsLayoutItemMap¶
- class qgis.core.QgsLayoutItemMap¶
Bases:
QgsLayoutItem
,QgsTemporalRangeObject
Layout graphical items for displaying a map.
New in version 3.0.
QgsLayoutItemMap(layout:
QgsLayout
) Constructor forQgsLayoutItemMap
, with the specified parentlayout
.Methods
- param visitor
Sets the specified layout
item
as a "label blocking item" for this map.Adds a rendered feature
handler
to use while rendering the map.Adjusts the specified
point
at which areference
position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position.Applies any present data defined size overrides to the specified layout
size
.Applies any item-specific size constraint handling to a given
targetSize
in layout units.Sets the map
id()
to a number not yet used in the layout.Returns the map's atlas clipping settings.
Returns whether the map extent is set to follow the current atlas feature.
Returns the margin size (percentage) used when the map is in atlas mode.
Returns the current atlas scaling mode.
- rtype
QRectF
- rtype
bool
Returns
True
if the map contains a WMS layer.Returns a new map item for the specified
layout
.- rtype
QgsExpressionContext
Returns coordinate reference system used for rendering the map.
- rtype
str
- param context
Returns whether annotations are drawn within the map.
Draws the background for the item.
Draws a debugging rectangle of the item's current bounds within the specified painter.
Draws the frame around the item.
- rtype
QgsLayoutItem.ExportLayerBehavior
- rtype
QgsLayoutItem.ExportLayerDetail
Returns the current map extent.
Returns whether the map should follow a map theme.
Preset name that decides which layers and layer styles are used for map rendering.
- rtype
QPainterPath
Returns the map item's first grid.
Returns the map item's grid stack, which is used to control how grids are drawn over the map's contents.
- rtype
QIcon
True if a draw is already in progress
Returns
True
if the specifieditem
is a "label blocking item".Returns the map's item based clip path settings.
- rtype
QgsLayoutItem.Flags
Returns whether a stored layer set should be used or the current layer set from the project associated with the layout.
Returns whether current styles of layers should be overridden by previously stored styles.
Returns the margin from the map edges in which no labels may be placed.
Returns stored overrides of styles for layers.
Returns the stored layer set.
Returns a list of the layers which will be rendered within this map item, considering any locked layers, linked map theme, and data defined settings.
Creates a transform from layout coordinates to map coordinates.
Returns the map item's flags, which control how the map content is drawn.
Returns the rotation used for drawing the map within the layout item, in degrees clockwise.
Returns map settings that will be used for drawing of the map.
Transforms map coordinates to item coordinates (considering rotation and move offset)
Returns the conversion factor from map units to layout units.
- param dx
- rtype
bool
- rtype
int
Returns the map item's first overview.
Returns the map item's overview stack, which is used to control how overviews are drawn over the map's contents.
- param painter
Returns the current position (in layout units) of a
reference
point for the item.Returns the map's preset coordinate reference system.
Returns the labeling results of the most recent preview map render.
Sets object properties from a DOM element
- param element
Refresh item's background color, considering data defined colors.
Refresh item's blend mode, considering data defined blend mode.
- param property
Refresh item's frame, considering data defined colors and frame size.
Refreshes an item's position by rechecking it against any possible overrides such as data defined positioning.
Refreshes an item's rotation by rechecking it against any possible overrides such as data defined rotation.
Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes.
Refresh item's opacity, considering data defined opacity.
Removes the specified layout
item
from the map's "label blocking items".Removes a previously added rendered feature
handler
.Returns map rendering errors
Calculates the extent to request and the yShift of the top-left point in case of rotation.
- rtype
bool
Returns the map scale.
Sets whether the map extent will follow the current atlas feature.
Sets the margin size (percentage) used when the map is in atlas mode.
Sets the current atlas scaling mode.
Sets the map's preset
crs
(coordinate reference system).Sets whether annotations are drawn within the map.
Sets a new
extent
for the map.Sets a fixed
size
for the layout item, which prevents it from being freely resized.Sets whether the map should follow a map theme.
Sets preset name for map rendering.
- param width
Sets whether the stored layer set should be used or the current layer set of the associated project.
Sets whether current styles of layers should be overridden by previously stored styles.
Sets the
margin
from the map edges in which no labels may be placed.Sets the stored overrides of styles for layers.
Sets the stored
layers
set.Sets the map item's
flags
, which control how the map content is drawn.Sets the
rotation
for the map - this does not affect the layout item shape, only the way the map is drawn within the item.Sets the minimum allowed
size
for the layout item.- param dx
Sets new map
scale
and changes only the map extent.Stores the current project layer styles into style overrides.
Returns the position for the reference point of the item, if the top-left of the item was placed at the specified
point
.Returns extent that considers rotation and shift with mOffsetX / mOffsetY
- rtype
int
Updates the bounding rect of this item.
Returns a polygon representing the current visible map extent, considering map extents and rotation.
Stores object properties within an XML DOM element.
- param element
- param factor
Zooms the map so that the specified
extent
is fully visible within the map item.Signals
Emitted when the map's coordinate reference system is changed.
Emitted when the map's extent changes.
Emitted when layer style overrides are changed.
Emitted when the map's rotation changes.
Emitted when the map has been prepared for atlas rendering, just before actual rendering [signal]
Emitted whenever the item's map preview has been refreshed.
Emitted when the map's associated
theme
is changed.Attributes
- class AtlasScalingMode¶
Bases:
int
- Auto = 2¶
- Fixed = 0¶
- class MapItemFlag¶
Bases:
int
- class MapItemFlags¶
- class MapItemFlags(Union[QgsLayoutItemMap.MapItemFlags, QgsLayoutItemMap.MapItemFlag]) None
- class MapItemFlags(QgsLayoutItemMap.MapItemFlags) None
Bases:
sip.wrapper
- Predefined = 1¶
- ShowPartialLabels = 1¶
- ShowUnplacedLabels = 2¶
- accept(self, visitor: QgsStyleEntityVisitorInterface) bool ¶
- Parameters
visitor (QgsStyleEntityVisitorInterface) –
- Return type
bool
- addLabelBlockingItem(self, item: QgsLayoutItem)¶
Sets the specified layout
item
as a “label blocking item” for this map.Items which are marked as label blocking items prevent any map labels from being placed in the area of the map item covered by the
item
.See also
See also
New in version 3.6.
- Parameters
item (QgsLayoutItem) –
- addRenderedFeatureHandler(self, handler: QgsRenderedFeatureHandlerInterface)¶
Adds a rendered feature
handler
to use while rendering the map.Ownership of
handler
is NOT transferred, and it is the caller’s responsibility to ensure that the handler exists for as long as it is registered with the map item.Callers should call
removeRenderedFeatureHandler()
to remove the handler before destroying thehandler
.See also
New in version 3.10.
- Parameters
handler (QgsRenderedFeatureHandlerInterface) –
- adjustPointForReferencePosition(self, point: Union[QPointF, QPoint], size: QSizeF, reference: QgsLayoutItem.ReferencePoint) QPointF ¶
Adjusts the specified
point
at which areference
position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position.
- applyDataDefinedSize(self, size: QgsLayoutSize) QgsLayoutSize ¶
Applies any present data defined size overrides to the specified layout
size
.
- applyItemSizeConstraint(self, targetSize: QSizeF) QSizeF ¶
Applies any item-specific size constraint handling to a given
targetSize
in layout units. Subclasses can override this method if they need to apply advanced logic regarding item sizes, which cannot be covered bysetFixedSize()
orsetMinimumSize()
. Item size constraints are applied after fixed, minimum and data defined size constraints.See also
See also
- assignFreeId(self)¶
Sets the map
id()
to a number not yet used in the layout. The existingid()
is kept if it is not in use.
- atlasClippingSettings(self) QgsLayoutItemMapAtlasClippingSettings ¶
Returns the map’s atlas clipping settings.
New in version 3.16.
- Return type
- atlasDriven(self) bool ¶
Returns whether the map extent is set to follow the current atlas feature.
- Return type
bool
- Returns
True
if map will follow the current atlas feature.
See also
See also
- atlasMargin(self, valueType: QgsLayoutObject.PropertyValueType = QgsLayoutObject.EvaluatedValue) float ¶
Returns the margin size (percentage) used when the map is in atlas mode.
- Parameters
valueType (QgsLayoutObject.PropertyValueType = QgsLayoutObject.EvaluatedValue) – controls whether the returned value is the user specified atlas margin, or the current evaluated atlas margin (which may be affected by data driven atlas margin settings).
- Return type
float
- Returns
margin size in percentage to leave around the atlas feature’s extent
Note
this is only used if
atlasScalingMode()
is Auto.See also
See also
- atlasScalingMode(self) QgsLayoutItemMap.AtlasScalingMode ¶
Returns the current atlas scaling mode. This controls how the map’s extents are calculated for the current atlas feature when an atlas composition is enabled.
- Return type
- Returns
the current scaling mode
Note
this parameter is only used if
atlasDriven()
isTrue
See also
See also
- boundingRect(self) QRectF ¶
- Return type
QRectF
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- containsAdvancedEffects(self) bool ¶
- Return type
bool
- containsWmsLayer(self) bool ¶
Returns
True
if the map contains a WMS layer.- Return type
bool
- contextMenuEvent(self, QGraphicsSceneContextMenuEvent)¶
- create(layout: QgsLayout) QgsLayoutItemMap ¶
Returns a new map item for the specified
layout
.The caller takes responsibility for deleting the returned object.
- Parameters
layout (QgsLayout) –
- Return type
- createExpressionContext(self) QgsExpressionContext ¶
- Return type
- crs(self) QgsCoordinateReferenceSystem ¶
Returns coordinate reference system used for rendering the map. This will match the
presetCrs()
if that is set, or if a preset CRS is not set then the map’s CRS will follow the composition’s project’s CRS.See also
See also
- Return type
- crsChanged¶
Emitted when the map’s coordinate reference system is changed.
New in version 3.18: [signal]
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- displayName(self) str ¶
- Return type
str
- dragEnterEvent(self, QGraphicsSceneDragDropEvent)¶
- dragLeaveEvent(self, QGraphicsSceneDragDropEvent)¶
- dragMoveEvent(self, QGraphicsSceneDragDropEvent)¶
- draw(self, context: QgsLayoutItemRenderContext)¶
- Parameters
context (QgsLayoutItemRenderContext) –
- drawAnnotations(self) bool ¶
Returns whether annotations are drawn within the map.
See also
- Return type
bool
- drawBackground(self, context: QgsRenderContext)¶
Draws the background for the item.
See also
- drawDebugRect(self, painter: QPainter)¶
Draws a debugging rectangle of the item’s current bounds within the specified painter.
- Parameters
painter – destination QPainter
- drawFrame(self, context: QgsRenderContext)¶
Draws the frame around the item.
See also
- dropEvent(self, QGraphicsSceneDragDropEvent)¶
- exportLayerBehavior(self) QgsLayoutItem.ExportLayerBehavior ¶
- Return type
- exportLayerDetails(self) QgsLayoutItem.ExportLayerDetail ¶
- Return type
- extent(self) QgsRectangle ¶
Returns the current map extent.
See also
See also
- Return type
- finalizeRestoreFromXml(self)¶
- focusInEvent(self, QFocusEvent)¶
- focusOutEvent(self, QFocusEvent)¶
- followVisibilityPreset(self) bool ¶
Returns whether the map should follow a map theme. If
True
, the layers and layer styles will be used from given preset name (configured withsetFollowVisibilityPresetName()
method). This means when preset’s settings are changed, the new settings are automatically picked up next time when rendering, without having to explicitly update them. At most one of the flagskeepLayerSet()
andfollowVisibilityPreset()
should be enabled at any time since they are alternative approaches - if both are enabled, following map theme has higher priority. If neither is enabled (or if preset name is not set), map will use the same configuration as the map canvas uses.- Return type
bool
- followVisibilityPresetName(self) str ¶
Preset name that decides which layers and layer styles are used for map rendering. It is only used when
followVisibilityPreset()
returnsTrue
.See also
See also
- Return type
str
- framePath(self) QPainterPath ¶
- Return type
QPainterPath
- grid(self) QgsLayoutItemMapGrid ¶
Returns the map item’s first grid. This is a convenience function.
See also
- Return type
- grids(self) QgsLayoutItemMapGridStack ¶
Returns the map item’s grid stack, which is used to control how grids are drawn over the map’s contents.
See also
- Return type
- hoverEnterEvent(self, QGraphicsSceneHoverEvent)¶
- hoverLeaveEvent(self, QGraphicsSceneHoverEvent)¶
- hoverMoveEvent(self, QGraphicsSceneHoverEvent)¶
- icon(self) QIcon ¶
- Return type
QIcon
- inputMethodEvent(self, QInputMethodEvent)¶
- inputMethodQuery(self, Qt.InputMethodQuery) Any ¶
- invalidateCache(self)¶
- isDrawing(self) bool ¶
True if a draw is already in progress
- Return type
bool
- isLabelBlockingItem(self, item: QgsLayoutItem) bool ¶
Returns
True
if the specifieditem
is a “label blocking item”.Items which are marked as label blocking items prevent any map labels from being placed in the area of the map item covered by the item.
See also
See also
New in version 3.6.
- Parameters
item (QgsLayoutItem) –
- Return type
bool
- isSignalConnected(self, QMetaMethod) bool ¶
- itemChange(self, QGraphicsItem.GraphicsItemChange, Any) Any ¶
- itemClippingSettings(self) QgsLayoutItemMapItemClipPathSettings ¶
Returns the map’s item based clip path settings.
New in version 3.16.
- Return type
- itemFlags(self) QgsLayoutItem.Flags ¶
- Return type
- keepLayerSet(self) bool ¶
Returns whether a stored layer set should be used or the current layer set from the project associated with the layout. This is just a GUI flag, and itself does not change which layers are rendered in the map. Instead, use
setLayers()
to control which layers are rendered.See also
See also
- Return type
bool
- keepLayerStyles(self) bool ¶
Returns whether current styles of layers should be overridden by previously stored styles.
See also
- Return type
bool
- keyPressEvent(self, QKeyEvent)¶
- keyReleaseEvent(self, QKeyEvent)¶
- labelMargin(self) QgsLayoutMeasurement ¶
Returns the margin from the map edges in which no labels may be placed.
If the margin is 0 then labels can be placed right up to the edge (and possibly overlapping the edge) of the map.
See also
New in version 3.6.
- Return type
- layerStyleOverrides(self) Dict[str, str] ¶
Returns stored overrides of styles for layers.
See also
- Return type
Dict[str, str]
- layerStyleOverridesChanged¶
Emitted when layer style overrides are changed… a means to let associated legend items know they should update [signal]
- layers(self) List[QgsMapLayer] ¶
Returns the stored layer set. If empty, the current project layers will be used instead.
See also
See also
- Return type
List[QgsMapLayer]
- layersToRender(self, context: QgsExpressionContext = None) List[QgsMapLayer] ¶
Returns a list of the layers which will be rendered within this map item, considering any locked layers, linked map theme, and data defined settings.
- Parameters
context (
QgsExpressionContext
= None) –- Return type
List[QgsMapLayer]
- layoutToMapCoordsTransform(self) QTransform ¶
Creates a transform from layout coordinates to map coordinates.
- Return type
QTransform
- mapFlags(self) QgsLayoutItemMap.MapItemFlags ¶
Returns the map item’s flags, which control how the map content is drawn.
See also
New in version 3.6.
- Return type
- mapRotation(self, valueType: QgsLayoutObject.PropertyValueType = QgsLayoutObject.EvaluatedValue) float ¶
Returns the rotation used for drawing the map within the layout item, in degrees clockwise.
- Parameters
valueType (QgsLayoutObject.PropertyValueType = QgsLayoutObject.EvaluatedValue) – controls whether the returned value is the user specified rotation, or the current evaluated rotation (which may be affected by data driven rotation settings).
See also
See also
- Return type
float
- mapRotationChanged¶
Emitted when the map’s rotation changes.
See also
See also
mapRotation()
[signal]- Parameters
newRotation (float) –
- mapSettings(self, extent: QgsRectangle, size: QSizeF, dpi: float, includeLayerSettings: bool) QgsMapSettings ¶
Returns map settings that will be used for drawing of the map.
If
includeLayerSettings
isTrue
, than settings specifically relating to map layers and map layer styles will be calculated. This can be expensive to calculate, so if they are not required in the map settings (e.g. for map settings which are used for scale related calculations only) thenincludeLayerSettings
should beFalse
.- Parameters
extent (QgsRectangle) –
size (QSizeF) –
dpi (float) –
includeLayerSettings (bool) –
- Return type
- mapToItemCoords(self, mapCoords: Union[QPointF, QPoint]) QPointF ¶
Transforms map coordinates to item coordinates (considering rotation and move offset)
- Parameters
mapCoords (Union[QPointF) –
- Return type
QPointF
- mapUnitsToLayoutUnits(self) float ¶
Returns the conversion factor from map units to layout units. This is calculated using the width of the map item and the width of the current visible map extent.
- Return type
float
- mouseDoubleClickEvent(self, QGraphicsSceneMouseEvent)¶
- mouseMoveEvent(self, QGraphicsSceneMouseEvent)¶
- mousePressEvent(self, QGraphicsSceneMouseEvent)¶
- mouseReleaseEvent(self, QGraphicsSceneMouseEvent)¶
- moveContent(self, dx: float, dy: float)¶
- Parameters
dx (float) –
dy (float) –
- nextExportPart(self) bool ¶
- Return type
bool
- numberExportLayers(self) int ¶
- Return type
int
- overview(self) QgsLayoutItemMapOverview ¶
Returns the map item’s first overview. This is a convenience function.
- Return type
- Returns
pointer to first overview for map item
See also
- overviews(self) QgsLayoutItemMapOverviewStack ¶
Returns the map item’s overview stack, which is used to control how overviews are drawn over the map’s contents.
- Return type
- Returns
pointer to overview stack
See also
- paint(self, painter: QPainter, itemStyle: QStyleOptionGraphicsItem, pWidget: QWidget)¶
- Parameters
painter (QPainter) –
itemStyle (QStyleOptionGraphicsItem) –
pWidget (QWidget) –
- positionAtReferencePoint(self, reference: QgsLayoutItem.ReferencePoint) QPointF ¶
Returns the current position (in layout units) of a
reference
point for the item.
- prepareGeometryChange(self)¶
- preparedForAtlas¶
Emitted when the map has been prepared for atlas rendering, just before actual rendering [signal]
- presetCrs(self) QgsCoordinateReferenceSystem ¶
Returns the map’s preset coordinate reference system. If set, this CRS will be used to render the map regardless of any project CRS setting. If the returned CRS is not valid then the project CRS will be used to render the map.
See also
See also
- Return type
- previewLabelingResults(self) QgsLabelingResults ¶
Returns the labeling results of the most recent preview map render. May be
None
if no map preview has been rendered in the item.The map item retains ownership of the returned results.
New in version 3.20.
- Return type
- previewRefreshed¶
Emitted whenever the item’s map preview has been refreshed.
New in version 3.20: [signal]
- readObjectPropertiesFromElement(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
Sets object properties from a DOM element
- Parameters
parentElement – is the parent DOM element for the object
document – DOM document
context – read write context
- Returns
True
if read was successful
See also
- readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
- Parameters
element (QDomElement) –
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool
- receivers(self, PYQT_SIGNAL) int ¶
- refresh(self)¶
- refreshBackgroundColor(self, updateItem: bool = True)¶
Refresh item’s background color, considering data defined colors. If
updateItem
is set toFalse
, the item will not be automatically updated after the frame color is set and a later call toupdate()
must be made.
- refreshBlendMode(self)¶
Refresh item’s blend mode, considering data defined blend mode.
- refreshDataDefinedProperty(self, property: QgsLayoutObject.DataDefinedProperty = QgsLayoutObject.AllProperties)¶
- Parameters
property (QgsLayoutObject.DataDefinedProperty = QgsLayoutObject.AllProperties) –
- refreshFrame(self, updateItem: bool = True)¶
Refresh item’s frame, considering data defined colors and frame size. If
updateItem
is set toFalse
, the item will not be automatically updated after the frame is set and a later call toupdate()
must be made.
- refreshItemPosition(self)¶
Refreshes an item’s position by rechecking it against any possible overrides such as data defined positioning.
See also
- refreshItemRotation(self, origin: Union[QPointF, QPoint] = None)¶
Refreshes an item’s rotation by rechecking it against any possible overrides such as data defined rotation.
The optional
origin
point specifies the origin (in item coordinates) around which the rotation should be applied.See also
See also
- refreshItemSize(self)¶
Refreshes an item’s size by rechecking it against any possible item fixed or minimum sizes.
See also
See also
See also
- refreshOpacity(self, updateItem: bool = True)¶
Refresh item’s opacity, considering data defined opacity. If
updateItem
is set toFalse
the item will not be automatically updated after the opacity is set and a later call toupdate()
must be made.
- removeLabelBlockingItem(self, item: QgsLayoutItem)¶
Removes the specified layout
item
from the map’s “label blocking items”.Items which are marked as label blocking items prevent any map labels from being placed in the area of the map item covered by the item.
See also
See also
New in version 3.6.
- Parameters
item (QgsLayoutItem) –
- removeRenderedFeatureHandler(self, handler: QgsRenderedFeatureHandlerInterface)¶
Removes a previously added rendered feature
handler
.See also
New in version 3.10.
- Parameters
handler (QgsRenderedFeatureHandlerInterface) –
- renderingErrors(self) List[QgsMapRendererJob.Error] ¶
Returns map rendering errors
- Return type
List[QgsMapRendererJob.Error]
- Returns
list of errors
- requestedExtent(self) QgsRectangle ¶
Calculates the extent to request and the yShift of the top-left point in case of rotation.
- Return type
- requiresRasterization(self) bool ¶
- Return type
bool
- scale(self) float ¶
Returns the map scale. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
See also
- Return type
float
- sceneEvent(self, QEvent) bool ¶
- sceneEventFilter(self, QGraphicsItem, QEvent) bool ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setAtlasDriven(self, enabled: bool)¶
Sets whether the map extent will follow the current atlas feature.
- Parameters
enabled (bool) – set to
True
if the map extents should be set by the current atlas feature.
See also
See also
- setAtlasMargin(self, margin: float)¶
Sets the margin size (percentage) used when the map is in atlas mode.
- Parameters
margin (float) – size in percentage to leave around the atlas feature’s extent
Note
this is only used if
atlasScalingMode()
is Auto.See also
See also
- setAtlasScalingMode(self, mode: QgsLayoutItemMap.AtlasScalingMode)¶
Sets the current atlas scaling mode. This controls how the map’s extents are calculated for the current atlas feature when an atlas composition is enabled.
- Parameters
mode (QgsLayoutItemMap.AtlasScalingMode) – atlas scaling mode to set
Note
this parameter is only used if
atlasDriven()
isTrue
See also
See also
- setCrs(self, crs: QgsCoordinateReferenceSystem)¶
Sets the map’s preset
crs
(coordinate reference system). If a valid CRS is set, this CRS will be used to render the map regardless of any project CRS setting. If the CRS is not valid then the project CRS will be used to render the map.See also
See also
- Parameters
crs (QgsCoordinateReferenceSystem) –
- setDrawAnnotations(self, draw: bool)¶
Sets whether annotations are drawn within the map.
See also
- Parameters
draw (bool) –
- setExtent(self, extent: QgsRectangle)¶
Sets a new
extent
for the map. This method may change the width or height of the map item to ensure that the extent exactly matches the specified extent, with no overlap or margin. This method implicitly alters the map scale.See also
See also
- Parameters
extent (QgsRectangle) –
- setFixedSize(self, size: QgsLayoutSize)¶
Sets a fixed
size
for the layout item, which prevents it from being freely resized. Set an empty size if item can be freely resized.See also
fixedSize()
See also
- setFollowVisibilityPreset(self, follow: bool)¶
Sets whether the map should follow a map theme. See
followVisibilityPreset()
for more details.- Parameters
follow (bool) –
- setFollowVisibilityPresetName(self, name: str)¶
Sets preset name for map rendering. See
followVisibilityPresetName()
for more details.See also
See also
- Parameters
name (str) –
- setFrameStrokeWidth(self, width: QgsLayoutMeasurement)¶
- Parameters
width (QgsLayoutMeasurement) –
- setKeepLayerSet(self, enabled: bool)¶
Sets whether the stored layer set should be used or the current layer set of the associated project. This is just a GUI flag, and itself does not change which layers are rendered in the map. Instead, use
setLayers()
to control which layers are rendered.See also
See also
- Parameters
enabled (bool) –
- setKeepLayerStyles(self, enabled: bool)¶
Sets whether current styles of layers should be overridden by previously stored styles.
See also
- Parameters
enabled (bool) –
- setLabelMargin(self, margin: QgsLayoutMeasurement)¶
Sets the
margin
from the map edges in which no labels may be placed.If the margin is 0 then labels can be placed right up to the edge (and possibly overlapping the edge) of the map.
See also
New in version 3.6.
- Parameters
margin (QgsLayoutMeasurement) –
- setLayerStyleOverrides(self, overrides: Dict[str, str])¶
Sets the stored overrides of styles for layers.
See also
- Parameters
overrides (Dict[str) –
- setLayers(self, layers: Iterable[QgsMapLayer])¶
Sets the stored
layers
set. If empty, the current project layers will be used. If the map item is set to follow a map theme (viafollowVisibilityPreset()
andfollowVisibilityPresetName()
), then this method will have no effect and the layers rendered in the map will always follow the map theme.See also
See also
See also
See also
- Parameters
layers (Iterable[QgsMapLayer]) –
- setMapFlags(self, flags: Union[QgsLayoutItemMap.MapItemFlags, QgsLayoutItemMap.MapItemFlag])¶
Sets the map item’s
flags
, which control how the map content is drawn.See also
New in version 3.6.
- Parameters
flags (Union[QgsLayoutItemMap.MapItemFlags) –
- setMapRotation(self, rotation: float)¶
Sets the
rotation
for the map - this does not affect the layout item shape, only the way the map is drawn within the item. Rotation is in degrees, clockwise.See also
See also
- Parameters
rotation (float) –
- setMinimumSize(self, size: QgsLayoutSize)¶
Sets the minimum allowed
size
for the layout item. Set an empty size if item can be freely resized.See also
minimumSize()
See also
- setMoveContentPreviewOffset(self, dx: float, dy: float)¶
- Parameters
dx (float) –
dy (float) –
- setScale(self, scale: float, forceUpdate: bool = True)¶
Sets new map
scale
and changes only the map extent.The
scale
value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.See also
- Parameters
scale (float) –
forceUpdate (bool = True) –
- startLayeredExport(self)¶
- stopLayeredExport(self)¶
- storeCurrentLayerStyles(self)¶
Stores the current project layer styles into style overrides.
- themeChanged¶
Emitted when the map’s associated
theme
is changed.Note
This signal is not emitted when the definition of the theme changes, only the map is linked to a different theme then it previously was.
New in version 3.14: [signal]
- Parameters
theme (str) –
- timerEvent(self, QTimerEvent)¶
- topLeftToReferencePoint(self, point: QgsLayoutPoint) QgsLayoutPoint ¶
Returns the position for the reference point of the item, if the top-left of the item was placed at the specified
point
.
- transformedMapPolygon(self) QPolygonF ¶
Returns extent that considers rotation and shift with mOffsetX / mOffsetY
- Return type
QPolygonF
- type(self) int ¶
- Return type
int
- updateBoundingRect(self)¶
Updates the bounding rect of this item. Call this function before doing any changes related to annotation out of the map rectangle
- updateMicroFocus(self)¶
- visibleExtentPolygon(self) QPolygonF ¶
Returns a polygon representing the current visible map extent, considering map extents and rotation. If the map rotation is 0, the result is the same as currentMapExtent
- Return type
QPolygonF
- Returns
polygon with the four corner points representing the visible map extent. The points are clockwise, starting at the top-left point
See also
- wheelEvent(self, QGraphicsSceneWheelEvent)¶
- writeObjectPropertiesToElement(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
Stores object properties within an XML DOM element.
- Parameters
parentElement – is the parent DOM element to store the object’s properties in
document – DOM document
context – read write context
- Returns
True
if write was successful
See also
- writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
- Parameters
element (QDomElement) –
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool
- zoomContent(self, factor: float, point: Union[QPointF, QPoint])¶
- Parameters
factor (float) –
point (Union[QPointF) –
- zoomToExtent(self, extent: QgsRectangle)¶
Zooms the map so that the specified
extent
is fully visible within the map item. This method will not change the width or height of the map, and may result in an overlap or margin from the specified extent. This method implicitly alters the map scale.See also
- Parameters
extent (QgsRectangle) –