<
From version < 24.1 >
edited by cds
on 2014/04/03 14:41
To version < 27.1 >
edited by cds
on 2014/04/03 15:03
>
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**
... ... @@ -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.
... ... @@ -747,11 +747,18 @@
747 747  
748 748  {{id name="edgeLabelSideSelection"/}}
749 749  
750 -{{warning}}
751 -Document!
752 -{{/warning}}
742 +Determines how KLay Layered places edge labels. The following strategies are available:
753 753  
754 -
744 +* ALWAYS_UP
745 +Always places edge labels above the edge.
746 +* ALWAYS_DOWN
747 +Always places edge labels below the edge.
748 +* DIRECTION_UP
749 +Places edge labels above edges pointing right, and below edges pointing left.
750 +* DIRECTION_DOWN
751 +Places edge labels below edges pointing right, and above edges pointing left.
752 +* SMART
753 +Uses a heuristic that determines the best edge label placement, also taking the placement of port labels into account.
755 755  
756 756  == Feedback Edges ==
757 757  
... ... @@ -798,12 +798,14 @@
798 798  
799 799  {{id name="layerConstraint"/}}
800 800  
801 -{{warning}}
802 -Document!
803 -{{/warning}}
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.
804 804  
805 -
802 +[[image:attach:layer_constraints.png]]
806 806  
804 +{{note}}
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 +{{/note}}
807 +
807 807  == Maximal Iterations ==
808 808  
809 809  
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470142
1 +9470239
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470142/KLay Layered Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470239/KLay Layered Layout Options