HierarchicalLayoutEdgeContext

This class provides layout information about the edges of the graph during the layout.

Inheritance Hierarchy

HierarchicalLayoutEdgeContext

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

Type Details

yFiles module: algorithms

Properties

associatedEdge

: LayoutEdge?

Gets the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.

Remarks

If no LayoutEdge is associated with this HierarchicalLayoutEdgeContext instance, null should be returned.

Property Value

The associated LayoutEdge or null if no such LayoutEdge exists.

associatedNode

: LayoutNode?

Gets the LayoutNode associated with this HierarchicalLayoutEdgeContext instance.

Remarks

If no LayoutNode is associated with this HierarchicalLayoutEdgeContext instance, null should be returned.

Property Value

The associated LayoutNode or null if no such LayoutNode exists.

criticalEdgePriority

: number

Gets or sets the critical edge priority of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.

Remarks

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.

Property Value

the critical edge priority of the edge

crossingCost

: number

Gets or sets the crossing cost of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.

Remarks

The crossing costs of edges are considered when minimizing the edge crossing count during the sequencing phase.

Property Value

the edge crossing cost of the edge

edgeDescriptor

: HierarchicalLayoutEdgeDescriptor?

Gets the HierarchicalLayoutEdgeDescriptor instance bound to the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.

Remarks

If no HierarchicalLayoutEdgeDescriptor is bound to the edge, null should be returned.

Property Value

A HierarchicalLayoutEdgeDescriptor instance or null if no HierarchicalLayoutEdgeDescriptor is registered

fallbackUpperSameLayerEdge

: boolean

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).

Remarks

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.

Property Value

true if the same-layer edge should be routed above the layer, false otherwise

reversed

: boolean

Gets whether or not the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance has been reversed.

Property Value

true if the associated LayoutEdge has been reversed, false otherwise

selectedSourcePortCandidate

: LayoutPortCandidate?

Gets or sets the selected LayoutPortCandidate for the source port of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.

Remarks

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.

selectedTargetPortCandidate

: LayoutPortCandidate?

Gets or sets the selected LayoutPortCandidate for the target port of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.

Remarks

Property Value

The selected LayoutPortCandidate instance for the target port.

sourceGroup

: 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).

Remarks

Information about edge grouping at the source node is obtained by sourceGroupIds.

Property Value

the ID of the group at the source node

sourcePortAlignment

: 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).

Remarks

Information about edge port alignment at the source node is obtained by sourcePortAlignmentIds.

Property Value

the ID of the port alignment group at the source node

sourcePortCandidates

: EdgePortCandidates?

Gets or sets the EdgePortCandidates for the source port of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.

Remarks

Source port candidates are obtained by sourcePortCandidates.

Property Value

The EdgePortCandidates for the source port

sourcePortGroup

: 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).

Remarks

Information about edge port grouping at the source node is obtained by sourcePortGroupIds.

Property Value

the ID of the port group at the source node

targetGroup

: 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).

Remarks

Information about edge grouping at the target node is obtained by targetGroupIds.

Property Value

the ID of the group at the target node

targetPortAlignment

: 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).

Remarks

Information about edge port alignment at the target node is obtained by targetPortAlignmentIds.

Property Value

the ID of the port alignment group at the target node

targetPortCandidates

: EdgePortCandidates?

Gets the EdgePortCandidates for the target port of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.

Remarks

Target port candidates are obtained by targetPortCandidates.

Property Value

The EdgePortCandidates for the target port

targetPortGroup

: 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).

Remarks

Information about edge port grouping at the target node is obtained by targetPortGroupIds.

Property Value

the ID of the group at the target node

thickness

: number

Gets or sets the thickness of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.

Remarks

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.

Property Value

the thickness for the edge

type

: HierarchicalLayoutEdgeType

Gets the type of the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance.

Property Value

The type of the associated LayoutEdge.

upperSameLayerEdge

: boolean

Gets whether or not the LayoutEdge associated with this HierarchicalLayoutEdgeContext instance is an upper same-layer edge.

Remarks

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.

Property Value

true if the associated LayoutEdge is an upper same-layer edge, false otherwise