bpmn-visualization API Documentation
    Preparing search index...

    Interface ShapeBpmnSemantic

    Extended properties available when BaseBpmnSemantic.isShape is true.

    interface ShapeBpmnSemantic {
        callActivityGlobalTaskKind?: GlobalTaskKind;
        callActivityKind?: ShapeBpmnCallActivityKind;
        eventDefinitionKind?: ShapeBpmnEventDefinitionKind;
        id: string;
        incomingIds: string[];
        isShape: boolean;
        kind: BpmnElementKind;
        linkEventSourceIds?: string[];
        linkEventTargetId?: string;
        name: string;
        outgoingIds: string[];
        parentId: string;
        subProcessKind?: ShapeBpmnSubProcessKind;
    }

    Hierarchy (View Summary)

    Index

    Properties

    callActivityGlobalTaskKind? callActivityKind? eventDefinitionKind? id incomingIds isShape kind linkEventSourceIds? linkEventTargetId? name outgoingIds parentId subProcessKind?

    Properties

    callActivityGlobalTaskKind?: GlobalTaskKind

    Set when the BaseBpmnSemantic.kind relates to a BPMN Call Activity calling a global task.

    callActivityKind?: ShapeBpmnCallActivityKind

    Set when the BaseBpmnSemantic.kind relates to a BPMN Call Activity.

    eventDefinitionKind?: ShapeBpmnEventDefinitionKind

    Set when the BaseBpmnSemantic.kind relates to a BPMN event.

    id: string
    incomingIds: string[]

    IDs of the incoming flows/edges.

    isShape: boolean

    true when relates to a BPMN Shape, false when relates to a BPMN Edge.

    kind: BpmnElementKind
    linkEventSourceIds?: string[]

    Set when the BaseBpmnSemantic.kind relates to a BPMN intermediate catch event with ShapeBpmnSemantic.eventDefinitionKind set to ShapeBpmnEventDefinitionKind.LINK.

    linkEventTargetId?: string

    Set when the BaseBpmnSemantic.kind relates to a BPMN intermediate throw event with ShapeBpmnSemantic.eventDefinitionKind set to ShapeBpmnEventDefinitionKind.LINK.

    name: string
    outgoingIds: string[]

    IDs of the outgoing flows/edges.

    parentId: string

    This is the ID of the direct parent of the current element, which can be a:

    • process/participant
    • lane
    • sub-process
    • call activity

    For the Boundary events, it is the activity to which the item belongs.

    Special case: it can be undefined when there is a single process without Participant/Pool. In this case, the direct children of the process have no parent.

    subProcessKind?: ShapeBpmnSubProcessKind

    Set when the BaseBpmnSemantic.kind relates to a BPMN sub-process.

    Settings

    Member Visibility

    On This Page

    Properties