Class: QgsLayoutItemMarker¶
- class qgis.core.QgsLayoutItemMarker(layout: QgsLayout)¶
Bases:
QgsLayoutItem
Constructor for
QgsLayoutItemMarker
, with the specified parentlayout
.A layout item for showing marker symbols.
Methods
- param visitor
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.- rtype
QRectF
Returns a new marker item for the specified
layout
.- param context
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
QgsLayoutSize
Returns the path to use when drawing the item’s frame or background.
- rtype
QIcon
Returns the linked rotation map, if set.
When the marker is linked to a map in north arrow rotation mode, returns the current north arrow rotation for the marker.
Returns the mode used to align the marker to a map’s North.
Returns the offset added to the marker’s rotation from a map’s North.
Returns the current position (in layout units) of a
reference
point for the item.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.
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.
Sets a fixed
size
for the layout item, which prevents it from being freely resized.Sets the
map
object for rotation.Sets the minimum allowed
size
for the layout item.Sets the
mode
used to align the marker to a map’s North.Sets the
offset
added to the marker’s rotation from a map’s North.Sets the marker
symbol
used to draw the shape.Returns the marker symbol used to draw the shape.
Returns the position for the reference point of the item, if the top-left of the item was placed at the specified
point
.- rtype
int
Stores object properties within an XML DOM element.
- param element
- accept(self, visitor: QgsStyleEntityVisitorInterface) → bool¶
- Parameters
visitor (QgsStyleEntityVisitorInterface) –
- Return type
bool
- 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
- boundingRect(self) → QRectF¶
- Return type
QRectF
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QGraphicsSceneContextMenuEvent)¶
- create(layout: QgsLayout) → QgsLayoutItemMarker¶
Returns a new marker item for the specified
layout
.The caller takes responsibility for deleting the returned object.
- Parameters
layout (QgsLayout) –
- Return type
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- dragEnterEvent(self, QGraphicsSceneDragDropEvent)¶
- dragLeaveEvent(self, QGraphicsSceneDragDropEvent)¶
- dragMoveEvent(self, QGraphicsSceneDragDropEvent)¶
- draw(self, context: QgsLayoutItemRenderContext)¶
- Parameters
context (QgsLayoutItemRenderContext) –
- 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)¶
- finalizeRestoreFromXml(self)¶
- fixedSize(self) → QgsLayoutSize¶
- Return type
- focusInEvent(self, QFocusEvent)¶
- focusOutEvent(self, QFocusEvent)¶
- framePath(self) → QPainterPath¶
Returns the path to use when drawing the item’s frame or background.
See also
See also
New in version 3.16.
- hoverEnterEvent(self, QGraphicsSceneHoverEvent)¶
- hoverLeaveEvent(self, QGraphicsSceneHoverEvent)¶
- hoverMoveEvent(self, QGraphicsSceneHoverEvent)¶
- icon(self) → QIcon¶
- Return type
QIcon
- inputMethodEvent(self, QInputMethodEvent)¶
- inputMethodQuery(self, Qt.InputMethodQuery) → Any¶
- isSignalConnected(self, QMetaMethod) → bool¶
- itemChange(self, QGraphicsItem.GraphicsItemChange, Any) → Any¶
- keyPressEvent(self, QKeyEvent)¶
- keyReleaseEvent(self, QKeyEvent)¶
- linkedMap(self) → QgsLayoutItemMap¶
Returns the linked rotation map, if set. An
None
means map rotation is disabled. If this is set then the marker is rotated by the same amount as the specified map object.See also
- Return type
- mouseDoubleClickEvent(self, QGraphicsSceneMouseEvent)¶
- mouseMoveEvent(self, QGraphicsSceneMouseEvent)¶
- mousePressEvent(self, QGraphicsSceneMouseEvent)¶
- mouseReleaseEvent(self, QGraphicsSceneMouseEvent)¶
- northArrowRotation(self) → float¶
When the marker is linked to a map in north arrow rotation mode, returns the current north arrow rotation for the marker.
See also
- Return type
float
- northMode(self) → QgsLayoutNorthArrowHandler.NorthMode¶
Returns the mode used to align the marker to a map’s North.
See also
See also
- Return type
- northOffset(self) → float¶
Returns the offset added to the marker’s rotation from a map’s North.
See also
See also
- Return type
float
- positionAtReferencePoint(self, reference: QgsLayoutItem.ReferencePoint) → QPointF¶
Returns the current position (in layout units) of a
reference
point for the item.
- prepareGeometryChange(self)¶
- 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¶
- 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.
- 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.
- sceneEvent(self, QEvent) → bool¶
- sceneEventFilter(self, QGraphicsItem, QEvent) → bool¶
- sender(self) → QObject¶
- senderSignalIndex(self) → int¶
- 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
See also
- setLinkedMap(self, map: QgsLayoutItemMap)¶
Sets the
map
object for rotation.If this is set then the marker will be rotated by the same amount as the specified map object. This is useful especially for syncing north arrows with a map item.
See also
- Parameters
map (QgsLayoutItemMap) –
- 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
- setNorthMode(self, mode: QgsLayoutNorthArrowHandler.NorthMode)¶
Sets the
mode
used to align the marker to a map’s North.See also
See also
- Parameters
mode (QgsLayoutNorthArrowHandler.NorthMode) –
- setNorthOffset(self, offset: float)¶
Sets the
offset
added to the marker’s rotation from a map’s North.See also
See also
- Parameters
offset (float) –
- setSymbol(self, symbol: QgsMarkerSymbol)¶
Sets the marker
symbol
used to draw the shape. Ownership is transferred.See also
- Parameters
symbol (QgsMarkerSymbol) –
- symbol(self) → QgsMarkerSymbol¶
Returns the marker symbol used to draw the shape.
See also
- Return type
- 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
.
- type(self) → int¶
- Return type
int
- updateMicroFocus(self)¶
- 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