Last modified by Richard Kreissig on 2023/09/14 10:20
<
From version < 29.1 >
edited by cds
on 2014/04/17 13:37
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
... ... @@ -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  )))|(((
... ... @@ -622,29 +622,10 @@
622 622  )))
623 623  |(% colspan="1" %)(% colspan="1" %)
624 624  (((
625 -[[Maximal Iterations>>doc:||anchor="maximalIterations"]]
626 -)))|(% colspan="1" %)(% colspan="1" %)
627 -(((
628 -de.cau.cs.kieler.klay.layered.nodeLayering
629 -)))|(% colspan="1" %)(% colspan="1" %)
630 -(((
631 -Int
632 -)))|(% colspan="1" %)(% colspan="1" %)
633 -(((
634 -Parents
635 -)))|(% colspan="1" %)(% colspan="1" %)
636 -(((
637 -10.000.000
638 -)))|(% colspan="1" %)(% colspan="1" %)
639 -(((
640 -nodeLayering=NETWORK_SIMPLEX
641 -)))
642 -|(% colspan="1" %)(% colspan="1" %)
643 -(((
644 644  [[Merge Edges>>doc:||anchor="mergeEdges"]]
645 645  )))|(% colspan="1" %)(% colspan="1" %)
646 646  (((
647 -de.cau.cs.kieler.klay.layered.mergePorts
681 +de.cau.cs.kieler.klay.layered.mergeEdges
648 648  )))|(% colspan="1" %)(% colspan="1" %)
649 649  (((
650 650  Boolean
... ... @@ -710,25 +710,6 @@
710 710  (((
711 711  
712 712  )))
713 -|(% colspan="1" %)(% colspan="1" %)
714 -(((
715 -[[Port Anchor Offset>>doc:||anchor="portAnchor"]]
716 -)))|(% colspan="1" %)(% colspan="1" %)
717 -(((
718 -de.cau.cs.kieler.klay.layered.portAnchor
719 -)))|(% colspan="1" %)(% colspan="1" %)
720 -(((
721 -Object
722 -)))|(% colspan="1" %)(% colspan="1" %)
723 -(((
724 -Ports
725 -)))|(% colspan="1" %)(% colspan="1" %)
726 -(((
727 -
728 -)))|(% colspan="1" %)(% colspan="1" %)
729 -(((
730 -
731 -)))
732 732  |(((
733 733  [[Thoroughness>>doc:||anchor="thoroughness"]]
734 734  )))|(((
... ... @@ -748,12 +748,30 @@
748 748  
749 749  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.
750 750  
751 -== Crossing Minimization ==
766 +== ==
752 752  
768 +{{id name="addUnnecessaryBendpoints"/}}Add Unnecessary Bendpoints
753 753  
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.
754 754  
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 +
755 755  {{id name="crossingMinimization"/}}
756 756  
788 +
789 +
757 757  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:
758 758  
759 759  * LAYER_SWEEP
... ... @@ -763,10 +763,10 @@
763 763  
764 764  == Cycle Breaking ==
765 765  
766 -
767 -
768 768  {{id name="cycleBreaking"/}}
769 769  
801 +
802 +
770 770  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:
771 771  
772 772  * GREEDY
... ... @@ -774,12 +774,20 @@
774 774  * INTERACTIVE
775 775  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.
776 776  
777 -== Edge Spacing Factor ==
810 +== Direction ==
778 778  
812 +{{id name="direction"/}}
779 779  
814 +
780 780  
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 +
781 781  {{id name="edgeSpacingFactor"/}}
782 782  
822 +
823 +
783 783  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.
784 784  
785 785  [[image:attach:edgeSpacingFactor.png]]
... ... @@ -786,10 +786,10 @@
786 786  
787 787  == Edge Label Side Selection ==
788 788  
789 -
790 -
791 791  {{id name="edgeLabelSideSelection"/}}
792 792  
832 +
833 +
793 793  Determines how KLay Layered places edge labels. The following strategies are available:
794 794  
795 795  * ALWAYS_UP
... ... @@ -805,10 +805,10 @@
805 805  
806 806  == Feedback Edges ==
807 807  
808 -
809 -
810 810  {{id name="feedbackEdges"/}}
811 811  
851 +
852 +
812 812  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.
813 813  
814 814  With feedback edges:
... ... @@ -821,10 +821,10 @@
821 821  
822 822  == Fixed Alignment ==
823 823  
824 -
825 -
826 826  {{id name="fixedAlignment"/}}
827 827  
867 +
868 +
828 828  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.
829 829  
830 830  This option should usually be left alone.
... ... @@ -831,10 +831,10 @@
831 831  
832 832  == Interactive Reference Point ==
833 833  
834 -
835 -
836 836  {{id name="interactiveReferencePoint"/}}
837 837  
877 +
878 +
838 838  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:
839 839  
840 840  * TOP_LEFT
... ... @@ -844,10 +844,10 @@
844 844  
845 845  == Layer Constraint ==
846 846  
847 -
848 -
849 849  {{id name="layerConstraint"/}}
850 850  
890 +
891 +
851 851  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.
852 852  
853 853  [[image:attach:layer_constraints.png]]
... ... @@ -858,10 +858,10 @@
858 858  
859 859  == Linear Segments Deflection Dampening ==
860 860  
861 -
862 -
863 863  {{id name="deflectionDampening"/}}
864 864  
904 +
905 +
865 865  {{note}}
866 866  This is a very advanced layout option that you normally shouldn't worry about.
867 867  {{/note}}
... ... @@ -870,18 +870,18 @@
870 870  
871 871  == Maximal Iterations ==
872 872  
873 -
874 -
875 875  {{id name="maximalIterations"/}}
876 876  
916 +
917 +
877 877  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.
878 878  
879 879  == Merge Edges ==
880 880  
881 -
882 -
883 883  {{id name="mergeEdges"/}}
884 884  
924 +
925 +
885 885  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.
886 886  
887 887  [[image:attach:merging.png]]
... ... @@ -888,10 +888,10 @@
888 888  
889 889  == Merge Hierarchy-Crossing Edges ==
890 890  
891 -
892 -
893 893  {{id name="mergeHierarchyEdges"/}}
894 894  
934 +
935 +
895 895  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.
896 896  
897 897  [[image:attach:merge_hierarchy_edges.png]]
... ... @@ -898,10 +898,10 @@
898 898  
899 899  == Node Layering ==
900 900  
901 -
902 -
903 903  {{id name="nodeLayering"/}}
904 904  
944 +
945 +
905 905  Decides which algorithm is used to compute the layer each node is placed in. We have different algorithms available, with different optimization goals:
906 906  
907 907  * NETWORK_SIMPLEX
... ... @@ -913,37 +913,27 @@
913 913  
914 914  == Node Placement ==
915 915  
916 -
917 -
918 918  {{id name="nodePlacement"/}}
919 919  
959 +
960 +
920 920  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:
921 921  
922 -* BRANDES_KOEPF
963 +* {{code language="none"}}BRANDES_KOEPF{{/code}}
923 923  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.
924 -* LINEAR_SEGMENTS
965 +* {{code language="none"}}LINEAR_SEGMENTS{{/code}}
925 925  Computes a balanced placement.
926 -* BUCHHEIM_JUENGER_LEIPERT
967 +* {{code language="none"}}BUCHHEIM_JUENGER_LEIPERT{{/code}}
927 927  Also computes a balanced placement, but a little faster.
928 -* SIMPLE
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}}
929 929  Minimizes the area at the expense of... well, pretty much everything else.
930 930  
931 -== Port Anchor Offset ==
932 -
933 -
934 -
935 -{{id name="portAnchor"/}}
936 -
937 -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.
938 -
939 -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:
940 -
941 -[[image:attach:port_anchors.png]]
942 -
943 943  == Thoroughness ==
944 944  
945 -
946 -
947 947  {{id name="thoroughness"/}}
948 948  
978 +
979 +
949 949  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 -9471754
1 +10751227
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9471754/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