documentationfor yFiles for HTML 2.6

EdgeBundleDescriptor

An EdgeBundleDescriptor defines the bundling settings of an edge.

Inheritance Hierarchy
EdgeBundleDescriptor

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 a IDataProvider with key EDGE_BUNDLE_DESCRIPTOR_DP_KEY to the input graph.

Default Values of Properties

bezierFittingfalseEdges resemble B-splines.
bundledfalseGenerally bundling is disabled, only for the cactus group layout bundling is enabled by default
considerDirectiontrueThe direction of the edge is considered.

Type Details

yfiles module
layout-core
yfiles-umd modules
All layout modules, view-layout-bridge
Legacy UMD name
yfiles.layout.EdgeBundleDescriptor

See Also

This descriptor does not represent an ID to define different bundles; two edges associated with different descriptor instances might still be bundled. The descriptor's purpose is to control the basic bundling property of an edge, e.g., whether it should be bundled at all and if the edge is directed or undirected.

Constructors

Properties