IBM ILOG Dojo Diagrammer 1.1.1 API Documentation
Legend: Array Boolean Constructor Date DomNode Error Function Namespace Number Object RegExp Singleton String

ibm_ilog.graphlayout.shortlink

Object » ibm_ilog.graphlayout.shortlink

Method Summary

  • ShortLinkLayout(a0) This class is the main class for the Short Link Layout algorithm.

Attached Objects

Methods

ShortLinkLayout

This class is the main class for the Short Link Layout algorithm.

This algorithm reshapes the links of a graph without moving the nodes. By default, the algorithm computes orthogonal links (that is, links composed of alternating horizontal and vertical segments). Optionally, direct links can be computed. (See ShortLinkLayout.setGlobalLinkStyle() and ShortLinkLayout.setLinkStyle().)

The links are placed freely in the plane by choosing the best shape from a fixed number of link shapes. Orthogonal links can a maximum of 4 bends. Direct links have 3 bends.

This layout algorithm is recommended when any of the following apply:

  • Most of the links are short, and it is not fatal if long links overlap some nodes.
  • The link routes must be placed freely and cannot be restricted to a grid.
  • It is important to limit the number of bends.

Otherwise, the ibm_ilog.graphlayout.longlink.LongLinkLayout may be more suitable.

Here are sample drawings produced by the Short Link Layout algorithm:

Sample drawing produced with the Short Link Layout

Sample drawing produced with the Short Link Layout

Sample drawing produced with the Short Link Layout

See the corresponding chapter of the User's Manual for details on the algorithm, the types of graphs for which this algorithm can be used, the features and limitations, code samples, and so on.

Note the following points:

  • The algorithm never moves any nodes. It only reshapes links.
  • The algorithm normally routes normal links. It has a special mode to route the intergraph links of the graph model.
  • The algorithm has an incremental mode and a nonincremental mode. In nonincremental mode, the initial shape of the links (at the moment you start the layout) does not affect the resulting layout. However, links specified as fixed while ibm_ilog.graphlayout.GraphLayout.setPreserveFixedLinks() is enabled or links that have the link style ShortLinkLayout.NO_RESHAPE_STYLE are not reshaped. The incremental mode cannot be used for intergraph links.
  • In incremental mode, the initial shape of the link does affect the resulting layout. The algorithm tries to preserve the shape of links that already fit the layout situation.
  • The algorithm supports self-links and multiple links between the same pair of nodes.

ParameterTypeDescription
a0