Last modified by Richard Kreissig on 2023/09/14 10:20
<
From version < 20.1 >
edited by cds
on 2014/04/03 13:41
To version < 39.1 >
edited by cds
on 2015/02/18 15:16
>
Change comment: There is no comment for this version

Summary

Details

Page properties
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**
... ... @@ -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  )))|(((
... ... @@ -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,9 +115,8 @@
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  (((
... ... @@ -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  )))|(((
... ... @@ -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,6 +436,44 @@
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 440  [[Crossing Minimization>>doc:||anchor="crossingMinimization"]]
441 441  )))|(((
... ... @@ -575,22 +575,22 @@
575 575  )))
576 576  |(% colspan="1" %)(% colspan="1" %)
577 577  (((
578 -[[Maximal Iterations>>doc:||anchor="maximalIterations"]]
659 +[[Linear Segments Deflection Dampening>>doc:||anchor="deflectionDampening"]]
579 579  )))|(% colspan="1" %)(% colspan="1" %)
580 580  (((
581 -de.cau.cs.kieler.klay.layered.nodeLayering
662 +de.cau.cs.kieler.klay.layered.linearSegmentsDeflectionDampening
582 582  )))|(% colspan="1" %)(% colspan="1" %)
583 583  (((
584 -Int
665 +Float
585 585  )))|(% colspan="1" %)(% colspan="1" %)
586 586  (((
587 587  Parents
588 588  )))|(% colspan="1" %)(% colspan="1" %)
589 589  (((
590 -10.000.000
671 +0.3
591 591  )))|(% colspan="1" %)(% colspan="1" %)
592 592  (((
593 -nodeLayering=NETWORK_SIMPLEX
674 +nodePlace=LINEAR_SEGMENTS
594 594  )))
595 595  |(% colspan="1" %)(% colspan="1" %)
596 596  (((
... ... @@ -597,7 +597,7 @@
597 597  [[Merge Edges>>doc:||anchor="mergeEdges"]]
598 598  )))|(% colspan="1" %)(% colspan="1" %)
599 599  (((
600 -de.cau.cs.kieler.klay.layered.mergePorts
681 +de.cau.cs.kieler.klay.layered.mergeEdges
601 601  )))|(% colspan="1" %)(% colspan="1" %)
602 602  (((
603 603  Boolean
... ... @@ -663,25 +663,6 @@
663 663  (((
664 664  
665 665  )))
666 -|(% colspan="1" %)(% colspan="1" %)
667 -(((
668 -[[Port Anchor Offset>>doc:||anchor="portAnchor"]]
669 -)))|(% colspan="1" %)(% colspan="1" %)
670 -(((
671 -de.cau.cs.kieler.klay.layered.portAnchor
672 -)))|(% colspan="1" %)(% colspan="1" %)
673 -(((
674 -Object
675 -)))|(% colspan="1" %)(% colspan="1" %)
676 -(((
677 -Ports
678 -)))|(% colspan="1" %)(% colspan="1" %)
679 -(((
680 -
681 -)))|(% colspan="1" %)(% colspan="1" %)
682 -(((
683 -
684 -)))
685 685  |(((
686 686  [[Thoroughness>>doc:||anchor="thoroughness"]]
687 687  )))|(((
... ... @@ -697,20 +697,34 @@
697 697  
698 698  )))
699 699  
700 -= The Most Important Options =
701 -
702 -**TODO:** Write a bit of documentation about the most important layout options and how to use them, possibly with a simple example or something.
703 -
704 704  = Detailed Documentation =
705 705  
706 706  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.
707 707  
708 -== Crossing Minimization ==
766 +== ==
709 709  
768 +{{id name="addUnnecessaryBendpoints"/}}Add Unnecessary Bendpoints
710 710  
770 +By 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.
711 711  
772 +== Content Alignment ==
773 +
774 +{{id name="contentAlignment"/}}
775 +
776 +
777 +
778 +Determines 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.
779 +
780 +{{note}}
781 +This option is not tested for external ports with port constraints {{code language="none"}}FIXED_RATIO{{/code}} or {{code language="none"}}FIXED_POS{{/code}}.
782 +{{/note}}
783 +
784 +== Crossing Minimization ==
785 +
712 712  {{id name="crossingMinimization"/}}
713 713  
788 +
789 +
714 714  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:
715 715  
716 716  * LAYER_SWEEP
... ... @@ -720,10 +720,10 @@
720 720  
721 721  == Cycle Breaking ==
722 722  
723 -
724 -
725 725  {{id name="cycleBreaking"/}}
726 726  
801 +
802 +
727 727  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:
728 728  
729 729  * GREEDY
... ... @@ -731,12 +731,20 @@
731 731  * INTERACTIVE
732 732  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.
733 733  
734 -== Edge Spacing Factor ==
810 +== Direction ==
735 735  
812 +{{id name="direction"/}}
736 736  
814 +
737 737  
816 +The 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}}.
817 +
818 +== Edge Spacing Factor ==
819 +
738 738  {{id name="edgeSpacingFactor"/}}
739 739  
822 +
823 +
740 740  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.
741 741  
742 742  [[image:attach:edgeSpacingFactor.png]]
... ... @@ -743,32 +743,45 @@
743 743  
744 744  == Edge Label Side Selection ==
745 745  
746 -
747 -
748 748  {{id name="edgeLabelSideSelection"/}}
749 749  
750 -{{warning}}
751 -Document!
752 -{{/warning}}
753 -
754 754  
755 755  
756 -== Feedback Edges ==
834 +Determines how KLay Layered places edge labels. The following strategies are available:
757 757  
836 +* ALWAYS_UP
837 +Always places edge labels above the edge.
838 +* ALWAYS_DOWN
839 +Always places edge labels below the edge.
840 +* DIRECTION_UP
841 +Places edge labels above edges pointing right, and below edges pointing left.
842 +* DIRECTION_DOWN
843 +Places edge labels below edges pointing right, and above edges pointing left.
844 +* SMART
845 +Uses a heuristic that determines the best edge label placement, also taking the placement of port labels into account.
758 758  
847 +== Feedback Edges ==
759 759  
760 760  {{id name="feedbackEdges"/}}
761 761  
762 -{{warning}}
763 -Document!
764 -{{/warning}}
851 +
765 765  
766 -== Fixed Alignment ==
853 +Feedback 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.
767 767  
855 +With feedback edges:
768 768  
857 +[[image:attach:feedback_on.png]]
769 769  
859 +Without feedback edges:
860 +
861 +[[image:attach:feedback_off.png]]
862 +
863 +== Fixed Alignment ==
864 +
770 770  {{id name="fixedAlignment"/}}
771 771  
867 +
868 +
772 772  The BRANDES_KOEPF 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.
773 773  
774 774  This option should usually be left alone.
... ... @@ -775,10 +775,10 @@
775 775  
776 776  == Interactive Reference Point ==
777 777  
778 -
779 -
780 780  {{id name="interactiveReferencePoint"/}}
781 781  
877 +
878 +
782 782  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:
783 783  
784 784  * TOP_LEFT
... ... @@ -788,30 +788,44 @@
788 788  
789 789  == Layer Constraint ==
790 790  
888 +{{id name="layerConstraint"/}}
791 791  
890 +
792 792  
793 -{{id name="layerConstraint"/}}
892 +The 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.
794 794  
795 -{{warning}}
796 -Document!
797 -{{/warning}}
894 +[[image:attach:layer_constraints.png]]
798 798  
896 +{{note}}
897 +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.
898 +{{/note}}
899 +
900 +== Linear Segments Deflection Dampening ==
901 +
902 +{{id name="deflectionDampening"/}}
903 +
799 799  
800 800  
801 -== Maximal Iterations ==
906 +{{note}}
907 +This is a very advanced layout option that you normally shouldn't worry about.
908 +{{/note}}
802 802  
910 +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.
803 803  
912 +== Maximal Iterations ==
804 804  
805 805  {{id name="maximalIterations"/}}
806 806  
916 +
917 +
807 807  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.
808 808  
809 809  == Merge Edges ==
810 810  
811 -
812 -
813 813  {{id name="mergeEdges"/}}
814 814  
924 +
925 +
815 815  In 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.
816 816  
817 817  [[image:attach:merging.png]]
... ... @@ -818,20 +818,20 @@
818 818  
819 819  == Merge Hierarchy-Crossing Edges ==
820 820  
932 +{{id name="mergeHierarchyEdges"/}}
821 821  
934 +
822 822  
823 -{{id name="mergeHierarchyEdges"/}}
936 +If 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.
824 824  
825 -{{warning}}
826 -Document!
827 -{{/warning}}
938 +[[image:attach:merge_hierarchy_edges.png]]
828 828  
829 829  == Node Layering ==
830 830  
831 -
832 -
833 833  {{id name="nodeLayering"/}}
834 834  
944 +
945 +
835 835  Decides which algorithm is used to compute the layer each node is placed in. We have different algorithms available, with different optimization goals:
836 836  
837 837  * NETWORK_SIMPLEX
... ... @@ -843,30 +843,27 @@
843 843  
844 844  == Node Placement ==
845 845  
846 -
847 -
848 848  {{id name="nodePlacement"/}}
849 849  
850 -{{warning}}
851 -Document!
852 -{{/warning}}
959 +
853 853  
854 -== Port Anchor Offset ==
961 +Decides 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:
855 855  
963 +* {{code language="none"}}BRANDES_KOEPF{{/code}}
964 +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.
965 +* {{code language="none"}}LINEAR_SEGMENTS{{/code}}
966 +Computes a balanced placement.
967 +* {{code language="none"}}BUCHHEIM_JUENGER_LEIPERT{{/code}}
968 +Also computes a balanced placement, but a little faster.
969 +* {{code language="none"}}INTERACTIVE{{/code}}
970 +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.
971 +* {{code language="none"}}SIMPLE{{/code}}
972 +Minimizes the area at the expense of... well, pretty much everything else.
856 856  
857 -
858 -{{id name="portAnchor"/}}
859 -
860 -{{warning}}
861 -Document!
862 -{{/warning}}
863 -
864 -
865 -
866 866  == Thoroughness ==
867 867  
868 -
869 -
870 870  {{id name="thoroughness"/}}
871 871  
978 +
979 +
872 872  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 -9470134
1 +10751227
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470134/KLay Layered Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751227/KLay Layered Layout Options

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage