Class: QgsLayoutItemMarker¶

class qgis.core.QgsLayoutItemMarker(layout: QgsLayout)¶

Bases: QgsLayoutItem

Constructor for QgsLayoutItemMarker, with the specified parent layout.

A layout item for showing marker symbols.

New in version 3.14.

Parameters: layout –

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 a reference 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 by setFixedSize() or setMinimumSize(). Item size constraints are applied after fixed, minimum and data defined size constraints.

See also

setFixedSize()

See also

setMinimumSize()

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: QgsLayoutItemMarker

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.

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.

dropEvent(self, QGraphicsSceneDragDropEvent)¶

finalizeRestoreFromXml(self)¶

fixedSize(self) → QgsLayoutSize ¶

Return type: QgsLayoutSize

focusInEvent(self, QFocusEvent)¶

focusOutEvent(self, QFocusEvent)¶

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

setLinkedMap()

Return type: QgsLayoutItemMap

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

setLinkedMap()

Return type: float

northMode(self) → QgsLayoutNorthArrowHandler.NorthMode¶

Returns the mode used to align the marker to a map’s North.

See also

setNorthMode()

See also

northOffset()

Return type: QgsLayoutNorthArrowHandler.NorthMode

northOffset(self) → float¶

Returns the offset added to the marker’s rotation from a map’s North.

See also

setNorthOffset()

See also

northMode()

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

writeObjectPropertiesToElement()

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 to False, the item will not be automatically updated after the frame color is set and a later call to update() 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 to False, the item will not be automatically updated after the frame is set and a later call to update() must be made.

refreshItemPosition(self)¶: Refreshes an item’s position by rechecking it against any possible overrides such as data defined positioning.

See also

refreshItemSize()

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

refreshItemSize()

See also

refreshItemPosition()

refreshItemSize(self)¶: Refreshes an item’s size by rechecking it against any possible item fixed or minimum sizes.

See also

setFixedSize()

See also

setMinimumSize()

See also

refreshItemPosition()

refreshOpacity(self, updateItem: bool = True)¶: Refresh item’s opacity, considering data defined opacity. If updateItem is set to False the item will not be automatically updated after the opacity is set and a later call to update() 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

fixedSize()

See also

setMinimumSize()

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

linkedMap()

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

setFixedSize()

setNorthMode(self, mode: QgsLayoutNorthArrowHandler.NorthMode)¶

Sets the mode used to align the marker to a map’s North.

See also

northMode()

See also

setNorthOffset()

Parameters: mode (QgsLayoutNorthArrowHandler.NorthMode) –

setNorthOffset(self, offset: float)¶

Sets the offset added to the marker’s rotation from a map’s North.

See also

northOffset()

See also

setNorthMode()

Parameters: offset (float) –

setSymbol(self, symbol: QgsMarkerSymbol)¶

Sets the marker symbol used to draw the shape. Ownership is transferred.

See also

symbol()

Parameters: symbol (QgsMarkerSymbol) –

symbol(self) → QgsMarkerSymbol ¶

Returns the marker symbol used to draw the shape.

See also

setSymbol()

Return type: QgsMarkerSymbol

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

readObjectPropertiesFromElement()

writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶

Parameters

element (QDomElement) –
document (QDomDocument) –
context (QgsReadWriteContext) –

Return type

bool