Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayoutEdge

Hierarchy

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:

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

Index

Constructors

constructor

Properties

data : ObjectData

  • For virtualized layouts working on model data instead of a Link.

    since

    1.6

fromVertex : LayoutVertex

link : Link

  • 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.

network : LayoutNetwork

toVertex : LayoutVertex

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 Introduction page on Extensions for how to override methods and how to call this base method.

    Returns void

getOtherVertex

  • Returns the edge's vertex at the other of this edge from the given vertex.

    Parameters

    Returns LayoutVertex