Class ForceDirectedEdge`Unindexed`

GoJS® Diagramming Components
version 4.0.0
by Northwoods Software®

This holds ForceDirectedLayout-specific information about Links.

This class inherits from LayoutEdge.

Hierarchy (View Summary)

LayoutEdge
- ForceDirectedEdge

Index

Constructors

Accessors

data fromVertex length link network stiffness toVertex

Methods

commit getOtherVertex

Constructors

constructor

new ForceDirectedEdge(network: ForceDirectedNetwork): ForceDirectedEdge
Parameters
- network: ForceDirectedNetwork
Returns ForceDirectedEdge
Overrides LayoutEdge.constructor

Accessors

data

get data(): ObjectData | null
For virtualized layouts working on model data instead of a Link.

Returns ObjectData | null
Inherited from LayoutEdge.data

fromVertex

get fromVertex(): LayoutVertex | null
Gets or sets the LayoutVertex that this edge comes from. Setting this property does not change any LayoutVertex.destinationEdges collection.

Returns LayoutVertex | null
Inherited from LayoutEdge.fromVertex

length

get length(): number
Gets or sets the length of this edge. The default value is NaN.

Returns number

link

get link(): Link | null
Gets or sets the Link associated with this edge, if any. The value may be null if this edge is a "dummy" edge, not represented by a real Link in the Diagram.

Returns Link | null
Inherited from LayoutEdge.link

`Readonly`network

get network(): LayoutNetwork
Gets the LayoutNetwork that owns this edge. The default value is null. It is set automatically for you in LayoutNetwork.createEdge.

Returns LayoutNetwork
Inherited from LayoutEdge.network

stiffness

get stiffness(): number
Gets or sets this edge's stiffness or resistance to compression or stretching. The default value is NaN.

Returns number

toVertex

get toVertex(): LayoutVertex | null
Gets or sets the LayoutVertex that this edge goes to. Setting this property does not change any LayoutVertex.sourceEdges collection.

Returns LayoutVertex | null
Inherited from LayoutEdge.toVertex

Methods

`Virtual`commit

commit(): void
Commits the route of this edge to the corresponding Link, if any. By default this does nothing. Please read the Learn page on Extensions for how to override methods and how to call this base method.

Returns void
Inherited from LayoutEdge.commit

getOtherVertex

getOtherVertex(v: LayoutVertex): LayoutVertex | null
Returns the edge's vertex at the other of this edge from the given vertex.
Parameters
- v: LayoutVertex
Returns LayoutVertex | null
Inherited from LayoutEdge.getOtherVertex