NeighborGenerationOptions

Type: object

Properties

• options(optional)
  • duration(optional) number[=0]
  • edgeGenerator(optional) function(originalNode: Node, generatedNode: Node): RawEdge Given the original node and the generated neighbor, returns the edge that must be created between them. Source and target may be specified; otherwise the original node is the source and the generated node is the target. If this parameter is unspecified, an edge with no data and with default attributes is created.
  • enabled(optional) boolean[=true]
  • neighborIdFunction function(node: Node): string|Array<string>|null String identifying the neighbor that will be created. An array of string can be passed; in this case multiple neighbors are created. If null is returned, no neighbor is created.
  • nodeGenerator(optional) function(identifier: string, nodes: NodeList): RawNode Given the nodes that spawned it and its identifier (which is not its final id, but is part of it), returns the node that must be created. If unspecified, a node with no data and with default attributes is created.
  • selector(optional) function(node: Node): boolean If unspecified, defaults to a function that always returns true.