Skip to content

Function: layoutInWorker() ​

ts
function layoutInWorker<Result>(graph, arrangement, options?, run?): Promise<Result>;

Lay a graph out in the shared layout worker, or on the main thread in slices when there is no worker: see GraphLayoutWorker.run and LayoutRunOptions.

ts
const result = await layoutInWorker(
  graph,
  'force',
  { ticks: 300 },
  {
    owner: view,
    onProgress: ({ x, y }) => view.setPositions(x, y),
  },
);

Type Parameters ​

Type ParameterDefault type
Result extends LayoutResultLayoutResult

Parameters ​

ParameterType
graphLayoutGraph
arrangement| "radial" | "preset" | "force" | "layered" | "tree" | "dendrogram" | "circular" | "grid" | "arc" | "hive"
options?unknown
run?LayoutRunOptions

Returns ​

Promise<Result>

Released under the MIT License.