This class provides layout information about the edges of the graph during the layout.
Inheritance Hierarchy
Remarks
HierarchicalLayoutEdgeContext is a descriptor for each edge, holding information about the type of an edge, associated LayoutPortCandidates, edge groups as well as the current edge state.
It is used in all phases of the HierarchicalLayout to store edge information.
This class cannot be instantiated
Members
No filters for this type
Properties
Gets the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Gets the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
If no LayoutEdge is associated with this HierarchicalLayoutEdgeContext instance,
null should be returned.readonlyfinal
Property Value
Gets the LayoutNode associated with this HierarchicalLayoutEdgeContext instance.
Gets the LayoutNode associated with this HierarchicalLayoutEdgeContext instance.
If no LayoutNode is associated with this HierarchicalLayoutEdgeContext instance,
null should be returned.readonlyfinal
Property Value
Gets or sets the critical edge priority of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Gets or sets the critical edge priority of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
The layout algorithm tries to vertically align each node pair that is connected by a critical edge. Conflicts between different critical edges are always resolved in favor of the edge with the higher priority.
final
Property Value
the critical edge priority of the edge
Gets or sets the crossing cost of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Gets or sets the crossing cost of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
The crossing costs of edges are considered when minimizing the edge crossing count during the sequencing phase.
final
Property Value
the edge crossing cost of the edge
Gets the HierarchicalLayoutEdgeDescriptor instance bound to the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Gets the HierarchicalLayoutEdgeDescriptor instance bound to the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
If no HierarchicalLayoutEdgeDescriptor is bound to the edge,
null should be returned.readonlyfinal
Property Value
A HierarchicalLayoutEdgeDescriptor instance or
null if no HierarchicalLayoutEdgeDescriptor is registeredGets or sets whether or not the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance should be an upper same-layer edge (if it is a same-layer edge).
Gets or sets whether or not the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance should be an upper same-layer edge (if it is a same-layer edge).
An upper same-layer edge is an edge connecting two nodes of the same layer with polyline segments (not directly, with a straight line) and is routed above the layer.
If enabled, the edge will be routed above the layer, otherwise below it.
final
Property Value
true if the same-layer edge should be routed above the layer, false otherwiseGets whether or not the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance has been reversed.
Gets whether or not the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance has been reversed.
Gets or sets the selected LayoutPortCandidate for the source port of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Gets or sets the selected LayoutPortCandidate for the source port of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
The selected candidate may be a part of the edge port candidates or the nodePortCandidates, but it does not have to be. For example, it may be more restrictive than any of the candidates in these sets.
Property Value
The selected LayoutPortCandidate instance for the source port.
Gets or sets the selected LayoutPortCandidate for the target port of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Gets or sets the selected LayoutPortCandidate for the target port of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
The selected candidate may be a part of the edge port candidates or the nodePortCandidates, but it does not have to be. For example, it may be more restrictive than any of the candidates in these sets.
Property Value
The selected LayoutPortCandidate instance for the target port.
Gets or sets the ID of the edge group at the source node to which the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance belongs (if any).
Gets or sets the ID of the edge group at the source node to which the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance belongs (if any).
Information about edge grouping at the source node is obtained by sourceGroupIds.
final
Property Value
the ID of the group at the source node
Gets or sets the ID of the edge port alignment at the source node to which the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance belongs (if any).
Gets or sets the ID of the edge port alignment at the source node to which the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance belongs (if any).
Information about edge port alignment at the source node is obtained by sourcePortAlignmentIds.
final
Property Value
the ID of the port alignment group at the source node
Gets or sets the EdgePortCandidates for the source port of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Gets or sets the EdgePortCandidates for the source port of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Source port candidates are obtained by sourcePortCandidates.
final
Property Value
The EdgePortCandidates for the source port
Gets or sets the ID of the edge port group at the source node to which the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance belongs (if any).
Gets or sets the ID of the edge port group at the source node to which the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance belongs (if any).
Information about edge port grouping at the source node is obtained by sourcePortGroupIds.
final
Property Value
the ID of the port group at the source node
Gets or sets the ID of the edge group at the target node to which the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance belongs (if any).
Gets or sets the ID of the edge group at the target node to which the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance belongs (if any).
Information about edge grouping at the target node is obtained by targetGroupIds.
final
Property Value
the ID of the group at the target node
Gets or sets the ID of the edge port alignment at the target node to which the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance belongs (if any).
Gets or sets the ID of the edge port alignment at the target node to which the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance belongs (if any).
Information about edge port alignment at the target node is obtained by targetPortAlignmentIds.
final
Property Value
the ID of the port alignment group at the target node
Gets the EdgePortCandidates for the target port of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Gets the EdgePortCandidates for the target port of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Target port candidates are obtained by targetPortCandidates.
final
Property Value
The EdgePortCandidates for the target port
Gets or sets the ID of the edge port group at the target node to which the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance belongs (if any).
Gets or sets the ID of the edge port group at the target node to which the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance belongs (if any).
Information about edge port grouping at the target node is obtained by targetPortGroupIds.
final
Property Value
the ID of the group at the target node
Gets or sets the thickness of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Gets or sets the thickness of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
The thickness is considered when calculating minimum distances so that there are no overlaps between edges and other graph elements.
The thickness must have a non-negative value.
final
Property Value
the thickness for the edge
Gets the type of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Gets the type of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.
Gets whether or not the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance is an upper same-layer edge.
Gets whether or not the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance is an upper same-layer edge.
An upper same-layer edge is an edge connecting two nodes of the same layer with polyline segments (not directly, with a straight line) and is routed above the layer.
readonly