EdgeRouterRoutingStyle

Show usages

Routing styles for edges routed by the EdgeRouter.

Type Details

yFiles module: algorithms

Constants

CURVED

: number

A routing style constant specifying that the edge should be curved.

Remarks

Curved edges are constructed using cubic bezier splines. As for all routing styles, overlaps with other elements are avoided. If there is very little space for a smooth curve, it can happen that the resulting path remains orthogonal. Therefore, the curved routing style does not produce optimal results for input graphs that offer little space for the edge routes.

When edgeLabelPlacement is set to INTEGRATED, for edge labels a straight, non-curved segment where the label is placed will be inserted. All the settings of the EdgeLabelPreferredPlacement are supported. Similarly, for the minimumFirstSegmentLength and the minimumLastSegmentLength, a straight edge segment is created to fulfill the constraints.

Sample Graphs

Compared to the other routing styles, the curved routing style may significantly increase the runtime, especially for graphs with a large number of edges.

If the bends should actually be interpreted as bezier points, i.e. to let the visualization create the spline curves, enable createControlPoints

If the curved route should be allowed to start/end with a non-orthogonal segment and at any side of the adjacent node, the connection style ORGANIC can be specified as sourceCurveConnectionStyle and/or targetCurveConnectionStyle.

OCTILINEAR

: number

A routing style constant specifying that the edge should be octilinear.

Remarks

Octilinear edges consist of vertical and horizontal segments as well as segments with slope -1 and 1.

Sample Graphs

Backbone segments of a bus are always routed orthogonally. Bus connections that lead from the backbone to the actual end nodes can be octilinear.

ORTHOGONAL

: number

A routing style constant specifying that the edge should be orthogonal.

Remarks

Orthogonal edges only consist of vertical and horizontal segments.

Sample Graphs

Static Methods

from

(value: EdgeRouterRoutingStyle) : EdgeRouterRoutingStyle

Converts the given argument to an enum constant of this enum type.

Remarks

Most notably, this method can convert an enum constant's name into the enum constant itself.

Parameters

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

value - EdgeRouterRoutingStyle: The value to convert to an enum constant.

Returns

↪EdgeRouterRoutingStyle: The enum constant that corresponds to the given argument.

getName

(value: EdgeRouterRoutingStyle) : string

Returns the name of the given enum constant.

Parameters

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

value - EdgeRouterRoutingStyle: The numeric value of an enum constant.

Returns

↪string: The name of the enum constant.

Throws

Exception({ name: 'Error' }): If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.