Last modified by Richard Kreissig on 2023/09/14 10:20
<
From version < 11.1 >
edited by cds
on 2014/03/12 17:24
To version < 46.2 >
edited by Alexander Schulz-Rosengarten
on 2023/07/11 10:25
>
Change comment: Update document after refactoring.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +Kieler.Discontinued Projects.Layout Algorithms (KLay).KLay Layered.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cds
1 +XWiki.als
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.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.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
... ... @@ -163,8 +163,24 @@
163 163  (((
164 164  false
165 165  )))
177 +|(% colspan="1" %)(% colspan="1" %)
178 +(((
179 +Label Side
180 +)))|(% colspan="1" %)(% colspan="1" %)
181 +(((
182 +de.cau.cs.kieler.labelSide
183 +)))|(% colspan="1" %)(% colspan="1" %)
184 +(((
185 +Enum
186 +)))|(% colspan="1" %)(% colspan="1" %)
187 +(((
188 +Parents
189 +)))|(% colspan="1" %)(% colspan="1" %)
190 +(((
191 +SMART
192 +)))
166 166  |(((
167 -Label Spacing XX
194 +Label Spacing
168 168  )))|(((
169 169  de.cau.cs.kieler.labelSpacing
170 170  )))|(((
... ... @@ -188,7 +188,7 @@
188 188  )))
189 189  |(% colspan="1" %)(% colspan="1" %)
190 190  (((
191 -Minimal Height XX
218 +Minimal Height
192 192  )))|(% colspan="1" %)(% colspan="1" %)
193 193  (((
194 194  de.cau.cs.kieler.minHeight
... ... @@ -205,7 +205,7 @@
205 205  )))
206 206  |(% colspan="1" %)(% colspan="1" %)
207 207  (((
208 -Minimal Width XX
235 +Minimal Width
209 209  )))|(% colspan="1" %)(% colspan="1" %)
210 210  (((
211 211  de.cau.cs.kieler.minWidth
... ... @@ -222,7 +222,7 @@
222 222  )))
223 223  |(% colspan="1" %)(% colspan="1" %)
224 224  (((
225 -No Layout XX
252 +No Layout
226 226  )))|(% colspan="1" %)(% colspan="1" %)
227 227  (((
228 228  de.cau.cs.kieler.noLayout
... ... @@ -252,6 +252,22 @@
252 252  (((
253 253  
254 254  )))
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 +)))
255 255  |(((
256 256  Port Constraints
257 257  )))|(((
... ... @@ -281,7 +281,7 @@
281 281  )))
282 282  |(% colspan="1" %)(% colspan="1" %)
283 283  (((
284 -Port Offset XX
327 +Port Offset
285 285  )))|(% colspan="1" %)(% colspan="1" %)
286 286  (((
287 287  de.cau.cs.kieler.offset
... ... @@ -297,7 +297,7 @@
297 297  )))
298 298  |(% colspan="1" %)(% colspan="1" %)
299 299  (((
300 -Port Side XX
343 +Port Side
301 301  )))|(% colspan="1" %)(% colspan="1" %)
302 302  (((
303 303  de.cau.cs.kieler.portSide
... ... @@ -311,6 +311,22 @@
311 311  (((
312 312  UNDEFINED
313 313  )))
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 +)))
314 314  |(((
315 315  Priority
316 316  )))|(((
... ... @@ -420,8 +420,46 @@
420 420  (((
421 421  Dependency
422 422  )))
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 +)))
423 423  |(((
424 -[[Crossing Minimization>>doc:||anchor="crossingMinimizat"]]
521 +[[Crossing Minimization>>doc:||anchor="crossingMinimization"]]
425 425  )))|(((
426 426  de.cau.cs.kieler.klay.layered.crossMin
427 427  )))|(((
... ... @@ -464,19 +464,19 @@
464 464  )))
465 465  |(% colspan="1" %)(% colspan="1" %)
466 466  (((
467 -Feedback Edges
564 +[[Edge Label Side Selection>>doc:||anchor="edgeLabelSideSelection"]]
468 468  )))|(% colspan="1" %)(% colspan="1" %)
469 469  (((
470 -de.cau.cs.kieler.klay.layered.feedBackEdges
567 +de.cau.cs.kieler.klay.layered.edgeLabelSideSelection
471 471  )))|(% colspan="1" %)(% colspan="1" %)
472 472  (((
473 -Boolean
570 +Enum
474 474  )))|(% colspan="1" %)(% colspan="1" %)
475 475  (((
476 476  Parents
477 477  )))|(% colspan="1" %)(% colspan="1" %)
478 478  (((
479 -false
576 +ALWAYS_DOWN
480 480  )))|(% colspan="1" %)(% colspan="1" %)
481 481  (((
482 482  
... ... @@ -483,19 +483,19 @@
483 483  )))
484 484  |(% colspan="1" %)(% colspan="1" %)
485 485  (((
486 -Fixed Alignment
583 +[[Feedback Edges>>doc:||anchor="feedbackEdges"]]
487 487  )))|(% colspan="1" %)(% colspan="1" %)
488 488  (((
489 -de.cau.cs.kieler.klay.layered.fixedAlignment
586 +de.cau.cs.kieler.klay.layered.feedBackEdges
490 490  )))|(% colspan="1" %)(% colspan="1" %)
491 491  (((
492 -Enum
589 +Boolean
493 493  )))|(% colspan="1" %)(% colspan="1" %)
494 494  (((
495 495  Parents
496 496  )))|(% colspan="1" %)(% colspan="1" %)
497 497  (((
498 -NONE
595 +false
499 499  )))|(% colspan="1" %)(% colspan="1" %)
500 500  (((
501 501  
... ... @@ -502,10 +502,10 @@
502 502  )))
503 503  |(% colspan="1" %)(% colspan="1" %)
504 504  (((
505 -[[Interactive Reference Point>>doc:||anchor="interactiveReferencePoi"]]
602 +[[Fixed Alignment>>doc:||anchor="fixedAlignment"]]
506 506  )))|(% colspan="1" %)(% colspan="1" %)
507 507  (((
508 -de.cau.cs.kieler.klay.layered.interactiveReferencePoint
605 +de.cau.cs.kieler.klay.layered.fixedAlignment
509 509  )))|(% colspan="1" %)(% colspan="1" %)
510 510  (((
511 511  Enum
... ... @@ -514,17 +514,17 @@
514 514  Parents
515 515  )))|(% colspan="1" %)(% colspan="1" %)
516 516  (((
517 -CENTER
614 +NONE
518 518  )))|(% colspan="1" %)(% colspan="1" %)
519 519  (((
520 -
617 +nodePlace=BRANDES_KOEPF
521 521  )))
522 522  |(% colspan="1" %)(% colspan="1" %)
523 523  (((
524 -Label Side
621 +[[Interactive Reference Point>>doc:||anchor="interactiveReferencePoint"]]
525 525  )))|(% colspan="1" %)(% colspan="1" %)
526 526  (((
527 -de.cau.cs.kieler.klay.layered.LabelSide
624 +de.cau.cs.kieler.klay.layered.interactiveReferencePoint
528 528  )))|(% colspan="1" %)(% colspan="1" %)
529 529  (((
530 530  Enum
... ... @@ -533,7 +533,7 @@
533 533  Parents
534 534  )))|(% colspan="1" %)(% colspan="1" %)
535 535  (((
536 -SMART
633 +CENTER
537 537  )))|(% colspan="1" %)(% colspan="1" %)
538 538  (((
539 539  
... ... @@ -540,7 +540,7 @@
540 540  )))
541 541  |(% colspan="1" %)(% colspan="1" %)
542 542  (((
543 -Layer Constraint
640 +[[Layer Constraint>>doc:||anchor="layerConstraint"]]
544 544  )))|(% colspan="1" %)(% colspan="1" %)
545 545  (((
546 546  de.cau.cs.kieler.klay.layered.layerConstraint
... ... @@ -559,29 +559,29 @@
559 559  )))
560 560  |(% colspan="1" %)(% colspan="1" %)
561 561  (((
562 -Maximal Iterations
659 +[[Linear Segments Deflection Dampening>>doc:||anchor="deflectionDampening"]]
563 563  )))|(% colspan="1" %)(% colspan="1" %)
564 564  (((
565 -de.cau.cs.kieler.klay.layered.nodeLayering
662 +de.cau.cs.kieler.klay.layered.linearSegmentsDeflectionDampening
566 566  )))|(% colspan="1" %)(% colspan="1" %)
567 567  (((
568 -Int
665 +Float
569 569  )))|(% colspan="1" %)(% colspan="1" %)
570 570  (((
571 571  Parents
572 572  )))|(% colspan="1" %)(% colspan="1" %)
573 573  (((
574 -10.000.000
671 +0.3
575 575  )))|(% colspan="1" %)(% colspan="1" %)
576 576  (((
577 -nodeLayering=NETWORK_SIMPLEX
674 +nodePlace=LINEAR_SEGMENTS
578 578  )))
579 579  |(% colspan="1" %)(% colspan="1" %)
580 580  (((
581 -Merge Edges
678 +[[Merge Edges>>doc:||anchor="mergeEdges"]]
582 582  )))|(% colspan="1" %)(% colspan="1" %)
583 583  (((
584 -de.cau.cs.kieler.klay.layered.mergePorts
681 +de.cau.cs.kieler.klay.layered.mergeEdges
585 585  )))|(% colspan="1" %)(% colspan="1" %)
586 586  (((
587 587  Boolean
... ... @@ -597,7 +597,7 @@
597 597  )))
598 598  |(% colspan="1" %)(% colspan="1" %)
599 599  (((
600 -Merge Hierarchy-crossing Edges
697 +[[Merge Hierarchy-Crossing Edges>>doc:||anchor="mergeHierarchyEdges"]]
601 601  )))|(% colspan="1" %)(% colspan="1" %)
602 602  (((
603 603  de.cau.cs.kieler.klay.layered.mergeHierarchyPorts
... ... @@ -612,10 +612,10 @@
612 612  true
613 613  )))|(% colspan="1" %)(% colspan="1" %)
614 614  (((
615 -
712 +layoutHierarchy=true
616 616  )))
617 617  |(((
618 -Node Layering
715 +[[Node Layering>>doc:||anchor="nodeLayering"]]
619 619  )))|(((
620 620  de.cau.cs.kieler.klay.layered.nodeLayering
621 621  )))|(((
... ... @@ -630,7 +630,7 @@
630 630  )))
631 631  |(% colspan="1" %)(% colspan="1" %)
632 632  (((
633 -Node Placement
730 +[[Node Placement>>doc:||anchor="nodePlacement"]]
634 634  )))|(% colspan="1" %)(% colspan="1" %)
635 635  (((
636 636  de.cau.cs.kieler.klay.layered.nodePlace
... ... @@ -647,27 +647,8 @@
647 647  (((
648 648  
649 649  )))
650 -|(% colspan="1" %)(% colspan="1" %)
651 -(((
652 -Port Anchor Offset
653 -)))|(% colspan="1" %)(% colspan="1" %)
654 -(((
655 -de.cau.cs.kieler.klay.layered.portAnchor
656 -)))|(% colspan="1" %)(% colspan="1" %)
657 -(((
658 -Object
659 -)))|(% colspan="1" %)(% colspan="1" %)
660 -(((
661 -Ports
662 -)))|(% colspan="1" %)(% colspan="1" %)
663 -(((
664 -
665 -)))|(% colspan="1" %)(% colspan="1" %)
666 -(((
667 -
668 -)))
669 669  |(((
670 -[[Thoroughness>>doc:||anchor="thorough"]]
748 +[[Thoroughness>>doc:||anchor="thoroughness"]]
671 671  )))|(((
672 672  de.cau.cs.kieler.klay.layered.thoroughness
673 673  )))|(((
... ... @@ -675,83 +675,158 @@
675 675  )))|(((
676 676  Parents
677 677  )))|(((
678 -7
756 +10
679 679  )))|(% colspan="1" %)(% colspan="1" %)
680 680  (((
681 681  
682 682  )))
683 683  
684 -= The Most Important Options =
762 += Detailed Documentation =
685 685  
686 -**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.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.
687 687  
688 -= Detailed Documentation =
766 +== ==
689 689  
690 -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.
691 691  
692 -== Crossing Minimization ==
770 +== ==
693 693  
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.
694 694  
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}}
695 695  
696 -{{id name="crossingMinimization"/}}
778 +== ==
697 697  
698 -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:
699 699  
700 -* LAYER_SWEEP
782 +* {{code language="none"}}LAYER_SWEEP{{/code}}
701 701  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.
702 -* INTERACTIVE
784 +* {{code language="none"}}INTERACTIVE{{/code}}
703 703  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.
704 704  
705 -== Cycle Breaking ==
787 +== ==
706 706  
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:
707 707  
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.
708 708  
709 -{{id name="cycleBreaking"/}}
796 +== ==
710 710  
711 -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}}.
712 712  
713 -* GREEDY
714 -This algorithm reverses edges greedily. The algorithm tries to avoid edges that have the //Priority// property set.
715 -* INTERACTIVE
716 -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 +== ==
717 717  
718 -== 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.
719 719  
804 +[[image:attach:edgeSpacingFactor.png]]
720 720  
806 +== ==
721 721  
722 -{{id name="edgeSpacingFactor"/}}
808 +{{id name="edgeLabelSideSelection"/}}Edge Label Side SelectionDetermines how KLay Layered places edge labels. The following strategies are available:
723 723  
724 -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.
725 725  
726 -[[image:attach:edgeSpacingFactor.png]]
821 +== ==
727 727  
728 -== 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.
729 729  
825 +With feedback edges:
730 730  
827 +[[image:attach:feedback_on.png]]
731 731  
732 -{{id name="interactiveReferencePoint"/}}
829 +Without feedback edges:
733 733  
734 -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]]
735 735  
736 -* 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}}
737 737  The top left corner of a node is taken as the reference point.
738 -* CENTER
845 +* {{code language="none"}}CENTER{{/code}}
739 739  The center of a node is taken as the reference point.
740 740  
741 -
848 +== ==
742 742  
743 -== 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.
744 744  
852 +[[image:attach:layer_constraints.png]]
745 745  
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}}
746 746  
747 -{{id name="networkSimplexMaxIterations"/}}
858 +== ==
748 748  
749 -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
750 750  
751 -== Thoroughness ==
862 +{{note}}
863 +This is a very advanced layout option that you normally shouldn't worry about.
864 +{{/note}}
752 752  
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.
753 753  
868 +== ==
754 754  
755 -{{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.
756 756  
757 -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 -9470044
1 +7111098
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470044/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