Skip to main content

Function: useLayoutForceAtlas2()

useLayoutForceAtlas2(settings?): object

React hook that helps you to manage force atlas2 layout.

const { positions, assign } = useLayoutForceAtlas2(...);

Parameters

settings?: ForceAtlas2SynchronousLayoutParameters<Attributes, Attributes>

Returns

object

assign()

assign: () => void

Returns

void

positions()

positions: () => object

Returns

object

Defined in

packages/layout-forceatlas2/src/useLayoutForceAtlas2.ts:13