Members
Constructors
Properties
Gets or sets the collection of edges affected by this router.
Gets or sets the collection of leading edges.
A leading edge is the edge whose layout is used to obtain the layout of the corresponding multi-edges.
If no leading edge is specified for a bundle of multi-edges, it will be determined automatically. If there is more than one leading edge, the first one is chosen.
See Also
Gets the edge collection that, after the layout run, will contain all multi-edges that were routed and not treated as leading edges.
The set of routed multi-edges corresponds to the edges that were hidden during the coreLayout of the ParallelEdgeRouter.
Knowing which multi-edges were identified and hidden during the core layout can be valuable information for use cases where it is required to handle such edges specifically. A frequent scenario is, for example, the requirement to place edge labels of these edges. The core layout is not able to do so because multi-edges are hidden. A generic labeling algorithm where only the labels of the multi-edges are affected and placed can now easily be applied (see GenericLabeling).
If the router runs as part of the LayoutStageStack in an ILayoutAlgorithm, stages like the labeling stage, which run after the router, can already use the information. This way, for example, the labeling stage can handle labels of non-leading, multi-edges in a specific way.
See Also
Methods
combineWith
(data: LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>): LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>Combines this instance with the given layout data.
combineWith
(data: LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>): LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>Parameters
- data: LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>
- The LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel> to combine this instance with.
Return Value
- LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>
- The combined layout data.
See Also
Developer's Guide
API
- CompositeLayoutData, GenericLayoutData