Summary

• Page properties (1 modified, 0 added, 0 removed)
• Objects (1 modified, 0 added, 0 removed)
  • Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

...	...	@@ -12,15 +12,8 @@
12	12
13	13	= Overview =
14	14
15		-Beside a human-readable name, layout options are defined by the following properties:
	15	+For a general introduction on layout options, see [[the KIML documentation>>doc:KIML Layout Options]]. KLay Layered supports layout options defined by KIML and defines additional custom layout options.
16	16
17		-* An ID to identify them.
18		-* A type. One of Boolean, String, Int, Float, Enum, EnumSet (a {{code language="none"}}Set{{/code}} over a given enumeration), or Object. The types Enum and EnumSet have to be further defined by an enumeration class. The Object type can be constricted to a certain class.
19		-* The kinds of graph objects the option applies to. At least one of Parents (nodes that have children, including the diagram root node), Nodes, Edges, Ports, and Labels.
20		-* An optional default value. If an option is not set on an object and if the option does not have a default value, {{code language="none"}}null{{/code}} is returned when it is accessed.
21		-
22		-KLay Layered supports layout options defined by KIML and defines additional custom layout options.
23		-
24	24	== Supported KIML Layout Options ==
25	25
26	26	KLay Layered supports the following standard layout options defined by KIML. Note that the default value may be altered (highlighted yellow).
...	...	@@ -411,7 +411,7 @@
411	411	20
412	412	)))
413	413
414		-== KLay Layered Layout Options ==
	407	+== Custom Layout Options ==
415	415
416	416	|=(((
417	417	Option
...	...	@@ -627,4 +627,33 @@
627	627
628	628	This section explains every layout option in more detail. See [[the KIML documentation>>doc:KIML Layout Options]] for more information on KIML layout options. Those options are only mentioned here if KLay Layered adds some custom behavior.
629	629
630		-
	623	+== Crossing Minimization ==
	624	+
	625	+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:
	626	+
	627	+* LAYER_SWEEP
	628	+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.
	629	+* INTERACTIVE
	630	+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.
	631	+
	632	+== Cycle Breaking ==
	633	+
	634	+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:
	635	+
	636	+* GREEDY
	637	+This algorithm reverses edges greedily. The algorithm tries to avoid edges that have the //Priority// property set.
	638	+* INTERACTIVE
	639	+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.
	640	+
	641	+== Interactive Reference Point ==
	642	+
	643	+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:
	644	+
	645	+* TOP_LEFT
	646	+The top left corner of a node is taken as the reference point.
	647	+* CENTER
	648	+The center of a node is taken as the reference point.
	649	+
	650	+== Thoroughness ==
	651	+
	652	+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.

Confluence.Code.ConfluencePageClass[0]

Id

...	...	@@ -1,1 +1,1 @@
1		-7111101
	1	+7111115

URL

...	...	@@ -1,1 +1,1 @@
1		-https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/7111101/KLay Layered Layout Options
	1	+https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/7111115/KLay Layered Layout Options