E

EdgeRouterScope

Show Usages
Enum constants that specify how an edge is affected by the EdgeRouter.

Members

No filters for this type

Constants

IGNORE

static
A scope specifier that defines that the edge should not be routed by the EdgeRouter.
static

See Also

Developer's Guide

PATH

static
A scope specifier that defines that a new route is calculated in any case.
The existing path of an edge is ignored and the routing algorithm unconditionally generates a whole new path.
static

Sample Graphs

ShownSetting: Initial graph

See Also

Developer's Guide

PATH_AS_NEEDED

static
A scope specifier that defines that based on the current path it is automatically determined whether an edge is routed, and if so, the edge gets a whole new path.

The automatic selection examines the existing, given path of an edge. Based on various criteria it heuristically determines whether or not it needs to be routed. For example, intersections with other elements or a routing style violation are clear indicators. A further criterion is when the port constraints/candidates are not properly satisfied. Edges deemed to be 'good' are not changed.

This policy is convenient for cases where it is not clear which edges the algorithm should route. For example, after a user interaction (moving a node, inserting new elements etc.), routing of edges might become necessary but depending on the action it can not definitely be said which edges need to be corrected.

static

Sample Graphs

ShownSetting: Initial graph

See Also

Developer's Guide

SEGMENTS_AS_NEEDED

static
A scope specifier that defines that based on the current path it is automatically determined whether the edge is routed, and if so, only the necessary segments are changed.

This policy follows the same approach as PATH_AS_NEEDED for determining whether or not an edge is even routed. However, during routing, the changes are kept local. This means that only certain segments are changed, keeping the rest of the route, wherever appropriate. Edges deemed to be 'good' are not changed at all.

This policy is convenient for cases where it is not clear which edges the algorithm should route. For example, after a user interaction (moving a node, inserting new elements etc.), routing of edges might become necessary but depending on the action it can not definitely be said which edges need to be corrected.

Use this policy if the edge should only be changed as little as possible. Parts of the given route are kept fixed, even though when, for example, more specific settings like a minimum segment length is not satisfied. One advantage of this policy is also performance, as fewer routing is necessary. On the other hand, when trying to optimize the global routing quality of all edges, this policy is not recommended.
When having CURVED edges, this policy is equal to PATH_AS_NEEDED, meaning that if necessary the whole curved edge will be routed.
static

Sample Graphs

ShownSetting: Initial graph

See Also

Developer's Guide

Static Methods

from

(value: EdgeRouterScope): EdgeRouterScope
static
Converts the given argument to an enum constant of this enum type.
Most notably, this method can convert an enum constant's name into the enum constant itself.
static

Parameters

value: EdgeRouterScope
The value to convert to an enum constant.

Return Value

EdgeRouterScope
The enum constant that corresponds to the given argument.

getName

(value: EdgeRouterScope): string
static
Returns the name of the given enum constant.
static

Parameters

value: EdgeRouterScope
The numeric value of an enum constant.

Return Value

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.