API Docs for: 1
Show:

d3adaptor Class

Defined in: lib/d3adaptor.js:13
Module: cola

Methods

start

(
  • [initialUnconstrainedIterations=0]
  • [initialUserConstraintIterations=0]
  • [initialAllConstraintsIterations=0]
)

start the layout process

Parameters:

  • [initialUnconstrainedIterations=0] Number optional

    unconstrained initial layout iterations

  • [initialUserConstraintIterations=0] Number optional

    initial layout iterations with user-specified constraints

  • [initialAllConstraintsIterations=0] Number optional

    initial layout iterations with all constraints including non-overlap

Properties

avoidOverlaps

Bool

if true, the layout will not permit overlaps of the node bounding boxes (defined by the width and height properties on nodes)

Default: false

avoidOverlaps

Bool

if true, the layout will not permit overlaps of the node bounding boxes (defined by the width and height properties on nodes)

Default: false

constraints

Array

list of constraints of various types

Default: empty list

defaultNodeSize

Number

Default size (assume nodes are square so both width and height) to use in packing if node width/height are not specified.

distanceMatrix

Array of Array of Number

Matrix of ideal distances between all pairs of nodes. If unspecified, the ideal distances for pairs of nodes will be based on the shortest path distance between them.

Default: null

groups

Array

a list of hierarchical groups defined over nodes

Default: empty list

nodes

Array

Defined in lib/d3adaptor.js:87

the list of nodes. If nodes has not been set, but links has, then we instantiate a nodes list here, of the correct size, before returning it.

Default: empty list

size

Array of Number

Size of the layout canvas dimensions [x,y]. Currently only used to determine the midpoint which is taken as the starting position for nodes with no preassigned x and y.