Interface: GraphCalc

Experimental

Properties

Property	Modifier	Type	Description
area?	readonly	PlotArea	Experimental The plot area the graph was laid out for, in px (an estimate: see plotAreaOf).
arrangement	readonly	| "radial" | "preset" | "force" | "layered" | "tree" | "dendrogram" | "circular" | "grid" | "arc" | "hive" | "custom"	Experimental The arrangement that placed the nodes ('circular' when the one asked for is missing).
bundle?	readonly	GraphBundle	Experimental The bundling of the links (link.bundle), when some are bundled.
clusters	readonly	readonly LayoutCluster[] | undefined	Experimental
equal?	readonly	boolean	Experimental The two axes are locked to one scale (units, but for a tidy tree and a dendrogram, which fill the plot area along each axis). Curves and loops are then known in linear coordinates. Unset: as for any computed arrangement.
force?	readonly	GraphForce	Experimental Set when a force layout placed the nodes.
guides?	readonly	GraphGuides	Experimental
hidden	readonly	Uint8Array	Experimental 1 where the node is not drawn (see the module comment).
hiddenGroups	readonly	ReadonlySet<number>	Experimental Group indices hidden through the legend.
labelRule?	readonly	LabelRule	Experimental Where the labels of the arrangement have room (node.textposition: 'auto').
layoutKey?	readonly	string	Experimental A fingerprint of everything the layout read (the graph, its sizes, the given positions and the options): two calcs with the same key have the same positions, whatever else changed.
length	readonly	number	Experimental Node count (model.nodes).
model	readonly	GraphModel	Experimental
omitted?	readonly	Uint8Array<ArrayBufferLike>	Experimental 1 for the links that are not drawn at all (both ends on one axis of a hive plot).
pending?	readonly	GraphPending	Experimental What this calc waits for (pending.ts): its layout, which runs off the main thread (the nodes are at a cheap placement until it arrives), or the routes of its bundled links (which are straight until then). The view asks for it, and calc runs again when it is there.
preset	readonly	boolean	Experimental Positions are the figure's data on the axes (arrangement: 'preset').
real?	readonly	RealAxis	Experimental The axis that is a real scale under a computed arrangement, if one is.
reversed	readonly	Uint8Array<ArrayBufferLike> | undefined	Experimental
routes	readonly	readonly (LinkRoute | undefined)[] | undefined	Experimental From the layout, by link (see LayoutResult): routed links, reversed links, group frames.
secondary?	readonly	Uint8Array<ArrayBufferLike>	Experimental 1 for the links drawn in the link.secondary style: the links a layered layout turned around to break cycles (reversed), or under a tree arrangement the links that are not tree edges.
tree?	readonly	GraphTree	Experimental The tree of a tree arrangement.
units?	readonly	boolean	Experimental Positions are layout units on both axes (a computed arrangement without a real axis): a unit is a px at the size the graph was laid out for. Unset: as for any computed arrangement.
x	readonly	Float64Array	Experimental Node centers in linear coordinates; finite for every node that is drawn.
y	readonly	Float64Array	Experimental