EdgeRouterDataProvider<TNodeData, TEdgeData>

A provider for individual options per nodes or edges in a EdgeRouter. It allows for defining a function that provide values for each element.

For more information, see EdgeRouterData.

Props

NameDescriptionType
affectedEdges?
Provides which edges should be routed.
(
  edge: TEdgeData
) => boolean
affectedNodes?
Provides if the edges of the given nodes should be routed.
(
  node: TNodeData
) => boolean
edgeLabelPreferredPlacement?
Provides descriptors for the placement of edge labels.
(
  label: LabelData
) => PreferredPlacementDescriptor
nodeHalos?
Provides halos for nodes, i.e., a rectangular area around a specific node considered during the layout.
(
  node: TNodeData
) => NodeHalo
sourceGroupIds?
Provides which edges should be grouped at source, i.e., share the beginning of their routes.
(edge: TEdgeData) => any
sourcePortCandidates?
Provides the directions in which an edge can leave its source node.
(
  edge: TEdgeData
) => PortDirections[]
targetGroupIds?
Provides which edges should be grouped at target, i.e., share the end of their routes.
(edge: TEdgeData) => any
targetPortCandidates?
Provides the directions in which an edge can enter its target node.
(
  edge: TEdgeData
) => PortDirections[]