Skip to main content

Function: useWorkerLayoutForceAtlas2()

useWorkerLayoutForceAtlas2(settings): object

React hook that helps you to manage worker of force atlas2 layout.

const { stop, start } = useWorkerLayoutForceAtlas2(...);

Parameters

settings: ForceAtlas2LayoutParameters

Returns

object

isRunning

isRunning: boolean

kill()

kill: () => void

Returns

void

start()

start: () => void

Returns

void

stop()

stop: () => void

Returns

void

Defined in

packages/layout-forceatlas2/src/useWorkerLayoutForceAtlas2.ts:14