KLay Layered supports a whole bunch of layout options. Every single one of them is documented here.

Contents

• Overview
  • Supported KIML Layout Options
  • Custom Layout Options
• The Most Important Options
• Detailed Documentation
  • Crossing Minimization
  • Cycle Breaking
  • Edge Spacing Factor
  • Interactive Reference Point
  • Maximal Iterations
  • Thoroughness

Overview

For a general introduction on layout options, see the KIML documentation. KLay Layered supports layout options defined by KIML and defines additional custom layout options.

Supported KIML Layout Options

KLay Layered supports the following standard layout options defined by KIML. Note that the default value may be altered (highlighted yellow).

Custom Layout Options

The Most Important Options

TODO: Write a bit of documentation about the most important layout options and how to use them, possibly with a simple example or something.

Detailed Documentation

This section explains every layout option in more detail. See the KIML documentation for more information on KIML layout options. Those options are only mentioned here if KLay Layered adds some custom behavior.

Crossing Minimization

Crossing minimization determines the ordering of nodes in each layer, which influences the number of edge crossings. This option switches between one of several algorithms that can be used to minimize crossings. Possible values are:

• LAYER_SWEEP
  The layer sweep algorithm iterates multiple times over the layers, trying to find node orderings that minimize the number of crossings. The algorithm uses randomization to increase the odds of finding a good result. To improve its results, consider increasing the Thoroughness option, which influences the number of iterations done. The Randomization seed also influences results.
• INTERACTIVE
  Orders the nodes of each layer by comparing their positions before the layout algorithm was started. The idea is that the relative order of nodes as it was before layout was applied is not changed. This of course requires valid positions for all nodes to have been set on the input graph before calling the layout algorithm. The interactive layer sweep algorithm uses the Interactive Reference Point option to determine which reference point of nodes are used to compare positions.

Cycle Breaking

KLay Layered tries to position nodes in a way that all edges point rightwards. This is not possible if the input graph has cycles. Such cycles have to be broken by reversing as few edges as possible. The reversed edges end up pointing leftwards in the resulting diagram. There are different cycle breaking algorithms available:

• GREEDY
  This algorithm reverses edges greedily. The algorithm tries to avoid edges that have the Priority property set.
• INTERACTIVE
  The interactive algorithm tries to reverse edges that already pointed leftwards in the input graph. This requires node and port coordinates to have been set to sensible values.

Edge Spacing Factor

The edge spacing factor determines the amount of space between edges, relative to the regular Spacing value. The idea is that we don't need as much space between edges as we do between nodes.

Interactive Reference Point

Interactive layering, crossing minimization, and cycle breaking algorithms use node positions to sort nodes into layers or to determine the order of nodes in each layer. However, it is unclear if for example the top left corners of nodes should be compared, or the bottom left corners — different settings might lead to different results. The interactive reference point determines which part of nodes is used to compare their positions. It provides the following settings:

• TOP_LEFT
  The top left corner of a node is taken as the reference point.
• CENTER
  The center of a node is taken as the reference point.

Maximal Iterations

Delimits the amount of depth-first-search iterations performed by the network simplex layering strategy. Large, highly connected graphs might require a long time to be processed. This property serves as a timeout after which an exception is raised.

Thoroughness

There are heuristics in use all over KLay Layered whose results often improve with the number of iterations computed. The thoroughness is a measure for telling KLay Layered to compute more iterations to improve the quality of results, at the expense of performance.