An EdgeBundleDescriptor defines the bundling settings of an edge.
Remarks
The defined settings will be considered by layout algorithms which support edge bundling.
Each EdgeBundleDescriptor can either be specified for a single edge or shared by several edges. It is assigned to an edge by registering an IMapper<K,V> with key EDGE_BUNDLE_DESCRIPTOR_DATA_KEY to the input graph.
For most layout algorithms, there is a corresponding LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that simplifies the process of assigning EdgeBundleDescriptors.
Default Values of Properties
| bezierFitting | false | Edges resemble B-splines. |
| bundled | false | Generally bundling is disabled, only for the radial group layout bundling is enabled by default |
| considerDirection | true | The direction of the edge is considered. |
Type Details
- yFiles module
- algorithms
See Also
Constructors
Creates a new EdgeBundleDescriptor with default settings.
Parameters
A map of options to pass to the method.
- considerDirection - boolean
- Whether or not the direction of the edge associated to this descriptor should be considered. This option sets the considerDirection property on the created object.
- bundled - boolean
- Whether or not an edge associated with this descriptor should be bundled. This option sets the bundled property on the created object.
- bezierFitting - boolean
- Whether or not a bezier curve should be fit to an edge associated with this descriptor. This option sets the bezierFitting property on the created object.
Creates a new EdgeBundleDescriptor representing a copy of the given other descriptor instance.
Parameters
A map of options to pass to the method.
- descriptor - EdgeBundleDescriptor
- The descriptor to copy
- considerDirection - boolean
- Whether or not the direction of the edge associated to this descriptor should be considered. This option sets the considerDirection property on the created object.
- bundled - boolean
- Whether or not an edge associated with this descriptor should be bundled. This option sets the bundled property on the created object.
- bezierFitting - boolean
- Whether or not a bezier curve should be fit to an edge associated with this descriptor. This option sets the bezierFitting property on the created object.
Properties
Gets or sets whether or not a bezier curve should be fit to an edge associated with this descriptor.
Remarks
If disabled, the edges resemble B-splines where points of the path are actually curve points. Therefore, this representation requires a high number of bends to model curves.
If this feature is enabled, a bezier curve is fitted to the start and end point as well as the intermediate control points of the edge. After the fitting, the points of the edge can be interpreted as cubic bezier control points. Each four consecutive points form a bezier curve, where the first and last of the four points represent the start and end of the curve and the second and third points are the control points defining how the curve looks. The second and third points do not necessarily lie on the actual curve.
Default Value
false.Edges resemble B-splines.
Property Value
true if a bezier curve is fitted to an edge associated with this descriptor, false otherwiseSee Also
Gets or sets whether or not an edge associated with this descriptor should be bundled.
Default Value
false.Generally bundling is disabled, only for the radial group layout bundling is enabled by default
Property Value
true if an edge associated with this descriptor is bundled, false otherwiseSee Also
Gets or sets whether or not the direction of the edge associated to this descriptor should be considered.
Remarks
During the bundling procedure, the edges are bundled based on their direction such that the incoming edges of a node are bundled separately from its outgoing edges. If the direction of edges adjacent to a node is not considered, then they are not bundled separately.
If the direction of some edges is taken into consideration while the direction of some others (adjacent to the same node) is ignored, the undirected edges are also bundled separately. This is done to distinguish them from the incoming and outgoing edges of the particular node.
Default Value
true.The direction of the edge is considered.
Property Value
true if the direction of the edge is considered, false otherwise