Skip to content

Interface: ForceBundleOptions ​

Options of forceBundle.

Extended by ​

Properties ​

PropertyModifierTypeDescription
candidates?readonlynumberLinks examined per link at most when looking for compatible ones. Default 1,000.
compatibility?readonlynumberCompatibility two links need to attract each other, 0 to 1 (see the module comment). Lower values bundle more links, also ones that do not belong together; at 0 the search has no distance limit and only candidates bounds it. Default 0.6.
cycles?readonlynumberRefinement cycles, 1 to 7: a link has 2^(cycles − 1) subdivision points at the end. Default 6 (32 points).
iterations?readonlynumberIterations of the first cycle, 1,000 at most; each later cycle runs two thirds of the one before. Default 50.
maxLinks?readonlynumberSize cap: with more links that can be bundled than this, nothing is bundled and the result says refused. Default 20,000.
maxNeighbours?readonlynumberCompatible links kept per link at most, the most compatible first. Default 32.
smoothing?readonlynumber[1 2 1] / 4 smoothing passes over the final points, 0 to 8. Default 1.
stiffness?readonlynumberStiffness of the links, 0 to 0.5: the paper's spring constant K. Higher values keep links straighter and bundles looser. Default 0.1.
strength?readonlynumber0 = straight links … 1 = fully bundled: the weight of the attraction against the springs. Default 0.85.
tolerance?readonlynumberPoints of a route closer than this to the line through the points kept are dropped (Ramer–Douglas–Peucker), in layout units. 0 keeps every subdivision point. Default 0.25.

Released under the MIT License.