Last modified by Richard Kreissig on 2023/09/14 10:20
<
From version < 18.1 >
edited by cds
on 2014/03/17 11: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,7 +480,7 @@
480 480  )))
481 481  |(% colspan="1" %)(% colspan="1" %)
482 482  (((
483 -Edge Label Side Selection
511 +[[Edge Label Side Selection>>doc:||anchor="edgeLabelSideSelection"]]
484 484  )))|(% colspan="1" %)(% colspan="1" %)
485 485  (((
486 486  de.cau.cs.kieler.klay.layered.edgeLabelSideSelection
... ... @@ -575,6 +575,25 @@
575 575  )))
576 576  |(% colspan="1" %)(% colspan="1" %)
577 577  (((
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 +(((
578 578  [[Maximal Iterations>>doc:||anchor="maximalIterations"]]
579 579  )))|(% colspan="1" %)(% colspan="1" %)
580 580  (((
... ... @@ -628,7 +628,7 @@
628 628  true
629 629  )))|(% colspan="1" %)(% colspan="1" %)
630 630  (((
631 -
678 +layoutHierarchy=true
632 632  )))
633 633  |(((
634 634  [[Node Layering>>doc:||anchor="nodeLayering"]]
... ... @@ -697,10 +697,6 @@
697 697  
698 698  )))
699 699  
700 -= The Most Important Options =
701 -
702 -**TODO:** Write a bit of documentation about the most important layout options and how to use them, possibly with a simple example or something.
703 -
704 704  = Detailed Documentation =
705 705  
706 706  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.
... ... @@ -741,6 +741,25 @@
741 741  
742 742  [[image:attach:edgeSpacingFactor.png]]
743 743  
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 +
744 744  == Feedback Edges ==
745 745  
746 746  
... ... @@ -747,10 +747,16 @@
747 747  
748 748  {{id name="feedbackEdges"/}}
749 749  
750 -{{warning}}
751 -Document!
752 -{{/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.
753 753  
814 +With feedback edges:
815 +
816 +[[image:attach:feedback_on.png]]
817 +
818 +Without feedback edges:
819 +
820 +[[image:attach:feedback_off.png]]
821 +
754 754  == Fixed Alignment ==
755 755  
756 756  
... ... @@ -757,11 +757,9 @@
757 757  
758 758  {{id name="fixedAlignment"/}}
759 759  
760 -{{warning}}
761 -Document!
762 -{{/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.
763 763  
764 -
830 +This option should usually be left alone.
765 765  
766 766  == Interactive Reference Point ==
767 767  
... ... @@ -782,12 +782,26 @@
782 782  
783 783  {{id name="layerConstraint"/}}
784 784  
785 -{{warning}}
786 -Document!
787 -{{/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.
788 788  
789 -
853 +[[image:attach:layer_constraints.png]]
790 790  
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 +
791 791  == Maximal Iterations ==
792 792  
793 793  
... ... @@ -812,10 +812,10 @@
812 812  
813 813  {{id name="mergeHierarchyEdges"/}}
814 814  
815 -{{warning}}
816 -Document!
817 -{{/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.
818 818  
897 +[[image:attach:merge_hierarchy_edges.png]]
898 +
819 819  == Node Layering ==
820 820  
821 821  
... ... @@ -837,10 +837,17 @@
837 837  
838 838  {{id name="nodePlacement"/}}
839 839  
840 -{{warning}}
841 -Document!
842 -{{/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:
843 843  
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 +
844 844  == Port Anchor Offset ==
845 845  
846 846  
... ... @@ -847,12 +847,12 @@
847 847  
848 848  {{id name="portAnchor"/}}
849 849  
850 -{{warning}}
851 -Document!
852 -{{/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.
853 853  
854 -
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:
855 855  
941 +[[image:attach:port_anchors.png]]
942 +
856 856  == Thoroughness ==
857 857  
858 858  
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470079
1 +9471893
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470079/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