C

OrthogonalLayoutEdgeDescriptor

Show Usages
This class provides routing settings for edges routed by the OrthogonalLayout.
Inheritance Hierarchy

Remarks

OrthogonalLayoutEdgeDescriptor is used by OrthogonalLayout to determine the routing details for the edges (e.g. the segment length).

An OrthogonalLayoutEdgeDescriptor can be specified individually for each edge with edgeDescriptors.

Default Values of Properties

NameDefault
minimumFirstSegmentLength15.0
minimumLastSegmentLength15.0
minimumSegmentLength15.0

See Also

Developer's Guide

API

edgeDescriptors

Members

No filters for this type

Constructors

OrthogonalLayoutEdgeDescriptor

()
Creates a new instance of OrthogonalLayoutEdgeDescriptor with the default settings.

Parameters

Properties

minimumFirstSegmentLength

: number
Gets or sets the minimum length of the first segment of the edge path (at the source node).
The minimum length must be greater than or equal to 0.
The final segment length also depends on the used grid size (see gridSpacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.
final

Property Value

the minimum length of the first segment

Throws

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

Default Value

The default value is: 15.0

Sample Graphs

ShownSetting: Minimum first segment length 15

minimumLastSegmentLength

: number
Gets or sets the minimum length of the last segment of the edge path (at the target node).
The minimum length must be greater than or equal to 0.
The final segment length also depends on the used grid size (see gridSpacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.
final

Property Value

the minimum length of the last segment

Throws

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

Default Value

The default value is: 15.0

Sample Graphs

ShownSetting: Minimum last segment length 15

minimumSegmentLength

: number
Gets or sets the minimum segment length of an edge.
The minimum length must be greater than or equal to 0.
The final segment length also depends on the used grid size (see gridSpacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.
final

Property Value

the minimum segment length

Throws

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

Default Value

The default value is: 15.0

Sample Graphs

ShownSetting: Minimum segment length 15

Methods

createCopy

(): OrthogonalLayoutEdgeDescriptor
Creates a copy of this OrthogonalLayoutEdgeDescriptor instance.
final

Return Value

OrthogonalLayoutEdgeDescriptor
a copy of this OrthogonalLayoutEdgeDescriptor instance