Last modified by Richard Kreissig on 2023/09/14 10:20
<
From version < 28.1 >
edited by cds
on 2014/04/15 10:57
To version < 38.1 >
edited by cds
on 2015/02/18 15:15
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -120,7 +120,7 @@
120 120  
121 121  )))
122 122  |(((
123 -Direction
123 +[[Direction>>doc:||anchor="direction"]]
124 124  )))|(((
125 125  de.cau.cs.kieler.direction
126 126  )))|(((
... ... @@ -127,9 +127,8 @@
127 127  Enum
128 128  )))|(((
129 129  Parents
130 -)))|(% class="highlight-yellow" data-highlight-colour="yellow" %)(% class="highlight-yellow" data-highlight-colour="yellow" %)
131 -(((
132 -RIGHT
130 +)))|(((
131 +UNDEFINED
133 133  )))
134 134  |(% colspan="1" %)(% colspan="1" %)
135 135  (((
... ... @@ -280,6 +280,22 @@
280 280  (((
281 281  
282 282  )))
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 +)))
283 283  |(((
284 284  Port Constraints
285 285  )))|(((
... ... @@ -351,9 +351,9 @@
351 351  )))|(% colspan="1" %)(% colspan="1" %)
352 352  (((
353 353  Nodes
354 -)))|(% colspan="1" %)(% colspan="1" %)
369 +)))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
355 355  (((
356 -
371 +10
357 357  )))
358 358  |(((
359 359  Priority
... ... @@ -464,6 +464,44 @@
464 464  (((
465 465  Dependency
466 466  )))
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 +)))
467 467  |(((
468 468  [[Crossing Minimization>>doc:||anchor="crossingMinimization"]]
469 469  )))|(((
... ... @@ -603,22 +603,22 @@
603 603  )))
604 604  |(% colspan="1" %)(% colspan="1" %)
605 605  (((
606 -[[Maximal Iterations>>doc:||anchor="maximalIterations"]]
659 +[[Linear Segments Deflection Dampening>>doc:||anchor="deflectionDampening"]]
607 607  )))|(% colspan="1" %)(% colspan="1" %)
608 608  (((
609 -de.cau.cs.kieler.klay.layered.nodeLayering
662 +de.cau.cs.kieler.klay.layered.linearSegmentsDeflectionDampening
610 610  )))|(% colspan="1" %)(% colspan="1" %)
611 611  (((
612 -Int
665 +Float
613 613  )))|(% colspan="1" %)(% colspan="1" %)
614 614  (((
615 615  Parents
616 616  )))|(% colspan="1" %)(% colspan="1" %)
617 617  (((
618 -10.000.000
671 +0.3
619 619  )))|(% colspan="1" %)(% colspan="1" %)
620 620  (((
621 -nodeLayering=NETWORK_SIMPLEX
674 +nodePlace=LINEAR_SEGMENTS
622 622  )))
623 623  |(% colspan="1" %)(% colspan="1" %)
624 624  (((
... ... @@ -625,7 +625,7 @@
625 625  [[Merge Edges>>doc:||anchor="mergeEdges"]]
626 626  )))|(% colspan="1" %)(% colspan="1" %)
627 627  (((
628 -de.cau.cs.kieler.klay.layered.mergePorts
681 +de.cau.cs.kieler.klay.layered.mergeEdges
629 629  )))|(% colspan="1" %)(% colspan="1" %)
630 630  (((
631 631  Boolean
... ... @@ -691,25 +691,6 @@
691 691  (((
692 692  
693 693  )))
694 -|(% colspan="1" %)(% colspan="1" %)
695 -(((
696 -[[Port Anchor Offset>>doc:||anchor="portAnchor"]]
697 -)))|(% colspan="1" %)(% colspan="1" %)
698 -(((
699 -de.cau.cs.kieler.klay.layered.portAnchor
700 -)))|(% colspan="1" %)(% colspan="1" %)
701 -(((
702 -Object
703 -)))|(% colspan="1" %)(% colspan="1" %)
704 -(((
705 -Ports
706 -)))|(% colspan="1" %)(% colspan="1" %)
707 -(((
708 -
709 -)))|(% colspan="1" %)(% colspan="1" %)
710 -(((
711 -
712 -)))
713 713  |(((
714 714  [[Thoroughness>>doc:||anchor="thoroughness"]]
715 715  )))|(((
... ... @@ -729,12 +729,32 @@
729 729  
730 730  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.
731 731  
732 -== Crossing Minimization ==
766 +== Add Unnecessary Bendpoints ==
733 733  
768 +{{id name="addUnnecessaryBendpoints"/}}
734 734  
770 +
735 735  
772 +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.
773 +
774 +== Content Alignment ==
775 +
776 +{{id name="contentAlignment"/}}
777 +
778 +
779 +
780 +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.
781 +
782 +{{note}}
783 +This option is not tested for external ports with port constraints {{code language="none"}}FIXED_RATIO{{/code}} or {{code language="none"}}FIXED_POS{{/code}}.
784 +{{/note}}
785 +
786 +== Crossing Minimization ==
787 +
736 736  {{id name="crossingMinimization"/}}
737 737  
790 +
791 +
738 738  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:
739 739  
740 740  * LAYER_SWEEP
... ... @@ -744,10 +744,10 @@
744 744  
745 745  == Cycle Breaking ==
746 746  
747 -
748 -
749 749  {{id name="cycleBreaking"/}}
750 750  
803 +
804 +
751 751  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:
752 752  
753 753  * GREEDY
... ... @@ -755,12 +755,20 @@
755 755  * INTERACTIVE
756 756  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.
757 757  
758 -== Edge Spacing Factor ==
812 +== Direction ==
759 759  
814 +{{id name="direction"/}}
760 760  
816 +
761 761  
818 +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}}.
819 +
820 +== Edge Spacing Factor ==
821 +
762 762  {{id name="edgeSpacingFactor"/}}
763 763  
824 +
825 +
764 764  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.
765 765  
766 766  [[image:attach:edgeSpacingFactor.png]]
... ... @@ -767,10 +767,10 @@
767 767  
768 768  == Edge Label Side Selection ==
769 769  
770 -
771 -
772 772  {{id name="edgeLabelSideSelection"/}}
773 773  
834 +
835 +
774 774  Determines how KLay Layered places edge labels. The following strategies are available:
775 775  
776 776  * ALWAYS_UP
... ... @@ -786,10 +786,10 @@
786 786  
787 787  == Feedback Edges ==
788 788  
789 -
790 -
791 791  {{id name="feedbackEdges"/}}
792 792  
853 +
854 +
793 793  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.
794 794  
795 795  With feedback edges:
... ... @@ -802,10 +802,10 @@
802 802  
803 803  == Fixed Alignment ==
804 804  
805 -
806 -
807 807  {{id name="fixedAlignment"/}}
808 808  
869 +
870 +
809 809  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.
810 810  
811 811  This option should usually be left alone.
... ... @@ -812,10 +812,10 @@
812 812  
813 813  == Interactive Reference Point ==
814 814  
815 -
816 -
817 817  {{id name="interactiveReferencePoint"/}}
818 818  
879 +
880 +
819 819  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:
820 820  
821 821  * TOP_LEFT
... ... @@ -825,10 +825,10 @@
825 825  
826 826  == Layer Constraint ==
827 827  
828 -
829 -
830 830  {{id name="layerConstraint"/}}
831 831  
892 +
893 +
832 832  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.
833 833  
834 834  [[image:attach:layer_constraints.png]]
... ... @@ -837,20 +837,32 @@
837 837  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.
838 838  {{/note}}
839 839  
840 -== Maximal Iterations ==
902 +== Linear Segments Deflection Dampening ==
841 841  
904 +{{id name="deflectionDampening"/}}
842 842  
906 +
843 843  
908 +{{note}}
909 +This is a very advanced layout option that you normally shouldn't worry about.
910 +{{/note}}
911 +
912 +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.
913 +
914 +== Maximal Iterations ==
915 +
844 844  {{id name="maximalIterations"/}}
845 845  
918 +
919 +
846 846  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.
847 847  
848 848  == Merge Edges ==
849 849  
850 -
851 -
852 852  {{id name="mergeEdges"/}}
853 853  
926 +
927 +
854 854  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.
855 855  
856 856  [[image:attach:merging.png]]
... ... @@ -857,10 +857,10 @@
857 857  
858 858  == Merge Hierarchy-Crossing Edges ==
859 859  
860 -
861 -
862 862  {{id name="mergeHierarchyEdges"/}}
863 863  
936 +
937 +
864 864  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.
865 865  
866 866  [[image:attach:merge_hierarchy_edges.png]]
... ... @@ -867,10 +867,10 @@
867 867  
868 868  == Node Layering ==
869 869  
870 -
871 -
872 872  {{id name="nodeLayering"/}}
873 873  
946 +
947 +
874 874  Decides which algorithm is used to compute the layer each node is placed in. We have different algorithms available, with different optimization goals:
875 875  
876 876  * NETWORK_SIMPLEX
... ... @@ -882,37 +882,27 @@
882 882  
883 883  == Node Placement ==
884 884  
885 -
886 -
887 887  {{id name="nodePlacement"/}}
888 888  
961 +
962 +
889 889  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:
890 890  
891 -* BRANDES_KOEPF
965 +* {{code language="none"}}BRANDES_KOEPF{{/code}}
892 892  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.
893 -* LINEAR_SEGMENTS
967 +* {{code language="none"}}LINEAR_SEGMENTS{{/code}}
894 894  Computes a balanced placement.
895 -* BUCHHEIM_JUENGER_LEIPERT
969 +* {{code language="none"}}BUCHHEIM_JUENGER_LEIPERT{{/code}}
896 896  Also computes a balanced placement, but a little faster.
897 -* SIMPLE
971 +* {{code language="none"}}INTERACTIVE{{/code}}
972 +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.
973 +* {{code language="none"}}SIMPLE{{/code}}
898 898  Minimizes the area at the expense of... well, pretty much everything else.
899 899  
900 -== Port Anchor Offset ==
901 -
902 -
903 -
904 -{{id name="portAnchor"/}}
905 -
906 -Since ports have a size, we need a concrete point inside the port that edges should start or end in. In KLay Layered, this is referred to as the //port anchor//. By default, the center of each port is used as its port anchor, but this behavior can be overridden by setting an explicit port anchor.
907 -
908 -In the following example, the port anchor of the left port was moved upwards, while the port anchor of the second port was moved downwards:
909 -
910 -[[image:attach:port_anchors.png]]
911 -
912 912  == Thoroughness ==
913 913  
914 -
915 -
916 916  {{id name="thoroughness"/}}
917 917  
980 +
981 +
918 918  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 -9470297
1 +10751225
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470297/KLay Layered Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751225/KLay Layered Layout Options

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage