Last modified by Richard Kreissig on 2023/09/14 10:20
<
From version < 16.1 >
edited by cds
on 2014/03/14 15:09
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  )))|(((
... ... @@ -480,6 +480,25 @@
480 480  )))
481 481  |(% colspan="1" %)(% colspan="1" %)
482 482  (((
564 +[[Edge Label Side Selection>>doc:||anchor="edgeLabelSideSelection"]]
565 +)))|(% colspan="1" %)(% colspan="1" %)
566 +(((
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 +SMART
577 +)))|(% colspan="1" %)(% colspan="1" %)
578 +(((
579 +
580 +)))
581 +|(% colspan="1" %)(% colspan="1" %)
582 +(((
483 483  [[Feedback Edges>>doc:||anchor="feedbackEdges"]]
484 484  )))|(% colspan="1" %)(% colspan="1" %)
485 485  (((
... ... @@ -556,22 +556,22 @@
556 556  )))
557 557  |(% colspan="1" %)(% colspan="1" %)
558 558  (((
559 -[[Maximal Iterations>>doc:||anchor="maximalIterations"]]
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,7 +578,7 @@
578 578  [[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
... ... @@ -609,7 +609,7 @@
609 609  true
610 610  )))|(% colspan="1" %)(% colspan="1" %)
611 611  (((
612 -
712 +layoutHierarchy=true
613 613  )))
614 614  |(((
615 615  [[Node Layering>>doc:||anchor="nodeLayering"]]
... ... @@ -644,25 +644,6 @@
644 644  (((
645 645  
646 646  )))
647 -|(% colspan="1" %)(% colspan="1" %)
648 -(((
649 -[[Port Anchor Offset>>doc:||anchor="portAnchor"]]
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 667  [[Thoroughness>>doc:||anchor="thoroughness"]]
668 668  )))|(((
... ... @@ -678,20 +678,34 @@
678 678  
679 679  )))
680 680  
681 -= The Most Important Options =
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.
684 -
685 685  = Detailed Documentation =
686 686  
687 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.
688 688  
689 -== Crossing Minimization ==
766 +== ==
690 690  
768 +{{id name="addUnnecessaryBendpoints"/}}Add Unnecessary Bendpoints
691 691  
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.
692 692  
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 +
693 693  {{id name="crossingMinimization"/}}
694 694  
788 +
789 +
695 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:
696 696  
697 697  * LAYER_SWEEP
... ... @@ -701,10 +701,10 @@
701 701  
702 702  == Cycle Breaking ==
703 703  
704 -
705 -
706 706  {{id name="cycleBreaking"/}}
707 707  
801 +
802 +
708 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:
709 709  
710 710  * GREEDY
... ... @@ -712,44 +712,75 @@
712 712  * INTERACTIVE
713 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.
714 714  
715 -== Edge Spacing Factor ==
810 +== Direction ==
716 716  
812 +{{id name="direction"/}}
717 717  
814 +
718 718  
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 +
719 719  {{id name="edgeSpacingFactor"/}}
720 720  
822 +
823 +
721 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.
722 722  
723 723  [[image:attach:edgeSpacingFactor.png]]
724 724  
725 -== Feedback Edges ==
828 +== Edge Label Side Selection ==
726 726  
830 +{{id name="edgeLabelSideSelection"/}}
727 727  
832 +
728 728  
834 +Determines how KLay Layered places edge labels. The following strategies are available:
835 +
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.
846 +
847 +== Feedback Edges ==
848 +
729 729  {{id name="feedbackEdges"/}}
730 730  
731 -{{warning}}
732 -Document!
733 -{{/warning}}
851 +
734 734  
735 -== 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.
736 736  
855 +With feedback edges:
737 737  
857 +[[image:attach:feedback_on.png]]
738 738  
739 -{{id name="fixedAlignment"/}}
859 +Without feedback edges:
740 740  
741 -{{warning}}
742 -Document!
743 -{{/warning}}
861 +[[image:attach:feedback_off.png]]
744 744  
863 +== Fixed Alignment ==
864 +
865 +{{id name="fixedAlignment"/}}
866 +
745 745  
746 746  
747 -== Interactive Reference Point ==
869 +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.
748 748  
871 +This option should usually be left alone.
749 749  
873 +== Interactive Reference Point ==
750 750  
751 751  {{id name="interactiveReferencePoint"/}}
752 752  
877 +
878 +
753 753  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:
754 754  
755 755  * TOP_LEFT
... ... @@ -759,30 +759,44 @@
759 759  
760 760  == Layer Constraint ==
761 761  
888 +{{id name="layerConstraint"/}}
762 762  
890 +
763 763  
764 -{{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.
765 765  
766 -{{warning}}
767 -Document!
768 -{{/warning}}
894 +[[image:attach:layer_constraints.png]]
769 769  
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 +
770 770  
771 771  
772 -== Maximal Iterations ==
906 +{{note}}
907 +This is a very advanced layout option that you normally shouldn't worry about.
908 +{{/note}}
773 773  
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.
774 774  
912 +== Maximal Iterations ==
775 775  
776 776  {{id name="maximalIterations"/}}
777 777  
916 +
917 +
778 778  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.
779 779  
780 780  == Merge Edges ==
781 781  
782 -
783 -
784 784  {{id name="mergeEdges"/}}
785 785  
924 +
925 +
786 786  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.
787 787  
788 788  [[image:attach:merging.png]]
... ... @@ -789,50 +789,52 @@
789 789  
790 790  == Merge Hierarchy-Crossing Edges ==
791 791  
932 +{{id name="mergeHierarchyEdges"/}}
792 792  
934 +
793 793  
794 -{{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.
795 795  
796 -{{warning}}
797 -Document!
798 -{{/warning}}
938 +[[image:attach:merge_hierarchy_edges.png]]
799 799  
800 800  == Node Layering ==
801 801  
942 +{{id name="nodeLayering"/}}
802 802  
944 +
803 803  
804 -{{id name="nodeLayering"/}}
946 +Decides which algorithm is used to compute the layer each node is placed in. We have different algorithms available, with different optimization goals:
805 805  
806 -{{warning}}
807 -Document!
808 -{{/warning}}
948 +* NETWORK_SIMPLEX
949 +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.
950 +* LONGEST_PATH
951 +A very simple algorithm that distributes nodes along their longest path to a sink node.
952 +* INTERACTIVE
953 +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.
809 809  
810 810  == Node Placement ==
811 811  
812 -
813 -
814 814  {{id name="nodePlacement"/}}
815 815  
816 -{{warning}}
817 -Document!
818 -{{/warning}}
959 +
819 819  
820 -== 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:
821 821  
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.
822 822  
823 -
824 -{{id name="portAnchor"/}}
825 -
826 -{{warning}}
827 -Document!
828 -{{/warning}}
829 -
830 -
831 -
832 832  == Thoroughness ==
833 833  
834 -
835 -
836 836  {{id name="thoroughness"/}}
837 837  
978 +
979 +
838 838  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 -9470053
1 +10751227
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470053/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