WebCola
Options
All
  • Public
  • Public/Protected
  • All
Menu

The base data structure for the datum of a Simulation Link, as used by ForceLink. The optional properties contained in this data structure are internally assigned by when initializating with ForceLink.links(...)

IMPORTANT: The source and target properties may be internally mutated in type during the ForceLink initialization process (possibly being changed from a node index in the nodes array, or a node id string to the simulation node object which was mapped in using the current ForceLink.id(...) accessor function.)

Type parameters

Hierarchy

  • SimulationLinkDatum

Index

Properties

Properties

index

index: number

The zero-based index into the links array. Internally generated when calling ForceLink.links(...)

source

source: NodeDatum | string | number

Link’s source node. For convenience, a link’s source property may be initialized using numeric or string identifiers rather than object references; see link.id. After initialization, the source property represents the source node object.

target

target: NodeDatum | string | number

Link’s source link For convenience, a link’s target property may be initialized using numeric or string identifiers rather than object references; see link.id. After initialization, the target property represents the source node object.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc