@react-sigma/layout-force
Component
LayoutForceControl
▸ LayoutForceControl(props, context?): ReactNode
Component that display a button to start/stop the layout.
Parameters
| Name | Type |
|---|---|
props | LayoutForceControlProps |
context? | any |
Returns
ReactNode
Defined in
packages/layout-force/src/LayoutForceControl.tsx:22
Hook
useLayoutForce
▸ useLayoutForce(settings?): Object
React hook that helps you to manage force layout.
const { positions, assign } = useLayoutForce(...);
Parameters
| Name | Type |
|---|---|
settings? | ForceLayoutParameters |
Returns
Object
| Name | Type |
|---|---|
assign | () => void |
positions | () => { [node: string]: { [dimension: string]: number; }; } |
Defined in
packages/layout-force/src/useLayoutForce.ts:13
useWorkerLayoutForce
▸ useWorkerLayoutForce(settings): Object
React hook that helps you to manage worker of force layout.
const { stop, start } = useWorkerLayoutForce(...);
Parameters
| Name | Type |
|---|---|
settings | ForceLayoutSupervisorParameters |
Returns
Object
| Name | Type |
|---|---|
isRunning | boolean |
kill | () => void |
start | () => void |
stop | () => void |
Defined in
packages/layout-force/src/useWorkerLayoutForce.ts:13
Other
LayoutForceControlProps
Ƭ LayoutForceControlProps: Omit<WorkerLayoutControlProps<ForceLayoutSupervisorParameters>, "layout" | "settings"> & { settings?: ForceLayoutSupervisorParameters }
Properties for ForceDirectedControl component