Last modified by Richard Kreissig on 2023/09/14 10:20
<
From version < 27.1 >
edited by cds
on 2014/04/03 15:03
To version < 38.1 >
edited by cds
on 2015/02/18 15:15
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -25,6 +25,22 @@
25 25  )))|=(((
26 26  Default
27 27  )))
28 +|(% colspan="1" %)(% colspan="1" %)
29 +(((
30 +Additional Port Space
31 +)))|(% colspan="1" %)(% colspan="1" %)
32 +(((
33 +de.cau.cs.kieler.additionalPortSpace
34 +)))|(% colspan="1" %)(% colspan="1" %)
35 +(((
36 +Margins
37 +)))|(% colspan="1" %)(% colspan="1" %)
38 +(((
39 +Nodes
40 +)))|(% colspan="1" %)(% colspan="1" %)
41 +(((
42 +0, 0, 0, 0
43 +)))
28 28  |(((
29 29  Alignment
30 30  )))|(((
... ... @@ -104,7 +104,7 @@
104 104  
105 105  )))
106 106  |(((
107 -Direction
123 +[[Direction>>doc:||anchor="direction"]]
108 108  )))|(((
109 109  de.cau.cs.kieler.direction
110 110  )))|(((
... ... @@ -111,9 +111,8 @@
111 111  Enum
112 112  )))|(((
113 113  Parents
114 -)))|(% class="highlight-yellow" data-highlight-colour="yellow" %)(% class="highlight-yellow" data-highlight-colour="yellow" %)
115 -(((
116 -RIGHT
130 +)))|(((
131 +UNDEFINED
117 117  )))
118 118  |(% colspan="1" %)(% colspan="1" %)
119 119  (((
... ... @@ -264,6 +264,22 @@
264 264  (((
265 265  
266 266  )))
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 +)))
267 267  |(((
268 268  Port Constraints
269 269  )))|(((
... ... @@ -323,6 +323,22 @@
323 323  (((
324 324  UNDEFINED
325 325  )))
357 +|(% colspan="1" %)(% colspan="1" %)
358 +(((
359 +Port Spacing
360 +)))|(% colspan="1" %)(% colspan="1" %)
361 +(((
362 +de.cau.cs.kieler.portSpacing
363 +)))|(% colspan="1" %)(% colspan="1" %)
364 +(((
365 +Float
366 +)))|(% colspan="1" %)(% colspan="1" %)
367 +(((
368 +Nodes
369 +)))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
370 +(((
371 +10
372 +)))
326 326  |(((
327 327  Priority
328 328  )))|(((
... ... @@ -432,6 +432,44 @@
432 432  (((
433 433  Dependency
434 434  )))
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 +)))
435 435  |(((
436 436  [[Crossing Minimization>>doc:||anchor="crossingMinimization"]]
437 437  )))|(((
... ... @@ -571,22 +571,22 @@
571 571  )))
572 572  |(% colspan="1" %)(% colspan="1" %)
573 573  (((
574 -[[Maximal Iterations>>doc:||anchor="maximalIterations"]]
659 +[[Linear Segments Deflection Dampening>>doc:||anchor="deflectionDampening"]]
575 575  )))|(% colspan="1" %)(% colspan="1" %)
576 576  (((
577 -de.cau.cs.kieler.klay.layered.nodeLayering
662 +de.cau.cs.kieler.klay.layered.linearSegmentsDeflectionDampening
578 578  )))|(% colspan="1" %)(% colspan="1" %)
579 579  (((
580 -Int
665 +Float
581 581  )))|(% colspan="1" %)(% colspan="1" %)
582 582  (((
583 583  Parents
584 584  )))|(% colspan="1" %)(% colspan="1" %)
585 585  (((
586 -10.000.000
671 +0.3
587 587  )))|(% colspan="1" %)(% colspan="1" %)
588 588  (((
589 -nodeLayering=NETWORK_SIMPLEX
674 +nodePlace=LINEAR_SEGMENTS
590 590  )))
591 591  |(% colspan="1" %)(% colspan="1" %)
592 592  (((
... ... @@ -593,7 +593,7 @@
593 593  [[Merge Edges>>doc:||anchor="mergeEdges"]]
594 594  )))|(% colspan="1" %)(% colspan="1" %)
595 595  (((
596 -de.cau.cs.kieler.klay.layered.mergePorts
681 +de.cau.cs.kieler.klay.layered.mergeEdges
597 597  )))|(% colspan="1" %)(% colspan="1" %)
598 598  (((
599 599  Boolean
... ... @@ -659,25 +659,6 @@
659 659  (((
660 660  
661 661  )))
662 -|(% colspan="1" %)(% colspan="1" %)
663 -(((
664 -[[Port Anchor Offset>>doc:||anchor="portAnchor"]]
665 -)))|(% colspan="1" %)(% colspan="1" %)
666 -(((
667 -de.cau.cs.kieler.klay.layered.portAnchor
668 -)))|(% colspan="1" %)(% colspan="1" %)
669 -(((
670 -Object
671 -)))|(% colspan="1" %)(% colspan="1" %)
672 -(((
673 -Ports
674 -)))|(% colspan="1" %)(% colspan="1" %)
675 -(((
676 -
677 -)))|(% colspan="1" %)(% colspan="1" %)
678 -(((
679 -
680 -)))
681 681  |(((
682 682  [[Thoroughness>>doc:||anchor="thoroughness"]]
683 683  )))|(((
... ... @@ -697,12 +697,32 @@
697 697  
698 698  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.
699 699  
700 -== Crossing Minimization ==
766 +== Add Unnecessary Bendpoints ==
701 701  
768 +{{id name="addUnnecessaryBendpoints"/}}
702 702  
770 +
703 703  
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 +
774 +== Content Alignment ==
775 +
776 +{{id name="contentAlignment"/}}
777 +
778 +
779 +
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 +
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}}
785 +
786 +== Crossing Minimization ==
787 +
704 704  {{id name="crossingMinimization"/}}
705 705  
790 +
791 +
706 706  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:
707 707  
708 708  * LAYER_SWEEP
... ... @@ -712,10 +712,10 @@
712 712  
713 713  == Cycle Breaking ==
714 714  
715 -
716 -
717 717  {{id name="cycleBreaking"/}}
718 718  
803 +
804 +
719 719  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:
720 720  
721 721  * GREEDY
... ... @@ -723,12 +723,20 @@
723 723  * INTERACTIVE
724 724  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.
725 725  
726 -== Edge Spacing Factor ==
812 +== Direction ==
727 727  
814 +{{id name="direction"/}}
728 728  
816 +
729 729  
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 +
820 +== Edge Spacing Factor ==
821 +
730 730  {{id name="edgeSpacingFactor"/}}
731 731  
824 +
825 +
732 732  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.
733 733  
734 734  [[image:attach:edgeSpacingFactor.png]]
... ... @@ -735,10 +735,10 @@
735 735  
736 736  == Edge Label Side Selection ==
737 737  
738 -
739 -
740 740  {{id name="edgeLabelSideSelection"/}}
741 741  
834 +
835 +
742 742  Determines how KLay Layered places edge labels. The following strategies are available:
743 743  
744 744  * ALWAYS_UP
... ... @@ -754,10 +754,10 @@
754 754  
755 755  == Feedback Edges ==
756 756  
757 -
758 -
759 759  {{id name="feedbackEdges"/}}
760 760  
853 +
854 +
761 761  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.
762 762  
763 763  With feedback edges:
... ... @@ -770,10 +770,10 @@
770 770  
771 771  == Fixed Alignment ==
772 772  
773 -
774 -
775 775  {{id name="fixedAlignment"/}}
776 776  
869 +
870 +
777 777  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.
778 778  
779 779  This option should usually be left alone.
... ... @@ -780,10 +780,10 @@
780 780  
781 781  == Interactive Reference Point ==
782 782  
783 -
784 -
785 785  {{id name="interactiveReferencePoint"/}}
786 786  
879 +
880 +
787 787  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:
788 788  
789 789  * TOP_LEFT
... ... @@ -793,10 +793,10 @@
793 793  
794 794  == Layer Constraint ==
795 795  
796 -
797 -
798 798  {{id name="layerConstraint"/}}
799 799  
892 +
893 +
800 800  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.
801 801  
802 802  [[image:attach:layer_constraints.png]]
... ... @@ -805,20 +805,32 @@
805 805  This option can also be set to {{code language="none"}}FIRST_SEPARATE{{/code}} and {{code language="none"}}LAST_SEPARATE{{/code}}. These are for internal use only and should not have been publicly exposed in the first place. Using them can result in layout problems.
806 806  {{/note}}
807 807  
808 -== Maximal Iterations ==
902 +== Linear Segments Deflection Dampening ==
809 809  
904 +{{id name="deflectionDampening"/}}
810 810  
906 +
811 811  
908 +{{note}}
909 +This is a very advanced layout option that you normally shouldn't worry about.
910 +{{/note}}
911 +
912 +The linear segments node placer can sometimes place nodes in a way that results in unnecessarily large diagrams. This option dampens how much the nodes are moved around. A dampening factor of 1.0 disables dampening and just lets the node placer do what it wants. A more conservative dampening factor of 0.3 (the default) restricts the freedom of the node placer a bit more.
913 +
914 +== Maximal Iterations ==
915 +
812 812  {{id name="maximalIterations"/}}
813 813  
918 +
919 +
814 814  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.
815 815  
816 816  == Merge Edges ==
817 817  
818 -
819 -
820 820  {{id name="mergeEdges"/}}
821 821  
926 +
927 +
822 822  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.
823 823  
824 824  [[image:attach:merging.png]]
... ... @@ -825,10 +825,10 @@
825 825  
826 826  == Merge Hierarchy-Crossing Edges ==
827 827  
828 -
829 -
830 830  {{id name="mergeHierarchyEdges"/}}
831 831  
936 +
937 +
832 832  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.
833 833  
834 834  [[image:attach:merge_hierarchy_edges.png]]
... ... @@ -835,10 +835,10 @@
835 835  
836 836  == Node Layering ==
837 837  
838 -
839 -
840 840  {{id name="nodeLayering"/}}
841 841  
946 +
947 +
842 842  Decides which algorithm is used to compute the layer each node is placed in. We have different algorithms available, with different optimization goals:
843 843  
844 844  * NETWORK_SIMPLEX
... ... @@ -850,37 +850,27 @@
850 850  
851 851  == Node Placement ==
852 852  
853 -
854 -
855 855  {{id name="nodePlacement"/}}
856 856  
961 +
962 +
857 857  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:
858 858  
859 -* BRANDES_KOEPF
965 +* {{code language="none"}}BRANDES_KOEPF{{/code}}
860 860  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.
861 -* LINEAR_SEGMENTS
967 +* {{code language="none"}}LINEAR_SEGMENTS{{/code}}
862 862  Computes a balanced placement.
863 -* BUCHHEIM_JUENGER_LEIPERT
969 +* {{code language="none"}}BUCHHEIM_JUENGER_LEIPERT{{/code}}
864 864  Also computes a balanced placement, but a little faster.
865 -* SIMPLE
971 +* {{code language="none"}}INTERACTIVE{{/code}}
972 +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.
973 +* {{code language="none"}}SIMPLE{{/code}}
866 866  Minimizes the area at the expense of... well, pretty much everything else.
867 867  
868 -== Port Anchor Offset ==
869 -
870 -
871 -
872 -{{id name="portAnchor"/}}
873 -
874 -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.
875 -
876 -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:
877 -
878 -[[image:attach:port_anchors.png]]
879 -
880 880  == Thoroughness ==
881 881  
882 -
883 -
884 884  {{id name="thoroughness"/}}
885 885  
980 +
981 +
886 886  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 -9470239
1 +10751225
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470239/KLay Layered Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751225/KLay Layered Layout Options

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage