Changes for page KLay Layered Layout Options

Last modified by Richard Kreissig on 2023/09/14 10:20

From version < 19.1 >

edited by cds
on 2014/03/17 11:21

To version < 32.1 >

edited by cds
on 2014/11/27 16:27

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

@@ -1,7 +5,3 @@
--{{warning}}
--This is preliminary and incomplete documentation. You've been warned.
--{{/warning}}
--
  KLay Layered supports a whole bunch of layout options. Every single one of them is documented here.
  **Contents**
@@ -29,6 +29,22 @@
  )))|=(((
  Default
  )))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Additional Port Space
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.additionalPortSpace
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Margins
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Nodes
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++0, 0, 0, 0
++)))
  |(((
  Alignment
  )))|(((
@@ -108,7 +108,7 @@
  )))
  |(((
--Direction
++[[Direction>>doc:||anchor="direction"]]
  )))|(((
  de.cau.cs.kieler.direction
  )))|(((
@@ -115,9 +115,8 @@
  Enum
  )))|(((
  Parents
--)))|(% class="highlight-yellow" data-highlight-colour="yellow" %)(% class="highlight-yellow" data-highlight-colour="yellow" %)
--(((
--RIGHT
++)))|(((
++UNDEFINED
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -327,6 +327,22 @@
  (((
  UNDEFINED
  )))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Port Spacing
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.portSpacing
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Float
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Nodes
++)))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
++(((
++10
++)))
  |(((
  Priority
  )))|(((
@@ -575,6 +575,25 @@
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
++[[Linear Segments Deflection Dampening>>doc:||anchor="deflectionDampening"]]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.klay.layered.linearSegmentsDeflectionDampening
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Float
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Parents
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++0.3
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++nodePlace=LINEAR_SEGMENTS
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
  [[Maximal Iterations>>doc:||anchor="maximalIterations"]]
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
@@ -597,7 +597,7 @@
  [[Merge Edges>>doc:||anchor="mergeEdges"]]
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.klay.layered.mergePorts
++de.cau.cs.kieler.klay.layered.mergeEdges
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  Boolean
@@ -628,7 +628,7 @@
  true
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--
++layoutHierarchy=true
  )))
  |(((
  [[Node Layering>>doc:||anchor="nodeLayering"]]
@@ -697,10 +697,6 @@
  )))
--= The Most Important Options =
--
--**TODO:** Write a bit of documentation about the most important layout options and how to use them, possibly with a simple example or something.
--
  = Detailed Documentation =
  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.
@@ -731,6 +731,14 @@
  * INTERACTIVE
  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.
++== Direction ==
++
++
++
++{{id name="direction"/}}
++
++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}}.
++
  == Edge Spacing Factor ==
@@ -747,11 +747,18 @@
  {{id name="edgeLabelSideSelection"/}}
--{{warning}}
--Document!
--{{/warning}}
++Determines how KLay Layered places edge labels. The following strategies are available:
--
++* ALWAYS_UP
++Always places edge labels above the edge.
++* ALWAYS_DOWN
++Always places edge labels below the edge.
++* DIRECTION_UP
++Places edge labels above edges pointing right, and below edges pointing left.
++* DIRECTION_DOWN
++Places edge labels below edges pointing right, and above edges pointing left.
++* SMART
++Uses a heuristic that determines the best edge label placement, also taking the placement of port labels into account.
  == Feedback Edges ==
@@ -759,10 +759,16 @@
  {{id name="feedbackEdges"/}}
--{{warning}}
--Document!
--{{/warning}}
++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.
++With feedback edges:
++
++[[image:attach:feedback_on.png]]
++
++Without feedback edges:
++
++[[image:attach:feedback_off.png]]
++
  == Fixed Alignment ==
@@ -769,11 +769,9 @@
  {{id name="fixedAlignment"/}}
--{{warning}}
--Document!
--{{/warning}}
++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.
--
++This option should usually be left alone.
  == Interactive Reference Point ==
@@ -794,12 +794,26 @@
  {{id name="layerConstraint"/}}
--{{warning}}
--Document!
--{{/warning}}
++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.
--
++[[image:attach:layer_constraints.png]]
++{{note}}
++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.
++{{/note}}
++
++== Linear Segments Deflection Dampening ==
++
++
++
++{{id name="deflectionDampening"/}}
++
++{{note}}
++This is a very advanced layout option that you normally shouldn't worry about.
++{{/note}}
++
++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.
++
  == Maximal Iterations ==
@@ -824,10 +824,10 @@
  {{id name="mergeHierarchyEdges"/}}
--{{warning}}
--Document!
--{{/warning}}
++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.
++[[image:attach:merge_hierarchy_edges.png]]
++
  == Node Layering ==
@@ -849,10 +849,17 @@
  {{id name="nodePlacement"/}}
--{{warning}}
--Document!
--{{/warning}}
++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:
++* BRANDES_KOEPF
++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.
++* LINEAR_SEGMENTS
++Computes a balanced placement.
++* BUCHHEIM_JUENGER_LEIPERT
++Also computes a balanced placement, but a little faster.
++* SIMPLE
++Minimizes the area at the expense of... well, pretty much everything else.
++
  == Port Anchor Offset ==
@@ -859,12 +859,12 @@
  {{id name="portAnchor"/}}
--{{warning}}
--Document!
--{{/warning}}
++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.
--
++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:
++[[image:attach:port_anchors.png]]
++
  == Thoroughness ==

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--9470132
++10750901

URL

@@ -1,1 +1,1 @@
--https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470132/KLay Layered Layout Options
++https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10750901/KLay Layered Layout Options

Changes for page KLay Layered Layout Options

Summary

Details

Navigation

Quick Links