Skip to main content

@react-sigma/layout-forceatlas2

Type Aliases

LayoutForceAtlas2ControlProps

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

Properties for LayoutForceAtlas2Control component

Defined in

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

Component Functions

LayoutForceAtlas2Control

LayoutForceAtlas2Control(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsLayoutForceAtlas2ControlProps
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/@types/react/index.d.ts:520


Hook Functions

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-core/lib/useLayoutFactory.d.ts:10


useWorkerLayoutForceAtlas2

useWorkerLayoutForceAtlas2(settings): Object

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

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

Parameters

NameType
settingsForceAtlas2LayoutParameters<Attributes, Attributes>

Returns

Object

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

Defined in

packages/layout-core/lib/useWorkerLayoutFactory.d.ts:2