Class: QgsLayoutNodesItem

class qgis.core.QgsLayoutNodesItem(layout: QgsLayout)

Bases: QgsLayoutItem

Constructor for QgsLayoutNodesItem, attached to the specified layout.

QgsLayoutNodesItem(polygon: QPolygonF, layout: QgsLayout) Constructor for a QgsLayoutNodesItem with the given polygon nodes, attached to the specified layout.

An abstract layout item that provides generic methods for node based shapes such as polygon or polylines.

New in version 3.0.

Parameters

layout

addNode(self, point: Union[QPointF, QPoint], checkArea: bool = True, radius: float = 10) → bool

Add a node in current shape.

Parameters
  • point (Union[QPointF) – is the location of the new node (in scene coordinates)

  • checkArea (bool = True) – is a flag to indicate if there’s a space constraint.

  • radius (float = 10) – is the space contraint and is used only if checkArea is true. Typically, if this flag is True, the new node has to be nearer than radius to the shape to be added.

Return type

bool

adjustPointForReferencePosition()
applyDataDefinedSize()
applyItemSizeConstraint()
boundingRect(self) → QRectF
Return type

QRectF

childEvent()
computeDistance(self, pt1: Union[QPointF, QPoint], pt2: Union[QPointF, QPoint]) → float

Compute an euclidian distance between 2 nodes.

Parameters
  • pt1 (Union[QPointF) –

  • pt2 (Union[QPointF) –

Return type

float

connectNotify()
contextMenuEvent()
customEvent()
deselectNode(self)

Deselects any selected nodes.

disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
draw(self, context: QgsLayoutItemRenderContext)
Parameters

context (QgsLayoutItemRenderContext) –

drawBackground()
drawDebugRect()
drawFrame()
dropEvent()
estimatedFrameBleed(self) → float
Return type

float

focusInEvent()
focusOutEvent()
hoverEnterEvent()
hoverLeaveEvent()
hoverMoveEvent()
inputMethodEvent()
inputMethodQuery()
isSignalConnected()
itemChange()
keyPressEvent()
keyReleaseEvent()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveNode(self, index: int, node: Union[QPointF, QPoint]) → bool

Moves a node to a new position.

Parameters
  • index (int) – the index of the node to move

  • node (Union[QPointF) – is the new position in scene coordinate

Return type

bool

nodeAtPosition(self, point: Union[QPointF, QPoint], searchInRadius: bool = True, radius: float = 10) → int

Search for the nearest node in the shape within a maximal area. Returns the index of the nearest node or -1 if no node was found.

Parameters
  • point (Union[QPointF) – is the location to search for nodes from (in scene coordinates)

  • searchInRadius (bool = True) – is a flag to indicate if the area of research is limited in space.

  • radius (float = 10) – is only used if searchInRadius is True

Return type

int

nodePosition(self, index: int, position: Union[QPointF, QPoint]) → bool

Gets the position of a node in scene coordinates.

Parameters
  • index (int) – of the node

  • position (Union[QPointF) – the position of the node

Return type

bool

Returns

True if the index is valid and the position is set, False otherwise

nodes(self) → QPolygonF

Returns the nodes the shape consists of.

See also

setNodes()

Return type

QPolygonF

nodesSize(self) → int

Returns the number of nodes in the shape.

Return type

int

positionAtReferencePoint()
prepareGeometryChange()
readObjectPropertiesFromElement()
readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
Parameters
Return type

bool

receivers()
refreshBackgroundColor()
refreshBlendMode()
refreshFrame()
refreshItemPosition()
refreshItemRotation()
refreshItemSize()
refreshOpacity()
removeNode(self, index: int) → bool

Remove a node with specified index from the shape.

Parameters

index (int) –

Return type

bool

rescaleToFitBoundingBox(self)

Rescale the current shape according to the item’s bounding box. Useful when the shape is resized thanks to the rubber band.

sceneEvent()
sceneEventFilter()
selectedNode(self) → int

Returns the currently selected node, or -1 if no node is selected.

Return type

int

sender()
senderSignalIndex()
setDisplayNodes(self, display: bool = True)

Set whether the item’s nodes should be displayed.

Parameters

display (bool = True) –

setFixedSize()
setMinimumSize()
setNodes(self, nodes: QPolygonF)

Sets the nodes the shape consists of.

See also

nodes()

Parameters

nodes (QPolygonF) –

setSelectedNode(self, index: int) → bool

Selects a node by index.

Parameters

index (int) –

Return type

bool

timerEvent()
topLeftToReferencePoint()
updateBoundingRect(self)

Called when the bounding rect of the item should recalculated. Subclasses should update currentRectangle in their implementations.

updateMicroFocus()
updateSceneRect(self)

Update the current scene rectangle for this item.

wheelEvent()
writeObjectPropertiesToElement()
writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
Parameters
Return type

bool