Skip to content
  1. API
  2. Types

LayoutOptions

Type: object

Properties

  • continuous(optional) boolean[=false] Whether or not the layout should render intermediate steps.
  • dryRun(optional) boolean[=false] If true, the layout will not be applied to the graph.
  • duration(optional) number[=300] Duration of the animation when the graph is updated
  • easing(optional) Easing[='cubicIn'] Easing function used during the animation
  • locate(optional) boolean|LocateOptions[=false] Center on the graph bounding box when the layout is complete. You can also provide padding.
  • nodes(optional) NodeId[]|NodeList List of affected nodes. If nothing provided, the whole graph will be used. Where edges param is available and provided, then this list will be augmented with reached nodes from the passed edge list.
  • onEnd(optional) function(): void Function called after the last graph update
  • onSync(optional) function(): void Function called every time the graph is updated
  • skipTextDrawing(optional) boolean[=true] Skip drawing labels during the layout. Improves performance and user experience.
  • useWebWorker(optional) boolean[=true] Indicates if the layout should be computed inside a web worker.