This class provides routing settings for edges routed internally by the CircularLayout.
Inheritance Hierarchy
CircularLayoutEdgeDescriptor
Remarks
The offered settings affect only edges routed within or between circle partitions. The edgeRoutingPolicy determines the edges that are interior.
Default Values of Properties
Type Details
- yFiles module
- algorithms
See Also
CircularLayout.edgeRoutingPolicy,
CircularLayoutEdgeRoutingPolicy.AUTOMATIC,
CircularLayoutEdgeRoutingPolicy.INTERIOR,
CircularLayout.edgeDescriptor
Constructors
Creates a new CircularLayoutEdgeDescriptor instance with default settings.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- inCircleRoutingStyle - CircularLayoutRoutingStyle
- The routing style for edges within partitions. This option sets the inCircleRoutingStyle property on the created object.
- onCircleRoutingStyle - CircularLayoutOnCircleRoutingStyle
- The routing style for edges between neighbors in one partition. This option sets the onCircleRoutingStyle property on the created object.
- betweenCirclesRoutingStyle - CircularLayoutRoutingStyle
- The routing style for edges between partitions. This option sets the betweenCirclesRoutingStyle property on the created object.
- createControlPoints - boolean
- Whether or not the points of the resulting edge path represent cubic bezier control points. This option sets the createControlPoints property on the created object.
Properties
Gets or sets the routing style for edges between partitions.
Default Value
Property Value
one of the predefined routing styles
If the edges between circles are routed with CURVED style, the algorithm uses larger distances between the partitions to have enough space for smooth curves.
Gets or sets whether or not the points of the resulting edge path represent cubic bezier control points.
Remarks
- Disabled (default): Each point of the path represents a normal polyline bend point.
- Enabled: Four consecutive points p1, p2, p3, p4 of the resulting edge path need to be interpreted such that p1 is the start point of the cubic bezier curve, p4 is the end point of it and p2, p3 are the two intermediate control points. If p4 is not the last point of the edge path it is at the same time the start point of the next curve. For example, points p1, p2, p3, p4, p5, p6, p7 form a path that consists of two curves: the curve defined by p1, p2, p3, p4 and the curve defined by p4, p5, p6, p7.
Default Value
The default value is
false.Each point is a normal polyline bend point.
Property Value
true if the bends are interpreted as cubic bezier control points, false otherwiseThis feature is useful when the visualization of the edge draws bezier curves instead of polyline paths.
Gets or sets the routing style for edges within partitions.
Default Value
Property Value
one of the predefined routing styles
Gets or sets the routing style for edges between neighbors in one partition.
Default Value
Property Value
one of the predefined routing styles