Class pv.Layout.Network.Link
Represents a link in a network layout. There is no explicit
constructor; this class merely serves to document the attributes that are
used on links in network layouts. For hierarchical layouts, this class is
used to represent the parent-child links.
Defined in: Network.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Field Attributes | Field Name and Description |
---|---|
The link value, or weight; optional.
|
|
Alias for sourceNode, as expressed by the index of the source node.
|
|
The link's source node.
|
|
Alias for targetNode, as expressed by the index of the target node.
|
|
The link's target node.
|
|
Alias for linkValue.
|
Field Detail
{number}
linkValue
The link value, or weight; optional. If not specified (or not a number), the
default value of 1 is used.
{number}
source
Alias for sourceNode, as expressed by the index of the source node.
This attribute is not populated automatically, but may be used as a more
convenient identification of the link's source, for example in a static JSON
representation.
{pv.Layout.Network.Node}
sourceNode
The link's source node. If not set, this value will be derived from the
source attribute index.
{number}
target
Alias for targetNode, as expressed by the index of the target node.
This attribute is not populated automatically, but may be used as a more
convenient identification of the link's target, for example in a static JSON
representation.
{pv.Layout.Network.Node}
targetNode
The link's target node. If not set, this value will be derived from the
target attribute index.
{number}
value
Alias for linkValue. This attribute is not populated automatically,
but may be used instead of the linkValue attribute when specifying
links.