Last modified by Richard Kreissig on 2023/09/14 10:20
<
From version < 17.1 >
edited by cds
on 2014/03/14 15:21
To version < 30.1 >
edited by cds
on 2014/08/22 15:33
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,7 +5,3 @@
1 -{{warning}}
2 -This is preliminary and incomplete documentation. You've been warned.
3 -{{/warning}}
4 -
5 5  KLay Layered supports a whole bunch of layout options. Every single one of them is documented here.
6 6  
7 7  **Contents**
... ... @@ -29,6 +29,22 @@
29 29  )))|=(((
30 30  Default
31 31  )))
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 +)))
32 32  |(((
33 33  Alignment
34 34  )))|(((
... ... @@ -327,6 +327,22 @@
327 327  (((
328 328  UNDEFINED
329 329  )))
342 +|(% colspan="1" %)(% colspan="1" %)
343 +(((
344 +Port Spacing
345 +)))|(% colspan="1" %)(% colspan="1" %)
346 +(((
347 +de.cau.cs.kieler.portSpacing
348 +)))|(% colspan="1" %)(% colspan="1" %)
349 +(((
350 +Float
351 +)))|(% colspan="1" %)(% colspan="1" %)
352 +(((
353 +Nodes
354 +)))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
355 +(((
356 +10
357 +)))
330 330  |(((
331 331  Priority
332 332  )))|(((
... ... @@ -480,6 +480,25 @@
480 480  )))
481 481  |(% colspan="1" %)(% colspan="1" %)
482 482  (((
511 +[[Edge Label Side Selection>>doc:||anchor="edgeLabelSideSelection"]]
512 +)))|(% colspan="1" %)(% colspan="1" %)
513 +(((
514 +de.cau.cs.kieler.klay.layered.edgeLabelSideSelection
515 +)))|(% colspan="1" %)(% colspan="1" %)
516 +(((
517 +Enum
518 +)))|(% colspan="1" %)(% colspan="1" %)
519 +(((
520 +Parents
521 +)))|(% colspan="1" %)(% colspan="1" %)
522 +(((
523 +SMART
524 +)))|(% colspan="1" %)(% colspan="1" %)
525 +(((
526 +
527 +)))
528 +|(% colspan="1" %)(% colspan="1" %)
529 +(((
483 483  [[Feedback Edges>>doc:||anchor="feedbackEdges"]]
484 484  )))|(% colspan="1" %)(% colspan="1" %)
485 485  (((
... ... @@ -556,6 +556,25 @@
556 556  )))
557 557  |(% colspan="1" %)(% colspan="1" %)
558 558  (((
606 +[[Linear Segments Deflection Dampening>>doc:||anchor="deflectionDampening"]]
607 +)))|(% colspan="1" %)(% colspan="1" %)
608 +(((
609 +de.cau.cs.kieler.klay.layered.linearSegmentsDeflectionDampening
610 +)))|(% colspan="1" %)(% colspan="1" %)
611 +(((
612 +Float
613 +)))|(% colspan="1" %)(% colspan="1" %)
614 +(((
615 +Parents
616 +)))|(% colspan="1" %)(% colspan="1" %)
617 +(((
618 +0.3
619 +)))|(% colspan="1" %)(% colspan="1" %)
620 +(((
621 +nodePlace=LINEAR_SEGMENTS
622 +)))
623 +|(% colspan="1" %)(% colspan="1" %)
624 +(((
559 559  [[Maximal Iterations>>doc:||anchor="maximalIterations"]]
560 560  )))|(% colspan="1" %)(% colspan="1" %)
561 561  (((
... ... @@ -609,7 +609,7 @@
609 609  true
610 610  )))|(% colspan="1" %)(% colspan="1" %)
611 611  (((
612 -
678 +layoutHierarchy=true
613 613  )))
614 614  |(((
615 615  [[Node Layering>>doc:||anchor="nodeLayering"]]
... ... @@ -678,10 +678,6 @@
678 678  
679 679  )))
680 680  
681 -= The Most Important Options =
682 -
683 -**TODO:** Write a bit of documentation about the most important layout options and how to use them, possibly with a simple example or something.
684 -
685 685  = Detailed Documentation =
686 686  
687 687  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.
... ... @@ -722,6 +722,25 @@
722 722  
723 723  [[image:attach:edgeSpacingFactor.png]]
724 724  
787 +== Edge Label Side Selection ==
788 +
789 +
790 +
791 +{{id name="edgeLabelSideSelection"/}}
792 +
793 +Determines how KLay Layered places edge labels. The following strategies are available:
794 +
795 +* ALWAYS_UP
796 +Always places edge labels above the edge.
797 +* ALWAYS_DOWN
798 +Always places edge labels below the edge.
799 +* DIRECTION_UP
800 +Places edge labels above edges pointing right, and below edges pointing left.
801 +* DIRECTION_DOWN
802 +Places edge labels below edges pointing right, and above edges pointing left.
803 +* SMART
804 +Uses a heuristic that determines the best edge label placement, also taking the placement of port labels into account.
805 +
725 725  == Feedback Edges ==
726 726  
727 727  
... ... @@ -728,10 +728,16 @@
728 728  
729 729  {{id name="feedbackEdges"/}}
730 730  
731 -{{warning}}
732 -Document!
733 -{{/warning}}
812 +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.
734 734  
814 +With feedback edges:
815 +
816 +[[image:attach:feedback_on.png]]
817 +
818 +Without feedback edges:
819 +
820 +[[image:attach:feedback_off.png]]
821 +
735 735  == Fixed Alignment ==
736 736  
737 737  
... ... @@ -738,11 +738,9 @@
738 738  
739 739  {{id name="fixedAlignment"/}}
740 740  
741 -{{warning}}
742 -Document!
743 -{{/warning}}
828 +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.
744 744  
745 -
830 +This option should usually be left alone.
746 746  
747 747  == Interactive Reference Point ==
748 748  
... ... @@ -763,12 +763,26 @@
763 763  
764 764  {{id name="layerConstraint"/}}
765 765  
766 -{{warning}}
767 -Document!
768 -{{/warning}}
851 +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.
769 769  
770 -
853 +[[image:attach:layer_constraints.png]]
771 771  
855 +{{note}}
856 +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.
857 +{{/note}}
858 +
859 +== Linear Segments Deflection Dampening ==
860 +
861 +
862 +
863 +{{id name="deflectionDampening"/}}
864 +
865 +{{note}}
866 +This is a very advanced layout option that you normally shouldn't worry about.
867 +{{/note}}
868 +
869 +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.
870 +
772 772  == Maximal Iterations ==
773 773  
774 774  
... ... @@ -793,10 +793,10 @@
793 793  
794 794  {{id name="mergeHierarchyEdges"/}}
795 795  
796 -{{warning}}
797 -Document!
798 -{{/warning}}
895 +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.
799 799  
897 +[[image:attach:merge_hierarchy_edges.png]]
898 +
800 800  == Node Layering ==
801 801  
802 802  
... ... @@ -818,10 +818,17 @@
818 818  
819 819  {{id name="nodePlacement"/}}
820 820  
821 -{{warning}}
822 -Document!
823 -{{/warning}}
920 +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:
824 824  
922 +* BRANDES_KOEPF
923 +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.
924 +* LINEAR_SEGMENTS
925 +Computes a balanced placement.
926 +* BUCHHEIM_JUENGER_LEIPERT
927 +Also computes a balanced placement, but a little faster.
928 +* SIMPLE
929 +Minimizes the area at the expense of... well, pretty much everything else.
930 +
825 825  == Port Anchor Offset ==
826 826  
827 827  
... ... @@ -828,12 +828,12 @@
828 828  
829 829  {{id name="portAnchor"/}}
830 830  
831 -{{warning}}
832 -Document!
833 -{{/warning}}
937 +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.
834 834  
835 -
939 +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:
836 836  
941 +[[image:attach:port_anchors.png]]
942 +
837 837  == Thoroughness ==
838 838  
839 839  
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470076
1 +9471893
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470076/KLay Layered Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9471893/KLay Layered Layout Options

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage