Skip to content

Interface: ArcLayoutResult ​

What arcLayout returns: the positions and routes, and the order it chose.

Extends ​

Properties ​

PropertyModifierTypeDescriptionOverridesInherited from
clusters?readonlyreadonly LayoutCluster[]--LayoutResult.clusters
hidden?readonlyUint8Array<ArrayBufferLike>Nodes a layout left out (a collapsed subtree's descendants): 1 where the node is not drawn. Links with a hidden end are not drawn either.-LayoutResult.hidden
orderreadonlyInt32ArrayThe node at each position along the line, first to last.--
rankreadonlyInt32ArrayThe position of each node along the line (the inverse of order).--
reversed?readonlyUint8Array<ArrayBufferLike>Links the layout reversed to break cycles (layered): drawn in the back-edge style.-LayoutResult.reversed
routesreadonlyreadonly (LinkRoute | undefined)[]One entry per link: a 'spline' route for every link between two nodes (7 points, or 4 for a self-link's loop), undefined for a self-link when loopSize is 0.LayoutResult.routes-
spanreadonlynumberΣ weight ·rank(source) − rank(target)of the order: what 'barycenter' reduces.
xreadonlyFloat64ArrayNode centers, one per node. Always finite.-LayoutResult.x
yreadonlyFloat64Array--LayoutResult.y
z?readonlyFloat64Array<ArrayBufferLike>Only from a 3D layout.-LayoutResult.z

Released under the MIT License.