bpmnedge

Model definitions for BPMN edges.

CLASS	DESCRIPTION
BPMNEdge	A BPMNEdge is an edge that depicts a relationship between two BPMN model elements.

Classes

BPMNEdge dataclass

BPMNEdge(
    *,
    id: Optional[str] = None,
    waypoint: list[Waypoint] = list(),
    label: Optional[BPMNLabel] = None,
    bpmn_element: Optional[str] = None,
    source_element: Optional[str] = None,
    target_element: Optional[str] = None,
    message_visible_kind: Optional[MessageVisibleKind] = None
)

Bases: LabeledEdge

A BPMNEdge is an edge that depicts a relationship between two BPMN model elements.

ATTRIBUTE	DESCRIPTION
bpmn_element	A reference to a connecting BPMN element that this edge depicts. TYPE: Optional[str]
label	An optional label that is nested when the edge has a visible text label with its own bounding box. TYPE: Optional[BPMNLabel]
message_visible_kind	An optional attribute that should be used only for Message Flow. TYPE: Optional[MessageVisibleKind]
source_element	An optional reference to the edge’s source element if different from the source inferred from bpmn_element. TYPE: Optional[str]
target_element	An optional reference to the edge’s target element if different from the target inferred from the bpmn_element. TYPE: Optional[str]

Attributes

bpmn_element class-attribute instance-attribute

bpmn_element: Optional[str] = field(
    default=None, metadata={"name": "bpmnElement", "type": "Attribute"}
)

A reference to a connecting BPMN element that this edge depicts.

label class-attribute instance-attribute

label: Optional[BPMNLabel] = field(
    default=None, metadata={"name": "BPMNLabel", "type": "Element"}
)

An optional label that is nested when the edge has a visible text label with its own bounding box.

message_visible_kind class-attribute instance-attribute

message_visible_kind: Optional[MessageVisibleKind] = field(
    default=None, metadata={"name": "messageVisibleKind", "type": "Attribute"}
)

An optional attribute that should be used only for Message Flow.

source_element class-attribute instance-attribute

source_element: Optional[str] = field(
    default=None, metadata={"name": "sourceElement", "type": "Attribute"}
)

An optional reference to the edge’s source element if different from the source inferred from bpmn_element.

target_element class-attribute instance-attribute

target_element: Optional[str] = field(
    default=None, metadata={"name": "targetElement", "type": "Attribute"}
)

An optional reference to the edge’s target element if different from the target inferred from the bpmn_element.

Functions