Last modified by Richard Kreissig on 2023/09/14 10:20
<
From version < 34.1 >
edited by uru
on 2015/01/28 14:57
To version < 37.1 >
edited by uru
on 2015/01/28 15:52
>
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  )))|(((
... ... @@ -484,7 +484,7 @@
484 484  )))
485 485  |(% colspan="1" %)(% colspan="1" %)
486 486  (((
487 -(% class="confluence-link" %) Content Alignment[[doc:||anchor="contentAlignment"]]
503 +[[Content Alignment>>doc:||anchor="contentAlignment"]]
488 488  )))|(% colspan="1" %)(% colspan="1" %)
489 489  (((
490 490  de.cau.cs.kieler.klay.layered.contentAlignment
... ... @@ -659,25 +659,6 @@
659 659  )))
660 660  |(% colspan="1" %)(% colspan="1" %)
661 661  (((
662 -[[Maximal Iterations>>doc:||anchor="maximalIterations"]]
663 -)))|(% colspan="1" %)(% colspan="1" %)
664 -(((
665 -de.cau.cs.kieler.klay.layered.nodeLayering
666 -)))|(% colspan="1" %)(% colspan="1" %)
667 -(((
668 -Int
669 -)))|(% colspan="1" %)(% colspan="1" %)
670 -(((
671 -Parents
672 -)))|(% colspan="1" %)(% colspan="1" %)
673 -(((
674 -10.000.000
675 -)))|(% colspan="1" %)(% colspan="1" %)
676 -(((
677 -nodeLayering=NETWORK_SIMPLEX
678 -)))
679 -|(% colspan="1" %)(% colspan="1" %)
680 -(((
681 681  [[Merge Edges>>doc:||anchor="mergeEdges"]]
682 682  )))|(% colspan="1" %)(% colspan="1" %)
683 683  (((
... ... @@ -747,25 +747,6 @@
747 747  (((
748 748  
749 749  )))
750 -|(% colspan="1" %)(% colspan="1" %)
751 -(((
752 -[[Port Anchor Offset>>doc:||anchor="portAnchor"]]
753 -)))|(% colspan="1" %)(% colspan="1" %)
754 -(((
755 -de.cau.cs.kieler.klay.layered.portAnchor
756 -)))|(% colspan="1" %)(% colspan="1" %)
757 -(((
758 -Object
759 -)))|(% colspan="1" %)(% colspan="1" %)
760 -(((
761 -Ports
762 -)))|(% colspan="1" %)(% colspan="1" %)
763 -(((
764 -
765 -)))|(% colspan="1" %)(% colspan="1" %)
766 -(((
767 -
768 -)))
769 769  |(((
770 770  [[Thoroughness>>doc:||anchor="thoroughness"]]
771 771  )))|(((
... ... @@ -787,26 +787,30 @@
787 787  
788 788  == Add Unnecessary Bendpoints ==
789 789  
790 -
791 -
792 792  {{id name="addUnnecessaryBendpoints"/}}
793 793  
770 +
771 +
794 794  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.
795 795  
796 796  == Content Alignment ==
797 797  
776 +{{id name="contentAlignment"/}}
798 798  
778 +
799 799  
800 -{{id name="contentAlignment"/}}
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.
801 801  
802 -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. Please not that 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 +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}}
803 803  
804 804  == Crossing Minimization ==
805 805  
806 -
807 -
808 808  {{id name="crossingMinimization"/}}
809 809  
790 +
791 +
810 810  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:
811 811  
812 812  * LAYER_SWEEP
... ... @@ -816,10 +816,10 @@
816 816  
817 817  == Cycle Breaking ==
818 818  
819 -
820 -
821 821  {{id name="cycleBreaking"/}}
822 822  
803 +
804 +
823 823  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:
824 824  
825 825  * GREEDY
... ... @@ -829,18 +829,18 @@
829 829  
830 830  == Direction ==
831 831  
832 -
833 -
834 834  {{id name="direction"/}}
835 835  
816 +
817 +
836 836  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}}.
837 837  
838 838  == Edge Spacing Factor ==
839 839  
840 -
841 -
842 842  {{id name="edgeSpacingFactor"/}}
843 843  
824 +
825 +
844 844  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.
845 845  
846 846  [[image:attach:edgeSpacingFactor.png]]
... ... @@ -847,10 +847,10 @@
847 847  
848 848  == Edge Label Side Selection ==
849 849  
850 -
851 -
852 852  {{id name="edgeLabelSideSelection"/}}
853 853  
834 +
835 +
854 854  Determines how KLay Layered places edge labels. The following strategies are available:
855 855  
856 856  * ALWAYS_UP
... ... @@ -866,10 +866,10 @@
866 866  
867 867  == Feedback Edges ==
868 868  
869 -
870 -
871 871  {{id name="feedbackEdges"/}}
872 872  
853 +
854 +
873 873  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.
874 874  
875 875  With feedback edges:
... ... @@ -882,10 +882,10 @@
882 882  
883 883  == Fixed Alignment ==
884 884  
885 -
886 -
887 887  {{id name="fixedAlignment"/}}
888 888  
869 +
870 +
889 889  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.
890 890  
891 891  This option should usually be left alone.
... ... @@ -892,10 +892,10 @@
892 892  
893 893  == Interactive Reference Point ==
894 894  
895 -
896 -
897 897  {{id name="interactiveReferencePoint"/}}
898 898  
879 +
880 +
899 899  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:
900 900  
901 901  * TOP_LEFT
... ... @@ -905,10 +905,10 @@
905 905  
906 906  == Layer Constraint ==
907 907  
908 -
909 -
910 910  {{id name="layerConstraint"/}}
911 911  
892 +
893 +
912 912  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.
913 913  
914 914  [[image:attach:layer_constraints.png]]
... ... @@ -919,10 +919,10 @@
919 919  
920 920  == Linear Segments Deflection Dampening ==
921 921  
922 -
923 -
924 924  {{id name="deflectionDampening"/}}
925 925  
906 +
907 +
926 926  {{note}}
927 927  This is a very advanced layout option that you normally shouldn't worry about.
928 928  {{/note}}
... ... @@ -931,18 +931,18 @@
931 931  
932 932  == Maximal Iterations ==
933 933  
934 -
935 -
936 936  {{id name="maximalIterations"/}}
937 937  
918 +
919 +
938 938  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.
939 939  
940 940  == Merge Edges ==
941 941  
942 -
943 -
944 944  {{id name="mergeEdges"/}}
945 945  
926 +
927 +
946 946  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.
947 947  
948 948  [[image:attach:merging.png]]
... ... @@ -949,10 +949,10 @@
949 949  
950 950  == Merge Hierarchy-Crossing Edges ==
951 951  
952 -
953 -
954 954  {{id name="mergeHierarchyEdges"/}}
955 955  
936 +
937 +
956 956  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.
957 957  
958 958  [[image:attach:merge_hierarchy_edges.png]]
... ... @@ -959,10 +959,10 @@
959 959  
960 960  == Node Layering ==
961 961  
962 -
963 -
964 964  {{id name="nodeLayering"/}}
965 965  
946 +
947 +
966 966  Decides which algorithm is used to compute the layer each node is placed in. We have different algorithms available, with different optimization goals:
967 967  
968 968  * NETWORK_SIMPLEX
... ... @@ -974,10 +974,10 @@
974 974  
975 975  == Node Placement ==
976 976  
977 -
978 -
979 979  {{id name="nodePlacement"/}}
980 980  
961 +
962 +
981 981  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:
982 982  
983 983  * BRANDES_KOEPF
... ... @@ -989,22 +989,10 @@
989 989  * SIMPLE
990 990  Minimizes the area at the expense of... well, pretty much everything else.
991 991  
992 -== Port Anchor Offset ==
993 -
994 -
995 -
996 -{{id name="portAnchor"/}}
997 -
998 -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.
999 -
1000 -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:
1001 -
1002 -[[image:attach:port_anchors.png]]
1003 -
1004 1004  == Thoroughness ==
1005 1005  
1006 -
1007 -
1008 1008  {{id name="thoroughness"/}}
1009 1009  
978 +
979 +
1010 1010  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 -10751022
1 +10751224
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751022/KLay Layered Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751224/KLay Layered Layout Options

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage