Skip to content

BPMN Panel API / Panel Types / Edge

Type Alias: Edge

ts
type Edge = {
  request?: {
     linkName?: string;
  };
  data?: Record<string, any>;
  bpmnType: "bpmn:SequenceFlow";
};

Defined in: features/panels/variants/bpmn/types/panel/graph/edge/index.ts:42

Declared configuration shape for graph.edges[].

The current existing-edge renderer does not consume graph.edges[]. Existing connectors are built directly from backend links, and their sequence/conditional type is inferred from backend connectorType and linkName. These fields therefore have no supported runtime effect.

Use ToolbarEdgeItem for connector creation configuration.

Properties

PropertyTypeDescription

request?

{ linkName?: string; }

Declared request configuration ignored by the current existing-edge renderer.

request.linkName?

string

Declared link name ignored by the current existing-edge renderer.

data?

Record<string, any>

Declared metadata ignored by the current existing-edge renderer.

bpmnType

"bpmn:SequenceFlow"

Declared BPMN type of the edge.

The current existing-edge renderer does not consume graph.edges[]; it derives sequenceFlow or conditional from backend connector data.