Edge
Interface representing an edge (connection) between nodes in the flow diagram
Type Parameters
Section titled “Type Parameters”T extends DataObject = DataObject
Properties
Section titled “Properties”computedZIndex?
Section titled “computedZIndex?”
readonlyoptionalcomputedZIndex:number
Remarks
Section titled “Remarks”ComputedZIndex is computed by the system and should not be set manually. The z-index of the node. This value is set automatically
data:
T
The data associated with the edge.
id:
string
The unique identifier for the edge.
measuredLabels?
Section titled “measuredLabels?”
readonlyoptionalmeasuredLabels:EdgeLabel[]
Remarks
Section titled “Remarks”MeasuredLabels are computed by the system and should not be set manually. The labels of the edge with computed position and size.
points?
Section titled “points?”
optionalpoints:Point[]
The points of the edge defining the path.
routing?
Section titled “routing?”
optionalrouting:EdgeRoutingName
The routing of the edge.
routingMode?
Section titled “routingMode?”
optionalroutingMode:RoutingMode
The routing mode of the edge. ‘auto’ (default): Points are computed automatically based on routing algorithm ‘manual’: Points are provided by the user and routing algorithm is used to render the path
selected?
Section titled “selected?”
optionalselected:boolean
Whether the edge is selected
source
Section titled “source”source:
string
The source node of the edge. If empty string it will use sourcePosition.
sourceArrowhead?
Section titled “sourceArrowhead?”
optionalsourceArrowhead:string
The id of the source arrowhead of the edge.
sourcePort?
Section titled “sourcePort?”
optionalsourcePort:string
The port of the source node.
sourcePosition?
Section titled “sourcePosition?”
optionalsourcePosition:Point
The position of the edge start.
target
Section titled “target”target:
string
The target node of the edge. If empty string it will use targetPosition.
targetArrowhead?
Section titled “targetArrowhead?”
optionaltargetArrowhead:string
The id of the target arrowhead of the edge.
targetPort?
Section titled “targetPort?”
optionaltargetPort:string
The port of the target node.
targetPosition?
Section titled “targetPosition?”
optionaltargetPosition:Point
The position of the edge end.
temporary?
Section titled “temporary?”
optionaltemporary:boolean
Whether the edge is temporary.
optionaltype:string
The type of the edge declared in edgeTemplateMap.
zOrder?
Section titled “zOrder?”
optionalzOrder:number
The z-order of the edge.