LayoutEdge class

An edge represents a Link in a LayoutNetwork, along with its #fromVertex and #toVertex. The #link property may be null for edges that represent "dummy" links, when the layout wants to work with a network that is not isomorphic with the collection of Nodes and Links being laid out.

It holds layout-specific data for the link. For each kind of layout that uses a LayoutNetwork there is a subclass of LayoutVertex and a subclass of LayoutEdge:

  • CircularLayout: CircularVertex and CircularEdge
  • ForceDirectedLayout: ForceDirectedVertex and ForceDirectedEdge
  • LayeredDigraphLayout: LayeredDigraphVertex and LayeredDigraphEdge
  • TreeLayout: TreeVertex and TreeEdge

Modifying a LayoutNetwork or a LayoutVertex or a LayoutEdge does not invalidate the Layout or raise any changed events.

Implementers
Available extensions
Annotations
  • @JS()
  • @staticInterop

Constructors

LayoutEdge(LayoutNetwork network)
factory

Properties

data Object?

Available on LayoutEdge, provided by the LayoutEdge$Typings extension

For virtualized layouts working on model data instead of a Link.
getter/setter pair
fromVertex LayoutVertex?

Available on LayoutEdge, provided by the LayoutEdge$Typings extension

Gets or sets the LayoutVertex that this edge comes from. Setting this property does not change any LayoutVertex#destinationEdges collection.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited

Available on LayoutEdge, provided by the LayoutEdge$Typings extension

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.
getter/setter pair
network LayoutNetwork

Available on LayoutEdge, provided by the LayoutEdge$Typings extension

Gets the LayoutNetwork that owns this edge. The default value is null. It is set automatically for you in LayoutNetwork#createEdge.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
toVertex LayoutVertex?

Available on LayoutEdge, provided by the LayoutEdge$Typings extension

Gets or sets the LayoutVertex that this edge goes to. Setting this property does not change any LayoutVertex#sourceEdges collection.
getter/setter pair

Methods

commit() → void

Available on LayoutEdge, provided by the LayoutEdge$Typings extension

Commits the route of this edge to the corresponding Link, if any. By default this does nothing. Please read the Introduction page on Extensions for how to override methods and how to call this base method. @expose
getOtherVertex(LayoutVertex v) LayoutVertex?

Available on LayoutEdge, provided by the LayoutEdge$Typings extension

Returns the edge's vertex at the other of this edge from the given vertex. @param {LayoutVertex} v
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited