IEdgeData

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

Inheritance Hierarchy

IEdgeData

Remarks

IEdgeData is a multi-purpose edge descriptor for each edge, holding information about the type of an edge, associated port constraints, port candidates, edge groups as well as the current edge state.

It is used in all phases of the HierarchicLayoutCore to store edge information.

Type Details

yfiles module: layout-hierarchic
yfiles-umd modules: layout-familytree, layout-hierarchic, layout-radial, layout
Legacy UMD name: yfiles.hierarchic.IEdgeData

Properties

associatedEdge

: Edge

Gets the Edge associated with this IEdgeData instance.

Remarks

If no Edge is associated with this IEdgeData instance, null should be returned.

associatedNode

: YNode

Gets the YNode associated with this IEdgeData instance.

Remarks

If no YNode is associated with this IEdgeData instance, null should be returned.

criticalEdgePriority

: number

Gets the critical edge priority of the Edge associated with this IEdgeData 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.

crossingCost

: number

Gets the crossing cost of the Edge associated with this IEdgeData instance.

Remarks

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

edgeLayoutDescriptor

: HierarchicLayoutEdgeLayoutDescriptor

Gets the HierarchicLayoutEdgeLayoutDescriptor instance bound to the Edge associated with this IEdgeData instance.

Remarks

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

fallbackUpperSameLayerEdge

: boolean

Gets or sets whether or not the Edge associated with this IEdgeData 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.

group

: any

Gets the group that is represented by the Edge associated with this IEdgeData instance.

reversed

: boolean

Gets whether or not the Edge associated with this IEdgeData instance has been reversed.

sourceGroup

: any

Gets the ID of the edge group at the source node to which the Edge associated with this IEdgeData instance belongs (if any).

Remarks

Information about edge grouping at the source node is obtained by a IDataProvider registered with the graph with key SOURCE_GROUP_ID_DP_KEY.

sourcePortCandidates

: ICollection<any>

Gets the collection of PortCandidates for the source port of the Edge associated with this IEdgeData instance.

Remarks

Source port candidates are obtained by a IDataProvider registered with the graph with key SOURCE_PORT_CANDIDATE_COLLECTION_DP_KEY.

sourcePortConstraint

: PortConstraint

Gets the port constraints for the source port of the Edge associated with this IEdgeData instance.

Remarks

PortConstraints are obtained by a IDataProvider registered with the graph with key SOURCE_PORT_CONSTRAINT_DP_KEY.

sourcePortGroup

: any

Gets the ID of the edge port group at the source node to which the Edge associated with this IEdgeData instance belongs (if any).

Remarks

Information about edge port grouping at the source node is obtained by a IDataProvider registered with the graph with key SOURCE_PORT_GROUP_ID_DP_KEY.

targetGroup

: any

Gets the ID of the edge group at the target node to which the Edge associated with this IEdgeData instance belongs (if any).

Remarks

Information about edge grouping at the target node is obtained by a IDataProvider registered with the graph with key TARGET_GROUP_ID_DP_KEY.

targetPortCandidates

: ICollection<any>

Gets the collection of PortCandidates for the target port of the Edge associated with this IEdgeData instance.

Remarks

Target port candidates are obtained by a IDataProvider registered with the graph with key TARGET_PORT_CANDIDATE_COLLECTION_DP_KEY.

targetPortConstraint

: PortConstraint

Gets the port constraints for the target port of the Edge associated with this IEdgeData instance.

Remarks

PortConstraints are obtained by a IDataProvider registered with the graph with key TARGET_PORT_CONSTRAINT_DP_KEY.

targetPortGroup

: any

Gets the ID of the edge port group at the target node to which the Edge associated with this IEdgeData instance belongs (if any).

Remarks

Information about edge port grouping at the target node is obtained by a IDataProvider registered with the graph with key TARGET_PORT_GROUP_ID_DP_KEY.

thickness

: number

Gets the thickness of the Edge associated with this IEdgeData 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.

type

: EdgeDataType

Gets the type of the Edge associated with this IEdgeData instance.

upperSameLayerEdge

: boolean

Gets whether or not the Edge associated with this IEdgeData 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.