Last modified by Richard Kreissig on 2023/09/14 10:20
<
From version < 37.1 >
edited by uru
on 2015/01/28 15:52
To version < 36.1 >
edited by uru
on 2015/01/28 15:17
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -279,22 +279,6 @@
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 -)))
298 298  |(((
299 299  Port Constraints
300 300  )))|(((
... ... @@ -675,6 +675,25 @@
675 675  )))
676 676  |(% colspan="1" %)(% colspan="1" %)
677 677  (((
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 +(((
678 678  [[Merge Edges>>doc:||anchor="mergeEdges"]]
679 679  )))|(% colspan="1" %)(% colspan="1" %)
680 680  (((
... ... @@ -744,6 +744,25 @@
744 744  (((
745 745  
746 746  )))
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 +)))
747 747  |(((
748 748  [[Thoroughness>>doc:||anchor="thoroughness"]]
749 749  )))|(((
... ... @@ -765,18 +765,18 @@
765 765  
766 766  == Add Unnecessary Bendpoints ==
767 767  
768 -{{id name="addUnnecessaryBendpoints"/}}
769 769  
770 -
771 771  
792 +{{id name="addUnnecessaryBendpoints"/}}
793 +
772 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 773  
774 774  == Content Alignment ==
775 775  
776 -{{id name="contentAlignment"/}}
777 777  
778 -
779 779  
800 +{{id name="contentAlignment"/}}
801 +
780 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 781  
782 782  {{note}}
... ... @@ -785,10 +785,10 @@
785 785  
786 786  == Crossing Minimization ==
787 787  
788 -{{id name="crossingMinimization"/}}
789 789  
790 -
791 791  
812 +{{id name="crossingMinimization"/}}
813 +
792 792  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:
793 793  
794 794  * LAYER_SWEEP
... ... @@ -798,10 +798,10 @@
798 798  
799 799  == Cycle Breaking ==
800 800  
801 -{{id name="cycleBreaking"/}}
802 802  
803 -
804 804  
825 +{{id name="cycleBreaking"/}}
826 +
805 805  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:
806 806  
807 807  * GREEDY
... ... @@ -811,18 +811,18 @@
811 811  
812 812  == Direction ==
813 813  
814 -{{id name="direction"/}}
815 815  
816 -
817 817  
838 +{{id name="direction"/}}
839 +
818 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 819  
820 820  == Edge Spacing Factor ==
821 821  
822 -{{id name="edgeSpacingFactor"/}}
823 823  
824 -
825 825  
846 +{{id name="edgeSpacingFactor"/}}
847 +
826 826  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.
827 827  
828 828  [[image:attach:edgeSpacingFactor.png]]
... ... @@ -829,10 +829,10 @@
829 829  
830 830  == Edge Label Side Selection ==
831 831  
832 -{{id name="edgeLabelSideSelection"/}}
833 833  
834 -
835 835  
856 +{{id name="edgeLabelSideSelection"/}}
857 +
836 836  Determines how KLay Layered places edge labels. The following strategies are available:
837 837  
838 838  * ALWAYS_UP
... ... @@ -848,10 +848,10 @@
848 848  
849 849  == Feedback Edges ==
850 850  
851 -{{id name="feedbackEdges"/}}
852 852  
853 -
854 854  
875 +{{id name="feedbackEdges"/}}
876 +
855 855  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.
856 856  
857 857  With feedback edges:
... ... @@ -864,10 +864,10 @@
864 864  
865 865  == Fixed Alignment ==
866 866  
867 -{{id name="fixedAlignment"/}}
868 868  
869 -
870 870  
891 +{{id name="fixedAlignment"/}}
892 +
871 871  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.
872 872  
873 873  This option should usually be left alone.
... ... @@ -874,10 +874,10 @@
874 874  
875 875  == Interactive Reference Point ==
876 876  
877 -{{id name="interactiveReferencePoint"/}}
878 878  
879 -
880 880  
901 +{{id name="interactiveReferencePoint"/}}
902 +
881 881  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:
882 882  
883 883  * TOP_LEFT
... ... @@ -887,10 +887,10 @@
887 887  
888 888  == Layer Constraint ==
889 889  
890 -{{id name="layerConstraint"/}}
891 891  
892 -
893 893  
914 +{{id name="layerConstraint"/}}
915 +
894 894  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.
895 895  
896 896  [[image:attach:layer_constraints.png]]
... ... @@ -901,10 +901,10 @@
901 901  
902 902  == Linear Segments Deflection Dampening ==
903 903  
904 -{{id name="deflectionDampening"/}}
905 905  
906 -
907 907  
928 +{{id name="deflectionDampening"/}}
929 +
908 908  {{note}}
909 909  This is a very advanced layout option that you normally shouldn't worry about.
910 910  {{/note}}
... ... @@ -913,18 +913,18 @@
913 913  
914 914  == Maximal Iterations ==
915 915  
916 -{{id name="maximalIterations"/}}
917 917  
918 -
919 919  
940 +{{id name="maximalIterations"/}}
941 +
920 920  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.
921 921  
922 922  == Merge Edges ==
923 923  
924 -{{id name="mergeEdges"/}}
925 925  
926 -
927 927  
948 +{{id name="mergeEdges"/}}
949 +
928 928  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.
929 929  
930 930  [[image:attach:merging.png]]
... ... @@ -931,10 +931,10 @@
931 931  
932 932  == Merge Hierarchy-Crossing Edges ==
933 933  
934 -{{id name="mergeHierarchyEdges"/}}
935 935  
936 -
937 937  
958 +{{id name="mergeHierarchyEdges"/}}
959 +
938 938  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.
939 939  
940 940  [[image:attach:merge_hierarchy_edges.png]]
... ... @@ -941,10 +941,10 @@
941 941  
942 942  == Node Layering ==
943 943  
944 -{{id name="nodeLayering"/}}
945 945  
946 -
947 947  
968 +{{id name="nodeLayering"/}}
969 +
948 948  Decides which algorithm is used to compute the layer each node is placed in. We have different algorithms available, with different optimization goals:
949 949  
950 950  * NETWORK_SIMPLEX
... ... @@ -956,10 +956,10 @@
956 956  
957 957  == Node Placement ==
958 958  
959 -{{id name="nodePlacement"/}}
960 960  
961 -
962 962  
983 +{{id name="nodePlacement"/}}
984 +
963 963  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:
964 964  
965 965  * BRANDES_KOEPF
... ... @@ -971,10 +971,22 @@
971 971  * SIMPLE
972 972  Minimizes the area at the expense of... well, pretty much everything else.
973 973  
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 +
974 974  == Thoroughness ==
975 975  
976 -{{id name="thoroughness"/}}
977 977  
978 -
979 979  
1012 +{{id name="thoroughness"/}}
1013 +
980 980  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 -10751224
1 +10751027
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751224/KLay Layered Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751027/KLay Layered Layout Options

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage