bpmnshape

A model definition of a BPMNShape.

CLASS	DESCRIPTION
BPMNShape	A BPMNShape is a shape that can depict a BPMN model element.

Classes

BPMNShape dataclass

BPMNShape(
    *,
    id: Optional[str] = None,
    bounds: Bounds,
    label: Optional[BPMNLabel] = None,
    bpmn_element: Optional[str] = None,
    is_horizontal: Optional[bool] = None,
    is_expanded: Optional[bool] = None,
    is_marker_visible: Optional[bool] = None,
    is_message_visible: Optional[bool] = None,
    participant_band_kind: Optional[ParticipantBandKind] = None,
    choreography_activity_shape: Optional[str] = None
)

Bases: LabeledShape

A BPMNShape is a shape that can depict a BPMN model element.

ATTRIBUTE	DESCRIPTION
bpmn_element	A reference to a BPMN node element that this shape depicts. TYPE: Optional[str]
choreography_activity_shape	An optional attribute that should only be used for Participant Bands. It is REQUIRED for a BPMNShape depicting TYPE: Optional[str]
is_expanded	An optional attribute that should be used only for SubProcess, AdHocSubProcess, Transaction, SubChoreographies, TYPE: Optional[bool]
is_horizontal	An optional attribute that should be used only for Pools and Lanes. TYPE: Optional[bool]
is_marker_visible	An optional attribute that should be used only for Exclusive Gateway. TYPE: Optional[bool]
is_message_visible	An optional attribute that should only be used for Participant Bands. TYPE: Optional[bool]
label	An optional label that is nested when the shape has a visible text label with its own bounding box. TYPE: Optional[BPMNLabel]
participant_band_kind	An optional attribute that should only be used for Participant Bands. If this attribute is present, TYPE: Optional[ParticipantBandKind]

Attributes

bpmn_element class-attribute instance-attribute

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

A reference to a BPMN node element that this shape depicts.

choreography_activity_shape class-attribute instance-attribute

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

An optional attribute that should only be used for Participant Bands. It is REQUIRED for a BPMNShape depicting a Participant Band. This is REQUIRED to relate the Participant Band to the BPMNShape depicting the Choreography Activity that this Participant Band is related to.

is_expanded class-attribute instance-attribute

is_expanded: Optional[bool] = field(
    default=None, metadata={"name": "isExpanded", "type": "Attribute"}
)

An optional attribute that should be used only for SubProcess, AdHocSubProcess, Transaction, SubChoreographies, CallActivities, and CallChoreographies. It determines if it should be depicted expanded (true) or collapsed (false).

is_horizontal class-attribute instance-attribute

is_horizontal: Optional[bool] = field(
    default=None, metadata={"name": "isHorizontal", "type": "Attribute"}
)

An optional attribute that should be used only for Pools and Lanes. It determines if it should be depicted horizontally (true) or vertically (false).

is_marker_visible class-attribute instance-attribute

is_marker_visible: Optional[bool] = field(
    default=None, metadata={"name": "isMarkerVisible", "type": "Attribute"}
)

An optional attribute that should be used only for Exclusive Gateway. It determines if the marker should be depicted on the shape (true) or not (false).

is_message_visible class-attribute instance-attribute

is_message_visible: Optional[bool] = field(
    default=None, metadata={"name": "isMessageVisible", "type": "Attribute"}
)

An optional attribute that should only be used for Participant Bands. It determines if an envelope decorator should be depicted linked to the Participant Band.

label class-attribute instance-attribute

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

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

participant_band_kind class-attribute instance-attribute

participant_band_kind: Optional[ParticipantBandKind] = field(
    default=None, metadata={"name": "participantBandKind", "type": "Attribute"}
)

An optional attribute that should only be used for Participant Bands. If this attribute is present, the participant should be depicted as a Participant Band rather than a Pool.

Functions