Class: QgsLayoutItemMapItemStack¶
-
class
qgis.core.
QgsLayoutItemMapItemStack
(map: QgsLayoutItemMap)¶ Bases:
sip.wrapper
Constructor for
QgsLayoutItemMapItemStack
, attached to the specifiedmap
.QgsLayoutItemMapItemStack(
QgsLayoutItemMapItemStack
)A collection of map items which are drawn above the map content in a
QgsLayoutItemMap
. The item stack controls which items are drawn and the order they are drawn in.See also
New in version 3.0.
- Parameters
map –
-
addItem
(self, item: QgsLayoutItemMapItem)¶ Adds a new map item to the stack and takes ownership of the item. The item will be added to the end of the stack, and rendered above any existing map items already present in the stack.
Note
After adding an item to the stack update() should be called for the
QgsLayoutItemMap
to prevent rendering artifacts.See also
- Parameters
item (QgsLayoutItemMapItem) –
-
asList
(self) → List[QgsLayoutItemMapItem]¶ Returns a list of
QgsLayoutItemMapItems
contained by the stack.- Return type
List[QgsLayoutItemMapItem]
-
containsAdvancedEffects
(self) → bool¶ Returns whether any items within the stack contain advanced effects, such as blending modes.
- Return type
bool
-
drawItems
(self, painter: QPainter, ignoreStacking: bool = True)¶ Draws the items from the stack on a specified
painter
.If
ignoreStacking
isTrue
, then all items will be drawn, regardless of their actual stacking position settings. If it isFalse
, only items which are set to stack above the map item will be drawn.- Parameters
painter (QPainter) –
ignoreStacking (bool = True) –
-
finalizeRestoreFromXml
(self)¶ Called after all pending items have been restored from XML. Map item stacks 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.
See also
-
hasEnabledItems
(self) → bool¶ Returns
True
if the stack has any currently enabled items.New in version 3.10.
- Return type
bool
-
item
(self, index: int) → QgsLayoutItemMapItem¶ Returns a reference to the item at the specified
index
within the stack.item(self, itemId: str) -> QgsLayoutItemMapItem Returns a reference to an item which matching
itemId
within the stack.- Parameters
index (int) –
- Return type
-
moveItemDown
(self, itemId: str)¶ Moves an item which matching
itemId
up the stack, causing it to be rendered above other items.Note
After moving an item within the stack, update() should be called for the
QgsLayoutItemMap
to redraw the map with the new item stack order.See also
- Parameters
itemId (str) –
-
moveItemUp
(self, itemId: str)¶ Moves an item which matching
itemId
up the stack, causing it to be rendered above other items.Note
After moving an item within the stack, update() should be called for the
QgsLayoutItemMap
to redraw the map with the new item stack order.See also
- Parameters
itemId (str) –
-
readXml
(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool¶ Sets the item stack’s state from a DOM document, where
element
is a DOM node corresponding to a ‘LayoutMap’ tag. ReturnsTrue
if read was successful.See also
- Parameters
element (QDomElement) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool
-
removeItem
(self, itemId: str)¶ Removes an item which matching
itemId
from the stack and deletes the correspondingQgsLayoutItemMapItem
Note
After removing an item from the stack, update() should be called for the
QgsLayoutItemMap
to prevent rendering artifacts.See also
- Parameters
itemId (str) –
-
removeItems
(self)¶ Clears the item stack and deletes all
QgsLayoutItemMapItems
contained by the stack
-
size
(self) → int¶ Returns the number of items in the stack.
- Return type
int
-
writeXml
(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool¶ Stores the state of the item stack in a DOM node, where
element
is the DOM element corresponding to a ‘LayoutMap’ tag. ReturnsTrue
if write was successful.See also
- Parameters
element (QDomElement) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool