Last modified by Richard Kreissig on 2023/09/14 10:20
<
From version < 12.1 >
edited by cds
on 2014/03/14 14:32
To version < 43.1 >
edited by csp
on 2023/07/06 14:35
>
Change comment: Renamed back-links.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +KLay Layered
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cds
1 +XWiki.csp
Content
... ... @@ -1,7 +5,3 @@
1 -{{warning}}
2 -This is preliminary and incomplete documentation. You've been warned.
3 -{{/warning}}
4 -
5 5  KLay Layered supports a whole bunch of layout options. Every single one of them is documented here.
6 6  
7 7  **Contents**
... ... @@ -12,11 +12,11 @@
12 12  
13 13  = Overview =
14 14  
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.
11 +For a general introduction on layout options, see [[the KIML documentation>>doc:KIELER.Home.Discontinued Projects.Infrastructure for Meta Layout (KIML).KIML Layout Options.WebHome]]. KLay Layered supports layout options defined by KIML and defines additional custom layout options.
16 16  
17 17  == Supported KIML Layout Options ==
18 18  
19 -KLay Layered supports the following standard layout options defined by KIML. Note that the default value may be altered (highlighted yellow).
15 +KLay Layered supports the following standard layout options defined by KIML. Note that the default value may be altered (highlighted yellow). These layout options are documented on [[KIML's Layout Options page>>doc:KIELER.Home.Discontinued Projects.Infrastructure for Meta Layout (KIML).KIML Layout Options.WebHome]].
20 20  
21 21  |=(((
22 22  Option
... ... @@ -29,6 +29,22 @@
29 29  )))|=(((
30 30  Default
31 31  )))
28 +|(% colspan="1" %)(% colspan="1" %)
29 +(((
30 +Additional Port Space
31 +)))|(% colspan="1" %)(% colspan="1" %)
32 +(((
33 +de.cau.cs.kieler.additionalPortSpace
34 +)))|(% colspan="1" %)(% colspan="1" %)
35 +(((
36 +Margins
37 +)))|(% colspan="1" %)(% colspan="1" %)
38 +(((
39 +Nodes
40 +)))|(% colspan="1" %)(% colspan="1" %)
41 +(((
42 +0, 0, 0, 0
43 +)))
32 32  |(((
33 33  Alignment
34 34  )))|(((
... ... @@ -66,7 +66,7 @@
66 66  )))
67 67  |(% colspan="1" %)(% colspan="1" %)
68 68  (((
69 -Comment Box XX
81 +Comment Box
70 70  )))|(% colspan="1" %)(% colspan="1" %)
71 71  (((
72 72  de.cau.cs.kieler.commentBox
... ... @@ -108,7 +108,7 @@
108 108  
109 109  )))
110 110  |(((
111 -Direction
123 +[[Direction>>doc:||anchor="direction"]]
112 112  )))|(((
113 113  de.cau.cs.kieler.direction
114 114  )))|(((
... ... @@ -115,13 +115,12 @@
115 115  Enum
116 116  )))|(((
117 117  Parents
118 -)))|(% class="highlight-yellow" data-highlight-colour="yellow" %)(% class="highlight-yellow" data-highlight-colour="yellow" %)
119 -(((
120 -RIGHT
130 +)))|(((
131 +UNDEFINED
121 121  )))
122 122  |(% colspan="1" %)(% colspan="1" %)
123 123  (((
124 -Edge Label Placement XX
135 +Edge Label Placement
125 125  )))|(% colspan="1" %)(% colspan="1" %)
126 126  (((
127 127  de.cau.cs.kieler.edgeLabelPlacement
... ... @@ -145,11 +145,11 @@
145 145  Parents
146 146  )))|(% class="highlight-yellow" data-highlight-colour="yellow" %)(% class="highlight-yellow" data-highlight-colour="yellow" %)
147 147  (((
148 -POLYLINE
159 +ORTHOGONAL
149 149  )))
150 150  |(% colspan="1" %)(% colspan="1" %)
151 151  (((
152 -Hypernode XX
163 +Hypernode
153 153  )))|(% colspan="1" %)(% colspan="1" %)
154 154  (((
155 155  de.cau.cs.kieler.hypernode
... ... @@ -180,7 +180,7 @@
180 180  SMART
181 181  )))
182 182  |(((
183 -Label Spacing XX
194 +Label Spacing
184 184  )))|(((
185 185  de.cau.cs.kieler.labelSpacing
186 186  )))|(((
... ... @@ -204,7 +204,7 @@
204 204  )))
205 205  |(% colspan="1" %)(% colspan="1" %)
206 206  (((
207 -Minimal Height XX
218 +Minimal Height
208 208  )))|(% colspan="1" %)(% colspan="1" %)
209 209  (((
210 210  de.cau.cs.kieler.minHeight
... ... @@ -221,7 +221,7 @@
221 221  )))
222 222  |(% colspan="1" %)(% colspan="1" %)
223 223  (((
224 -Minimal Width XX
235 +Minimal Width
225 225  )))|(% colspan="1" %)(% colspan="1" %)
226 226  (((
227 227  de.cau.cs.kieler.minWidth
... ... @@ -238,7 +238,7 @@
238 238  )))
239 239  |(% colspan="1" %)(% colspan="1" %)
240 240  (((
241 -No Layout XX
252 +No Layout
242 242  )))|(% colspan="1" %)(% colspan="1" %)
243 243  (((
244 244  de.cau.cs.kieler.noLayout
... ... @@ -268,6 +268,22 @@
268 268  (((
269 269  
270 270  )))
282 +|(% colspan="1" %)(% colspan="1" %)
283 +(((
284 +(% class="confluence-link" %)Port Anchor Offset
285 +)))|(% colspan="1" %)(% colspan="1" %)
286 +(((
287 +de.cau.cs.kieler.klay.layered.portAnchor
288 +)))|(% colspan="1" %)(% colspan="1" %)
289 +(((
290 +Object
291 +)))|(% colspan="1" %)(% colspan="1" %)
292 +(((
293 +Ports
294 +)))|(% colspan="1" %)(% colspan="1" %)
295 +(((
296 +
297 +)))
271 271  |(((
272 272  Port Constraints
273 273  )))|(((
... ... @@ -297,7 +297,7 @@
297 297  )))
298 298  |(% colspan="1" %)(% colspan="1" %)
299 299  (((
300 -Port Offset XX
327 +Port Offset
301 301  )))|(% colspan="1" %)(% colspan="1" %)
302 302  (((
303 303  de.cau.cs.kieler.offset
... ... @@ -313,7 +313,7 @@
313 313  )))
314 314  |(% colspan="1" %)(% colspan="1" %)
315 315  (((
316 -Port Side XX
343 +Port Side
317 317  )))|(% colspan="1" %)(% colspan="1" %)
318 318  (((
319 319  de.cau.cs.kieler.portSide
... ... @@ -327,6 +327,22 @@
327 327  (((
328 328  UNDEFINED
329 329  )))
357 +|(% colspan="1" %)(% colspan="1" %)
358 +(((
359 +Port Spacing
360 +)))|(% colspan="1" %)(% colspan="1" %)
361 +(((
362 +de.cau.cs.kieler.portSpacing
363 +)))|(% colspan="1" %)(% colspan="1" %)
364 +(((
365 +Float
366 +)))|(% colspan="1" %)(% colspan="1" %)
367 +(((
368 +Nodes
369 +)))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
370 +(((
371 +10
372 +)))
330 330  |(((
331 331  Priority
332 332  )))|(((
... ... @@ -436,8 +436,46 @@
436 436  (((
437 437  Dependency
438 438  )))
482 +|(% colspan="1" %)(% colspan="1" %)
483 +(((
484 +[[Add Unnecessary Bendpoints>>doc:||anchor="addUnnecessaryBendpoints"]]
485 +)))|(% colspan="1" %)(% colspan="1" %)
486 +(((
487 +de.cau.cs.kieler.klay.layered.unnecessaryBendpoints
488 +)))|(% colspan="1" %)(% colspan="1" %)
489 +(((
490 +Boolean
491 +)))|(% colspan="1" %)(% colspan="1" %)
492 +(((
493 +Parents
494 +)))|(% colspan="1" %)(% colspan="1" %)
495 +(((
496 +false
497 +)))|(% colspan="1" %)(% colspan="1" %)
498 +(((
499 +
500 +)))
501 +|(% colspan="1" %)(% colspan="1" %)
502 +(((
503 +[[Content Alignment>>doc:||anchor="contentAlignment"]]
504 +)))|(% colspan="1" %)(% colspan="1" %)
505 +(((
506 +de.cau.cs.kieler.klay.layered.contentAlignment
507 +)))|(% colspan="1" %)(% colspan="1" %)
508 +(((
509 +EnumSet
510 +)))|(% colspan="1" %)(% colspan="1" %)
511 +(((
512 +Parents
513 +)))|(% colspan="1" %)(% colspan="1" %)
514 +(((
515 +V_TOP, H_LEFT
516 +)))|(% colspan="1" %)(% colspan="1" %)
517 +(((
518 +
519 +)))
439 439  |(((
440 -[[Crossing Minimization>>doc:||anchor="crossingMinimizat"]]
521 +[[Crossing Minimization>>doc:||anchor="crossingMinimization"]]
441 441  )))|(((
442 442  de.cau.cs.kieler.klay.layered.crossMin
443 443  )))|(((
... ... @@ -480,9 +480,28 @@
480 480  )))
481 481  |(% colspan="1" %)(% colspan="1" %)
482 482  (((
483 -Feedback Edges
564 +[[Edge Label Side Selection>>doc:||anchor="edgeLabelSideSelection"]]
484 484  )))|(% colspan="1" %)(% colspan="1" %)
485 485  (((
567 +de.cau.cs.kieler.klay.layered.edgeLabelSideSelection
568 +)))|(% colspan="1" %)(% colspan="1" %)
569 +(((
570 +Enum
571 +)))|(% colspan="1" %)(% colspan="1" %)
572 +(((
573 +Parents
574 +)))|(% colspan="1" %)(% colspan="1" %)
575 +(((
576 +ALWAYS_DOWN
577 +)))|(% colspan="1" %)(% colspan="1" %)
578 +(((
579 +
580 +)))
581 +|(% colspan="1" %)(% colspan="1" %)
582 +(((
583 +[[Feedback Edges>>doc:||anchor="feedbackEdges"]]
584 +)))|(% colspan="1" %)(% colspan="1" %)
585 +(((
486 486  de.cau.cs.kieler.klay.layered.feedBackEdges
487 487  )))|(% colspan="1" %)(% colspan="1" %)
488 488  (((
... ... @@ -499,7 +499,7 @@
499 499  )))
500 500  |(% colspan="1" %)(% colspan="1" %)
501 501  (((
502 -Fixed Alignment
602 +[[Fixed Alignment>>doc:||anchor="fixedAlignment"]]
503 503  )))|(% colspan="1" %)(% colspan="1" %)
504 504  (((
505 505  de.cau.cs.kieler.klay.layered.fixedAlignment
... ... @@ -514,11 +514,11 @@
514 514  NONE
515 515  )))|(% colspan="1" %)(% colspan="1" %)
516 516  (((
517 -
617 +nodePlace=BRANDES_KOEPF
518 518  )))
519 519  |(% colspan="1" %)(% colspan="1" %)
520 520  (((
521 -[[Interactive Reference Point>>doc:||anchor="interactiveReferencePoi"]]
621 +[[Interactive Reference Point>>doc:||anchor="interactiveReferencePoint"]]
522 522  )))|(% colspan="1" %)(% colspan="1" %)
523 523  (((
524 524  de.cau.cs.kieler.klay.layered.interactiveReferencePoint
... ... @@ -537,7 +537,7 @@
537 537  )))
538 538  |(% colspan="1" %)(% colspan="1" %)
539 539  (((
540 -Layer Constraint
640 +[[Layer Constraint>>doc:||anchor="layerConstraint"]]
541 541  )))|(% colspan="1" %)(% colspan="1" %)
542 542  (((
543 543  de.cau.cs.kieler.klay.layered.layerConstraint
... ... @@ -556,29 +556,29 @@
556 556  )))
557 557  |(% colspan="1" %)(% colspan="1" %)
558 558  (((
559 -Maximal Iterations
659 +[[Linear Segments Deflection Dampening>>doc:||anchor="deflectionDampening"]]
560 560  )))|(% colspan="1" %)(% colspan="1" %)
561 561  (((
562 -de.cau.cs.kieler.klay.layered.nodeLayering
662 +de.cau.cs.kieler.klay.layered.linearSegmentsDeflectionDampening
563 563  )))|(% colspan="1" %)(% colspan="1" %)
564 564  (((
565 -Int
665 +Float
566 566  )))|(% colspan="1" %)(% colspan="1" %)
567 567  (((
568 568  Parents
569 569  )))|(% colspan="1" %)(% colspan="1" %)
570 570  (((
571 -10.000.000
671 +0.3
572 572  )))|(% colspan="1" %)(% colspan="1" %)
573 573  (((
574 -nodeLayering=NETWORK_SIMPLEX
674 +nodePlace=LINEAR_SEGMENTS
575 575  )))
576 576  |(% colspan="1" %)(% colspan="1" %)
577 577  (((
578 -Merge Edges
678 +[[Merge Edges>>doc:||anchor="mergeEdges"]]
579 579  )))|(% colspan="1" %)(% colspan="1" %)
580 580  (((
581 -de.cau.cs.kieler.klay.layered.mergePorts
681 +de.cau.cs.kieler.klay.layered.mergeEdges
582 582  )))|(% colspan="1" %)(% colspan="1" %)
583 583  (((
584 584  Boolean
... ... @@ -594,7 +594,7 @@
594 594  )))
595 595  |(% colspan="1" %)(% colspan="1" %)
596 596  (((
597 -Merge Hierarchy-crossing Edges
697 +[[Merge Hierarchy-Crossing Edges>>doc:||anchor="mergeHierarchyEdges"]]
598 598  )))|(% colspan="1" %)(% colspan="1" %)
599 599  (((
600 600  de.cau.cs.kieler.klay.layered.mergeHierarchyPorts
... ... @@ -609,10 +609,10 @@
609 609  true
610 610  )))|(% colspan="1" %)(% colspan="1" %)
611 611  (((
612 -
712 +layoutHierarchy=true
613 613  )))
614 614  |(((
615 -Node Layering
715 +[[Node Layering>>doc:||anchor="nodeLayering"]]
616 616  )))|(((
617 617  de.cau.cs.kieler.klay.layered.nodeLayering
618 618  )))|(((
... ... @@ -627,7 +627,7 @@
627 627  )))
628 628  |(% colspan="1" %)(% colspan="1" %)
629 629  (((
630 -Node Placement
730 +[[Node Placement>>doc:||anchor="nodePlacement"]]
631 631  )))|(% colspan="1" %)(% colspan="1" %)
632 632  (((
633 633  de.cau.cs.kieler.klay.layered.nodePlace
... ... @@ -644,27 +644,8 @@
644 644  (((
645 645  
646 646  )))
647 -|(% colspan="1" %)(% colspan="1" %)
648 -(((
649 -Port Anchor Offset
650 -)))|(% colspan="1" %)(% colspan="1" %)
651 -(((
652 -de.cau.cs.kieler.klay.layered.portAnchor
653 -)))|(% colspan="1" %)(% colspan="1" %)
654 -(((
655 -Object
656 -)))|(% colspan="1" %)(% colspan="1" %)
657 -(((
658 -Ports
659 -)))|(% colspan="1" %)(% colspan="1" %)
660 -(((
661 -
662 -)))|(% colspan="1" %)(% colspan="1" %)
663 -(((
664 -
665 -)))
666 666  |(((
667 -[[Thoroughness>>doc:||anchor="thorough"]]
748 +[[Thoroughness>>doc:||anchor="thoroughness"]]
668 668  )))|(((
669 669  de.cau.cs.kieler.klay.layered.thoroughness
670 670  )))|(((
... ... @@ -672,83 +672,158 @@
672 672  )))|(((
673 673  Parents
674 674  )))|(((
675 -7
756 +10
676 676  )))|(% colspan="1" %)(% colspan="1" %)
677 677  (((
678 678  
679 679  )))
680 680  
681 -= The Most Important Options =
762 += Detailed Documentation =
682 682  
683 -**TODO:** Write a bit of documentation about the most important layout options and how to use them, possibly with a simple example or something.
764 +This section explains every layout option in more detail. See [[the KIML documentation>>doc:KIELER.Home.Discontinued Projects.Infrastructure for Meta Layout (KIML).KIML Layout Options.WebHome]] for more information on KIML layout options. Those options are only mentioned here if KLay Layered adds some custom behavior.
684 684  
685 -= Detailed Documentation =
766 +== ==
686 686  
687 -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.
768 +{{id name="addUnnecessaryBendpoints"/}}Add Unnecessary BendpointsBy default, KLay Layered tries not to add bendpoints to an edge at positions where the edge doesn't change direction since there's no real bend there. Turning this option on forces such bend points. More specifically, a bend point is added for each edge that spans more than one layer at the point where it crosses a layer. If hierarchy layout is turned on, a bend point is also added whenever the edge crosses a hierarchy boundary.
688 688  
689 -== Crossing Minimization ==
770 +== ==
690 690  
772 +{{id name="contentAlignment"/}}Content AlignmentDetermines how the content of compound nodes is to be aligned if the compound node's size exceeds the bounding box of the content (i.e. child nodes). This might be the case if for a compound node the size constraint of {{code language="none"}}MINIMUM_SIZE{{/code}} is set and the minimum width and height are set large enough.
691 691  
774 +{{note}}
775 +This option is not tested for external ports with port constraints {{code language="none"}}FIXED_RATIO{{/code}} or {{code language="none"}}FIXED_POS{{/code}}.
776 +{{/note}}
692 692  
693 -{{id name="crossingMinimization"/}}
778 +== ==
694 694  
695 -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:
780 +{{id name="crossingMinimization"/}}Crossing MinimizationCrossing 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:
696 696  
697 -* LAYER_SWEEP
782 +* {{code language="none"}}LAYER_SWEEP{{/code}}
698 698  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.
699 -* INTERACTIVE
784 +* {{code language="none"}}INTERACTIVE{{/code}}
700 700  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.
701 701  
702 -== Cycle Breaking ==
787 +== ==
703 703  
789 +{{id name="cycleBreaking"/}}Cycle BreakingKLay 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:
704 704  
791 +* {{code language="none"}}GREEDY{{/code}}
792 +This algorithm reverses edges greedily. The algorithm tries to avoid edges that have the //Priority// property set.
793 +* {{code language="none"}}INTERACTIVE{{/code}}
794 +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.
705 705  
706 -{{id name="cycleBreaking"/}}
796 +== ==
707 707  
708 -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:
798 +{{id name="direction"/}}DirectionThe layout direction influences where the majority of edges in the final layout will point to. With data flow diagrams, this will usually be to the right. With control flow diagrams, it might be downwards. The layout direction defaults to {{code language="none"}}UNDEFINED{{/code}}. This causes KLay Layered to calculate a layout direction based on the {{code language="none"}}ASPECT_RATIO{{/code}} setting. As of now, if the aspect ratio is >=1 (that is, if the diagram should be wider than it is high), the direction is set to {{code language="none"}}RIGHT{{/code}}. Otherwise, it is set to {{code language="none"}}DOWN{{/code}}.
709 709  
710 -* GREEDY
711 -This algorithm reverses edges greedily. The algorithm tries to avoid edges that have the //Priority// property set.
712 -* INTERACTIVE
713 -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.
800 +== ==
714 714  
715 -== Edge Spacing Factor ==
802 +{{id name="edgeSpacingFactor"/}}Edge Spacing FactorThe 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.
716 716  
804 +[[image:attach:edgeSpacingFactor.png]]
717 717  
806 +== ==
718 718  
719 -{{id name="edgeSpacingFactor"/}}
808 +{{id name="edgeLabelSideSelection"/}}Edge Label Side SelectionDetermines how KLay Layered places edge labels. The following strategies are available:
720 720  
721 -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.
810 +* {{code language="none"}}ALWAYS_UP{{/code}}
811 +Always places edge labels above the edge.
812 +* {{code language="none"}}ALWAYS_DOWN{{/code}}
813 +Always places edge labels below the edge.
814 +* {{code language="none"}}DIRECTION_UP{{/code}}
815 +Places edge labels above edges pointing right, and below edges pointing left.
816 +* {{code language="none"}}DIRECTION_DOWN{{/code}}
817 +Places edge labels below edges pointing right, and above edges pointing left.
818 +* {{code language="none"}}SMART{{/code}}
819 +Uses a heuristic that determines the best edge label placement, also taking the placement of port labels into account.
722 722  
723 -[[image:attach:edgeSpacingFactor.png]]
821 +== ==
724 724  
725 -== Interactive Reference Point ==
823 +{{id name="feedbackEdges"/}}Feedback EdgesFeedback edges are edges that feed the output of a node back to be the input of a previous node. This option controls how feedback edges are routed if port constraints are FREE. This influences how much emphasis is put on feedback edges.
726 726  
825 +With feedback edges:
727 727  
827 +[[image:attach:feedback_on.png]]
728 728  
729 -{{id name="interactiveReferencePoint"/}}
829 +Without feedback edges:
730 730  
731 -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:
831 +[[image:attach:feedback_off.png]]
732 732  
733 -* TOP_LEFT
833 +== ==
834 +
835 +{{id name="fixedAlignment"/}}Fixed AlignmentThe {{code language="none"}}BRANDES_KOEPF{{/code}} node placement algorithm computes several different node placements. One of the placements is chosen by the algorithm, usually the one that takes the least amount of space. With this option, a particular result can be chosen.
836 +
837 +This option should usually be left alone.
838 +
839 +== ==
840 +
841 +{{id name="interactiveReferencePoint"/}}Interactive Reference PointInteractive 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:
842 +
843 +* {{code language="none"}}TOP_LEFT{{/code}}
734 734  The top left corner of a node is taken as the reference point.
735 -* CENTER
845 +* {{code language="none"}}CENTER{{/code}}
736 736  The center of a node is taken as the reference point.
737 737  
738 -
848 +== ==
739 739  
740 -== Maximal Iterations ==
850 +{{id name="layerConstraint"/}}Layer ConstraintThe layer a node is placed in is usually computed by the layer assignment algorithms. However, sometimes certain nodes need to be placed in the first or in the last layer (for example, nodes that represent inputs from the outside). The layer constraint option can be set on such nodes to do just that.
741 741  
852 +[[image:attach:layer_constraints.png]]
742 742  
854 +{{note}}
855 +This option can also be set to {{code language="none"}}FIRST_SEPARATE{{/code}} and {{code language="none"}}LAST_SEPARATE{{/code}}. These are for internal use only and should not have been publicly exposed in the first place. Using them can result in layout problems.
856 +{{/note}}
743 743  
744 -{{id name="networkSimplexMaxIterations"/}}
858 +== ==
745 745  
746 -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.
860 +{{id name="deflectionDampening"/}}Linear Segments Deflection Dampening
747 747  
748 -== Thoroughness ==
862 +{{note}}
863 +This is a very advanced layout option that you normally shouldn't worry about.
864 +{{/note}}
749 749  
866 +The linear segments node placer can sometimes place nodes in a way that results in unnecessarily large diagrams. This option dampens how much the nodes are moved around. A dampening factor of 1.0 disables dampening and just lets the node placer do what it wants. A more conservative dampening factor of 0.3 (the default) restricts the freedom of the node placer a bit more.
750 750  
868 +== ==
751 751  
752 -{{id name="thoroughness"/}}
870 +{{id name="maximalIterations"/}}Maximal IterationsDelimits 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.
753 753  
754 -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.
872 +== ==
873 +
874 +{{id name="mergeEdges"/}}Merge EdgesIn the KGraph model, edges can either connect to nodes through ports or directly. In the latter case, KLay Layered will introduce a virtual port for each edge, which results in all edges connecting to the node at different points in the final drawing. If this option is switched on, KLay Layered will only generate up to one input and one output port for each node. The option is set on a parent node and applies to all of its children, but not to the parent node itself.
875 +
876 +[[image:attach:merging.png]]
877 +
878 +== ==
879 +
880 +{{id name="mergeHierarchyEdges"/}}Merge Hierarchy-Crossing EdgesIf hierarchical layout is active, this option is the hierarchical equivalent to //Merge Edges//. If set to true on a compound node, all hierarchy-crossing edges that start or end inside that compound node are eligible for merging.
881 +
882 +[[image:attach:merge_hierarchy_edges.png]]
883 +
884 +== ==
885 +
886 +{{id name="nodeLayering"/}}Node LayeringDecides which algorithm is used to compute the layer each node is placed in. We have different algorithms available, with different optimization goals:
887 +
888 +* {{code language="none"}}NETWORK_SIMPLEX{{/code}}
889 +This algorithm tries to minimize the length of edges. This is the most computationally intensive algorithm. The number of iterations after which it aborts if it hasn't found a result yet can be set with the [[Maximal Iterations>>doc:||anchor="maximalInterations"]] option.
890 +* {{code language="none"}}LONGEST_PATH{{/code}}
891 +A very simple algorithm that distributes nodes along their longest path to a sink node.
892 +* {{code language="none"}}INTERACTIVE{{/code}}
893 +Distributes the nodes into layers by comparing their positions before the layout algorithm was started. The idea is that the relative horizontal 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 node layering algorithm uses the //Interactive Reference Point// option to determine which reference point of nodes are used to compare positions.
894 +
895 +== ==
896 +
897 +{{id name="nodePlacement"/}}Node PlacementDecides which algorithm is used to compute the y coordinate of each node. This influences the length of edges, the number of edge bends, and the height of the diagram. We have different algorithms available, with different optimization goals:
898 +
899 +* {{code language="none"}}BRANDES_KOEPF{{/code}}
900 +Minimizes the number of edge bends at the expense of diagram size: diagrams drawn with this algorithm are usually higher than diagrams drawn with other algorithms.
901 +* {{code language="none"}}LINEAR_SEGMENTS{{/code}}
902 +Computes a balanced placement.
903 +* {{code language="none"}}INTERACTIVE{{/code}}
904 +Tries to keep the preset y coordinates of nodes from the original layout. For dummy nodes, a guess is made to infer their coordinates. Requires the other interactive phase implementations to have run as well.
905 +* {{code language="none"}}SIMPLE{{/code}}
906 +Minimizes the area at the expense of... well, pretty much everything else.
907 +
908 +== ==
909 +
910 +{{id name="thoroughness"/}}ThoroughnessThere 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.
edgeSpacingFactor.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +10.2 KB
Content
feedback_off.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +7.1 KB
Content
feedback_on.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +11.4 KB
Content
layer_constraints.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +17.5 KB
Content
merge_hierarchy_edges.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +102.1 KB
Content
merging.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +16.0 KB
Content
port_anchors.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +5.4 KB
Content
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470045
1 +7111098
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470045/KLay Layered Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/7111098/KLay Layered Layout Options

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage