@react-sigma/layout-noverlap
Component
LayoutNoverlapControl
▸ LayoutNoverlapControl(props, context?): ReactNode
Parameters
| Name | Type |
|---|---|
props | LayoutNoverlapControlProps |
context? | any |
Returns
ReactNode
Defined in
packages/layout-noverlap/src/LayoutNoverlapControl.tsx:20
Hook
useLayoutNoverlap
▸ useLayoutNoverlap(settings?): Object
React hook that helps you to manage noverlap layout.
const { positions, assign } = useLayoutNoverlap(...);
Parameters
| Name | Type |
|---|---|
settings? | NoverlapLayoutParameters |
Returns
Object
| Name | Type |
|---|---|
assign | () => void |
positions | () => { [node: string]: { [dimension: string]: number; }; } |
Defined in
packages/layout-noverlap/src/useLayoutNoverlap.ts:13
useWorkerLayoutNoverlap
▸ useWorkerLayoutNoverlap(settings): Object
React hook that helps you to manage worker for noverlap layout.
const { stop, start } = useWorkerLayoutNoverlap({layoutOptions});
Parameters
| Name | Type |
|---|---|
settings | NoverlapLayoutSupervisorParameters |
Returns
Object
| Name | Type |
|---|---|
isRunning | boolean |
kill | () => void |
start | () => void |
stop | () => void |
Defined in
packages/layout-noverlap/src/useWorkerLayoutNoverlap.ts:13
Other
LayoutNoverlapControlProps
Ƭ LayoutNoverlapControlProps: Omit<WorkerLayoutControlProps<NoverlapLayoutSupervisorParameters>, "layout" | "settings"> & { settings?: NoverlapLayoutSupervisorParameters }
Properties for NoverlapControl component