HierarchicalLayoutEdgeDescriptor

Show usages

This class is used by HierarchicalLayout during the various phases to provide routing details for the edges of the graph.

Inheritance Hierarchy

HierarchicalLayoutEdgeDescriptor

Remarks

A HierarchicalLayoutEdgeDescriptor instance can be specified individually for single edges via property edgeDescriptors.

This class is designed as a class to allow future additions of new getter methods.

Default Values of Properties

minimumDistance	`10.0d`
minimumFirstSegmentLength	`10.0d`
minimumLastSegmentLength	`15.0d`
minimumLength	`20.0d`
minimumOctilinearSegmentLength	`20.0d`
minimumSlope	`0.2`
recursiveEdgePolicy	OFF	Edges are not routed recursively.

Type Details

yFiles module: algorithms

Constructors

HierarchicalLayoutEdgeDescriptor

()

Creates a new instance of a HierarchicalLayoutEdgeDescriptor with the default values.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

minimumFirstSegmentLength - number: The minimum length of the first segment of the edge path (at the source node). This option sets the minimumFirstSegmentLength property on the created object.
minimumLastSegmentLength - number: The minimum length of the last segment of the edge path (at the target node). This option sets the minimumLastSegmentLength property on the created object.
minimumLength - number: The minimum length of an edge. This option sets the minimumLength property on the created object.
minimumDistance - number: The preferred minimum distance to obstacles. This option sets the minimumDistance property on the created object.
minimumSlope - number: The minimum slope that the mid segments of this edge should have, if the edge is routed polyline in vertical layouts. This option sets the minimumSlope property on the created object.
routingStyleDescriptor - RoutingStyleDescriptor: The routing style descriptor for this edge. This option either sets the value directly or recursively sets properties to the instance of the routingStyleDescriptor property on the created object.
minimumOctilinearSegmentLength - number: The minimum length of octilinear segments for this edge. This option sets the minimumOctilinearSegmentLength property on the created object.
recursiveEdgePolicy - RecursiveEdgePolicy: How edges in grouped graphs are routed between the content of different groups. This option sets the recursiveEdgePolicy property on the created object.
directGroupContentEdgeRouting - boolean: Whether or not this edge is routed directly to a group node's border if it connects the group node with one of its descendants. This option sets the directGroupContentEdgeRouting property on the created object.
backLoopRouting - boolean: Whether or not reversed edges or self-loops should be routed as back-loops. This option sets the backLoopRouting property on the created object.

Properties

backLoopRouting

: boolean

Gets or sets whether or not reversed edges or self-loops should be routed as back-loops.

Remarks

When this option is enabled, back-loops attach to the same node sides as the other edges, i.e., for layout orientation top-to-bottom, they leave their source at the bottom and enter their target at the top.

This property only affects reversed edges and self-loops. It has no effect on other edges.

Default Value

The default value is false.

There is no back-loop routing applied to reversed edges.

Property Value

true if back-loop routing is applied, false otherwise

Sample Graphs

NodePortCandidates and EdgePortCandidates are still considered.

The back-loop routing considers the specified edgeDirectedness. This means that undirected edges (edges with a directedness value of 0) are never routed as back-loops because they have no dedicated source/target node. Furthermore, for edges with a negative directedness value the source and target are interchanged.

This setting is ignored for edges with recursiveEdgePolicy DIRECTED and UNDIRECTED, including edges where source or target are not inside a group node.

directGroupContentEdgeRouting

: boolean

Gets or sets whether or not this edge is routed directly to a group node's border if it connects the group node with one of its descendants.

Remarks

When enabled, the edge will connect to the inner side of the group node's border instead of leaving the group node and connect from outside.

Default Value

The default value is false.

Property Value

true if the edge is routed directly, false otherwise

Sample Graphs

Edges that are completely overlapped by their source or target may require special attention during visualization. They can disappear when edges are clipped at their source and target.

This only applies to edges that connect to a group node from inside this group node.

If enabled, LayoutPortCandidates assigned to the end of an edge that connects to a group are restricted to the two sides lying in the direction of the main flow. More precisely, for layout orientation TOP_TO_BOTTOM only side TOP and BOTTOM are allowed. In addition, an edge can only be routed directly if its two endpoints are not associated with port candidate sets.

minimumDistance

: number

Gets or sets the preferred minimum distance to obstacles.

Remarks

The minimum distance should be greater than 0.

Default Value

The default value is 10.0d.

Property Value

the minimum distance to obstacles

Throws

Exception({ name: 'ArgumentError' }): if the minimum length is negative

Sample Graphs

minimumFirstSegmentLength

: number

Gets or sets the minimum length of the first segment of the edge path (at the source node).

Remarks

The minimum length should be greater than 0.

If the value is 0.0d, the first segment does not need to be orthogonal.

Default Value

The default value is 10.0d.

Property Value

the minimum length of the first segment

Throws

Exception({ name: 'ArgumentError' }): if the minimum length of the first segment is negative

Sample Graphs

The minimum first segment length may be violated for curved edge routes when using curve connection style ORGANIC.

The minimum first segment length is not considered for grouped edges if the routing style is POLYLINE. Consider switching to the octilinear or orthogonal style for such cases.

minimumLastSegmentLength

: number

Gets or sets the minimum length of the last segment of the edge path (at the target node).

Remarks

The minimum length should be greater than 0.

If the value is 0.0d, the last segment does not need to be orthogonal.

Default Value

The default value is 15.0d.

Property Value

the minimum length of the last segment

Throws

Exception({ name: 'ArgumentError' }): if the minimum length of the last segment is negative

Sample Graphs

The minimum last segment length may be violated for curved edge routes when using curve connection style ORGANIC.

The minimum last segment length is not considered for grouped edges if the routing style is POLYLINE. Consider switching to the octilinear or orthogonal style for such cases.

minimumLength

: number

Gets or sets the minimum length of an edge.

Remarks

If this is used for polyline routing, it describes the minimum vertical length of the mid segment. If it is used for orthogonal routing, it describes the minimum length of the whole edge (i.e., the sum of the length of all segments).

The minimum length should be greater than 0.

Default Value

The default value is 20.0d.

Property Value

the minimum segment length.

Throws

Exception({ name: 'ArgumentError' }): if the minimum length is negative

Sample Graphs

The minimum length may be violated for curved edge routes.

minimumOctilinearSegmentLength

: number

Gets or sets the minimum length of octilinear segments for this edge.

Default Value

The default value is 20.0d.

Property Value

the minimum length of octilinear segment

Throws

Exception({ name: 'ArgumentError' }): if the minimum length of the first segment is negative

Sample Graphs

The layout algorithm cannot always maintain the specified minimum length.

This option has an effect only if the routing style is OCTILINEAR.

minimumSlope

: number

Gets or sets the minimum slope that the mid segments of this edge should have, if the edge is routed polyline in vertical layouts.

Remarks

In addition, this value influences the steepness for CURVED edges.

The minimum slope should be greater than 0. For the curved routing style, larger values lead to steeper curves. Steeper curves generally require more height but less width (vertical layout direction).

Default Value

The default value is 0.2.

Property Value

the minimum slope

Throws

Exception({ name: 'ArgumentError' }): if the given minimum slope is negative

Sample Graphs

In many scenarios with curved routing style it is beneficial to keep the steepness value rather low (e.g. 0.1 to 0.2) - it emphasizes the curves as they appear to be rounder.

recursiveEdgePolicy

: RecursiveEdgePolicy

Gets or sets how edges in grouped graphs are routed between the content of different groups.

Default Value

The default value is OFF.

Edges are not routed recursively.

Property Value

one of the predefined recursive routing styles

Sample Graphs

If also direct routing between groups and their content is enabled, such an edge may not be strictly recursive anymore. Edges may leave/enter group nodes left or right.

An edge that belongs to a grid component cannot be recursive at the same time.

Edge grouping is not supported for the recursive styles DIRECTED and UNDIRECTED. Any edge grouping information will be ignored, including automatic groupings.

routingStyleDescriptor

: RoutingStyleDescriptor

Gets or sets the routing style descriptor for this edge.

Default Value

The default value is RoutingStyleDescriptor.

An instance where all types of edges are routed orthogonal.

Property Value

a RoutingStyleDescriptor instance

Throws

Exception({ name: 'ArgumentError' }): if the given routing style is null

Sample Graphs

Methods

createCopy

() : HierarchicalLayoutEdgeDescriptor

Creates a copy of this HierarchicalLayoutEdgeDescriptor instance.

Returns

↪HierarchicalLayoutEdgeDescriptor: a copy of this HierarchicalLayoutEdgeDescriptor instance

HierarchicalLayoutEdgeDescriptor

Remarks

Default Values of Properties

Type Details

See Also

Constructors

HierarchicalLayoutEdgeDescriptor

ParametersOptions Overload

Properties

backLoopRouting

Remarks

Default Value

Property Value

Sample Graphs

directGroupContentEdgeRouting

Remarks

Default Value

Property Value

Sample Graphs

minimumDistance

Remarks

Default Value

Property Value

Throws

Sample Graphs

minimumFirstSegmentLength

Remarks

Default Value

Property Value

Throws

Sample Graphs

minimumLastSegmentLength

Remarks

Default Value

Property Value

Throws

Sample Graphs

minimumLength

Remarks

Default Value

Property Value

Throws

Sample Graphs

minimumOctilinearSegmentLength

Default Value

Property Value

Throws

See Also

Sample Graphs

minimumSlope

Remarks

Default Value

Property Value

Throws

Sample Graphs

recursiveEdgePolicy

Default Value

Property Value

Sample Graphs

routingStyleDescriptor

Default Value

Property Value

Throws

Sample Graphs

Methods

createCopy

Returns