Changes for page KLay Layered Layout Options
Last modified by Richard Kreissig on 2023/09/14 10:20
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
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 )))|((( ... ... @@ -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,18 +787,18 @@ 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 798 - 799 - 800 800 {{id name="contentAlignment"/}} 801 801 778 + 779 + 802 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. 803 803 804 804 {{note}} ... ... @@ -807,10 +807,10 @@ 807 807 808 808 == Crossing Minimization == 809 809 810 - 811 - 812 812 {{id name="crossingMinimization"/}} 813 813 790 + 791 + 814 814 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: 815 815 816 816 * LAYER_SWEEP ... ... @@ -820,10 +820,10 @@ 820 820 821 821 == Cycle Breaking == 822 822 823 - 824 - 825 825 {{id name="cycleBreaking"/}} 826 826 803 + 804 + 827 827 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: 828 828 829 829 * GREEDY ... ... @@ -833,18 +833,18 @@ 833 833 834 834 == Direction == 835 835 836 - 837 - 838 838 {{id name="direction"/}} 839 839 816 + 817 + 840 840 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}}. 841 841 842 842 == Edge Spacing Factor == 843 843 844 - 845 - 846 846 {{id name="edgeSpacingFactor"/}} 847 847 824 + 825 + 848 848 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. 849 849 850 850 [[image:attach:edgeSpacingFactor.png]] ... ... @@ -851,10 +851,10 @@ 851 851 852 852 == Edge Label Side Selection == 853 853 854 - 855 - 856 856 {{id name="edgeLabelSideSelection"/}} 857 857 834 + 835 + 858 858 Determines how KLay Layered places edge labels. The following strategies are available: 859 859 860 860 * ALWAYS_UP ... ... @@ -870,10 +870,10 @@ 870 870 871 871 == Feedback Edges == 872 872 873 - 874 - 875 875 {{id name="feedbackEdges"/}} 876 876 853 + 854 + 877 877 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. 878 878 879 879 With feedback edges: ... ... @@ -886,10 +886,10 @@ 886 886 887 887 == Fixed Alignment == 888 888 889 - 890 - 891 891 {{id name="fixedAlignment"/}} 892 892 869 + 870 + 893 893 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. 894 894 895 895 This option should usually be left alone. ... ... @@ -896,10 +896,10 @@ 896 896 897 897 == Interactive Reference Point == 898 898 899 - 900 - 901 901 {{id name="interactiveReferencePoint"/}} 902 902 879 + 880 + 903 903 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: 904 904 905 905 * TOP_LEFT ... ... @@ -909,10 +909,10 @@ 909 909 910 910 == Layer Constraint == 911 911 912 - 913 - 914 914 {{id name="layerConstraint"/}} 915 915 892 + 893 + 916 916 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. 917 917 918 918 [[image:attach:layer_constraints.png]] ... ... @@ -923,10 +923,10 @@ 923 923 924 924 == Linear Segments Deflection Dampening == 925 925 926 - 927 - 928 928 {{id name="deflectionDampening"/}} 929 929 906 + 907 + 930 930 {{note}} 931 931 This is a very advanced layout option that you normally shouldn't worry about. 932 932 {{/note}} ... ... @@ -935,18 +935,18 @@ 935 935 936 936 == Maximal Iterations == 937 937 938 - 939 - 940 940 {{id name="maximalIterations"/}} 941 941 918 + 919 + 942 942 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. 943 943 944 944 == Merge Edges == 945 945 946 - 947 - 948 948 {{id name="mergeEdges"/}} 949 949 926 + 927 + 950 950 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. 951 951 952 952 [[image:attach:merging.png]] ... ... @@ -953,10 +953,10 @@ 953 953 954 954 == Merge Hierarchy-Crossing Edges == 955 955 956 - 957 - 958 958 {{id name="mergeHierarchyEdges"/}} 959 959 936 + 937 + 960 960 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. 961 961 962 962 [[image:attach:merge_hierarchy_edges.png]] ... ... @@ -963,10 +963,10 @@ 963 963 964 964 == Node Layering == 965 965 966 - 967 - 968 968 {{id name="nodeLayering"/}} 969 969 946 + 947 + 970 970 Decides which algorithm is used to compute the layer each node is placed in. We have different algorithms available, with different optimization goals: 971 971 972 972 * NETWORK_SIMPLEX ... ... @@ -978,10 +978,10 @@ 978 978 979 979 == Node Placement == 980 980 981 - 982 - 983 983 {{id name="nodePlacement"/}} 984 984 961 + 962 + 985 985 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: 986 986 987 987 * BRANDES_KOEPF ... ... @@ -993,22 +993,10 @@ 993 993 * SIMPLE 994 994 Minimizes the area at the expense of... well, pretty much everything else. 995 995 996 -== Port Anchor Offset == 997 - 998 - 999 - 1000 -{{id name="portAnchor"/}} 1001 - 1002 -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. 1003 - 1004 -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: 1005 - 1006 -[[image:attach:port_anchors.png]] 1007 - 1008 1008 == Thoroughness == 1009 1009 1010 - 1011 - 1012 1012 {{id name="thoroughness"/}} 1013 1013 978 + 979 + 1014 1014 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 -10751 0271 +10751224 - URL
-
... ... @@ -1,1 +1,1 @@ 1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751 027/KLay Layered Layout Options1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751224/KLay Layered Layout Options