@react-sigma/layout-core
React Sigma core module for layouts. It contains all the standard components & hooks for managing layout.
Interfaces
Type Aliases
LayoutHook
Ƭ LayoutHook<T>: (settings?: T) => { assign: () => void ; positions: () => { [node: string]: { [dimension: string]: number; }; } }
Generic type for layout hooks.
Type parameters
| Name |
|---|
T |
Type declaration
▸ (settings?): Object
Parameters
| Name | Type |
|---|---|
settings? | T |
Returns
Object
| Name | Type | Description |
|---|---|---|
assign | () => void | - |
positions | () => { [node: string]: { [dimension: string]: number; }; } | - |
Defined in
LayoutWorkerHook
Ƭ LayoutWorkerHook<T>: (settings: T) => { isRunning: boolean ; kill: () => void ; start: () => void ; stop: () => void }
Type parameters
| Name |
|---|
T |
Type declaration
▸ (settings): Object
Parameters
| Name | Type |
|---|---|
settings | T |
Returns
Object
| Name | Type |
|---|---|
isRunning | boolean |
kill | () => void |
start | () => void |
stop | () => void |
Defined in
Functions
WorkerLayoutControl
▸ WorkerLayoutControl<T>(«destructured»): Element
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
«destructured» | WorkerLayoutControlProps<T> |
Returns
Element
Defined in
useLayoutFactory
▸ useLayoutFactory<T>(layout, defaultSettings): LayoutHook<T>
Factory for layout hook.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
layout | GraphologyLayout<T> |
defaultSettings | T |
Returns
LayoutHook<T>
Defined in
useWorkerLayoutFactory
▸ useWorkerLayoutFactory<T>(worker): LayoutWorkerHook<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
worker | GraphologyWorkerLayoutConstructor<T> |