Interface: LayoutRunOptions

Options of one layoutInWorker call.

Properties

Property	Modifier	Type	Description
bundle?	readonly	BundleOptions	Bundle the links once the nodes are placed: the result's routes are the bundled ones.
move?	readonly	boolean	Give the graph's arrays to the worker instead of sending copies: they are empty afterwards (detached), and the copy is saved. Default false: the caller keeps its arrays.
onDone?	readonly	(info) => void	Called once, right before the promise resolves.
onProgress?	readonly	(progress) => void	Called with a simulation's positions as it cools (force), at most once per progress.interval. Without it no positions are sent before the result.
owner?	readonly	unknown	Whose layout this is (a trace, a view: any value). A new request for the same owner cancels the one before, whose promise rejects with an AbortError.
progress?	readonly	LayoutProgressOptions	How often positions are reported.
signal?	readonly	AbortSignal	Aborting it cancels the layout; the promise rejects with the signal's reason.
slice?	readonly	number	Milliseconds of work between two pauses (see LayoutRequest.slice). Default 8.
start?	readonly	ForceStart	force only: positions the simulation goes on from, and how warm it is there (the trace's force.start), instead of the spiral.
thread?	readonly	"auto" | "main"	'main': do not use the worker for this request. Default 'auto'.