@graphty/layout / index / planar
Function: planar()
planar(
s,options?):LayoutResult
Defined in: indexed/planar.ts:282
Nodes placed without edge crossings for the graphs the check accepts (see planarRows): a cycle of the graph on a circle, the other nodes inside it near their neighbours. In 3D the layout lies in the plane of the centre's z.
Parameters
s
GraphSnapshot
the snapshot; a directed one is read as its undirected derived graph
options?
CommonLayoutOptions = {}
scale is the distance of the farthest node from the centre; seed fixes the jitter
Returns
the layout
Throws
"G is not planar." when the check rejects the graph