Class: QgsModelArrowItem

A link arrow item for use in the model designer.

Warning

Not stable API

Added in version 3.14.

List of all members, including inherited members

Class Hierarchy

Inheritance diagram of qgis.gui.QgsModelArrowItem

Base classes

QObject

QGraphicsPathItem

QAbstractGraphicsShapeItem

QGraphicsItem

Constructor

__init__

Enums

Marker

Methods

endEdge

Returns the edge of the end item that arrow ends at.

endIndex

Returns the index of the end item that arrow ends at.

endItem

Returns the item at the end of the arrow.

setPenStyle

Sets the pen style to use for rendering the arrow line.

startEdge

Returns the edge of the start item that arrow begins at.

startIndex

Returns the index of the start item that arrow begins at.

startItem

Returns the item at the start of the arrow.

updatePath

Updates the cached path linking the two items.

class qgis.gui.QgsModelArrowItem[source]

Bases: QObject, QGraphicsPathItem

__init__(startItem: QgsModelComponentGraphicItem | None, startEdge: Qt.Edge, startIndex: int, startIsOutgoing: bool, startMarker: QgsModelArrowItem.Marker, endItem: QgsModelComponentGraphicItem | None, endEdge: Qt.Edge, endIndex: int, endIsIncoming: bool, endMarker: QgsModelArrowItem.Marker)

Constructor for QgsModelArrowItem, with the specified parent item.

The arrow will link startItem to endItem, joining the specified startEdge and startIndex to endEdge and endIndex.

Parameters:
__init__(startItem: QgsModelComponentGraphicItem | None, startEdge: Qt.Edge, startIndex: int, startMarker: QgsModelArrowItem.Marker, endItem: QgsModelComponentGraphicItem | None, endMarker: QgsModelArrowItem.Marker)

Constructor for QgsModelArrowItem, with the specified parent item.

The arrow will link startItem to endItem, joining the specified startEdge and startIndex to an automatic point on endItem.

Parameters:
__init__(startItem: QgsModelComponentGraphicItem | None, startMarker: QgsModelArrowItem.Marker, endItem: QgsModelComponentGraphicItem | None, endEdge: Qt.Edge, endIndex: int, endMarker: QgsModelArrowItem.Marker)

Constructor for QgsModelArrowItem, with the specified parent item.

The arrow will link startItem to endItem, joining an automatic point on startItem to the specified endEdge and endIndex.

Parameters:
__init__(startItem: QgsModelComponentGraphicItem | None, startMarker: QgsModelArrowItem.Marker, endItem: QgsModelComponentGraphicItem | None, endMarker: QgsModelArrowItem.Marker)

Constructor for QgsModelArrowItem, with the specified parent item.

The arrow will link startItem to endItem, joining an automatic points on both items.

Parameters:
ArrowHead = 1
Circle = 0
class Marker(*values)

Bases: IntEnum

ArrowHead = 1
Circle = 0
NoMarker = 2
NoMarker = 2
endEdge(self) Qt.Edge[source]

Returns the edge of the end item that arrow ends at.

See also

startEdge()

Return type:

Qt.Edge

endIndex(self) int[source]

Returns the index of the end item that arrow ends at.

See also

startIndex()

Return type:

int

endItem(self) QgsModelComponentGraphicItem | None[source]

Returns the item at the end of the arrow.

See also

startItem()

Return type:

Optional[QgsModelComponentGraphicItem]

setPenStyle(self, style: Qt.PenStyle)[source]

Sets the pen style to use for rendering the arrow line.

Parameters:

style (Qt.PenStyle)

startEdge(self) Qt.Edge[source]

Returns the edge of the start item that arrow begins at.

See also

endEdge()

Return type:

Qt.Edge

startIndex(self) int[source]

Returns the index of the start item that arrow begins at.

See also

endIndex()

Return type:

int

startItem(self) QgsModelComponentGraphicItem | None[source]

Returns the item at the start of the arrow.

See also

endItem()

Return type:

Optional[QgsModelComponentGraphicItem]

updatePath(self)[source]

Updates the cached path linking the two items.