Skip to main content

@react-sigma/layout-forceatlas2

Component​

LayoutForceAtlas2Control​

▸ LayoutForceAtlas2Control(props, context?): ReactNode

Parameters​

NameType
propsLayoutForceAtlas2ControlProps
context?any

Returns​

ReactNode

Defined in​

packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:20

Hook​

useLayoutForceAtlas2​

▸ useLayoutForceAtlas2(settings?): Object

React hook that helps you to manage force atlas2 layout.

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

Parameters​

NameType
settings?ForceAtlas2SynchronousLayoutParameters<Attributes, Attributes>

Returns​

Object

NameType
assign() => void
positions() => { [node: string]: { [dimension: string]: number; }; }

Defined in​

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

useWorkerLayoutForceAtlas2​

▸ useWorkerLayoutForceAtlas2(settings): Object

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

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

Parameters​

NameType
settingsForceAtlas2LayoutParameters

Returns​

Object

NameType
isRunningboolean
kill() => void
start() => void
stop() => void

Defined in​

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

Other​

LayoutForceAtlas2ControlProps​

Ƭ LayoutForceAtlas2ControlProps: Omit<WorkerLayoutControlProps<ForceAtlas2LayoutParameters>, "layout" | "settings"> & { settings?: ForceAtlas2LayoutParameters }

Properties for LayoutForceAtlas2Control component

Defined in​

packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:10