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