Changes for page KLay Layered Layout Options

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

From version < 24.1 >

edited by cds
on 2014/04/03 14:41

To version < 39.1 >

edited by cds
on 2015/02/18 15:16

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" %)
  (((
@@ -268,6 +268,22 @@
  (((
  )))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++(% class="confluence-link" %)Port Anchor Offset
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.klay.layered.portAnchor
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Object
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Ports
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))
  |(((
  Port Constraints
  )))|(((
@@ -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
  )))|(((
@@ -436,6 +436,44 @@
  (((
  Dependency
  )))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++[[Add Unnecessary Bendpoints>>doc:||anchor="addUnnecessaryBendpoints"]]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.klay.layered.unnecessaryBendpoints
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Boolean
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Parents
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++false
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++[[Content Alignment>>doc:||anchor="contentAlignment"]]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.klay.layered.contentAlignment
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++EnumSet
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Parents
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++V_TOP, H_LEFT
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))
  |(((
  [[Crossing Minimization>>doc:||anchor="crossingMinimization"]]
  )))|(((
@@ -575,22 +575,22 @@
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--[[Maximal Iterations>>doc:||anchor="maximalIterations"]]
++[[Linear Segments Deflection Dampening>>doc:||anchor="deflectionDampening"]]
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.klay.layered.nodeLayering
++de.cau.cs.kieler.klay.layered.linearSegmentsDeflectionDampening
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Int
++Float
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  Parents
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--10.000.000
++0.3
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--nodeLayering=NETWORK_SIMPLEX
++nodePlace=LINEAR_SEGMENTS
  )))
  |(% 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
@@ -663,25 +663,6 @@
  (((
  )))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--[[Port Anchor Offset>>doc:||anchor="portAnchor"]]
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--de.cau.cs.kieler.klay.layered.portAnchor
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Object
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Ports
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--
--)))
  |(((
  [[Thoroughness>>doc:||anchor="thoroughness"]]
  )))|(((
@@ -697,20 +697,34 @@
  )))
--= 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.
--== Crossing Minimization ==
++==  ==
++{{id name="addUnnecessaryBendpoints"/}}Add Unnecessary Bendpoints
++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.
++== Content Alignment ==
++
++{{id name="contentAlignment"/}}
++
++
++
++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.
++
++{{note}}
++This option is not tested for external ports with port constraints {{code language="none"}}FIXED_RATIO{{/code}} or {{code language="none"}}FIXED_POS{{/code}}.
++{{/note}}
++
++== Crossing Minimization ==
++
  {{id name="crossingMinimization"/}}
++
++
  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:
  * LAYER_SWEEP
@@ -720,10 +720,10 @@
  == Cycle Breaking ==
--
--
  {{id name="cycleBreaking"/}}
++
++
  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:
  * GREEDY
@@ -731,12 +731,20 @@
  * 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.
--== Edge Spacing Factor ==
++== 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 ==
++
  {{id name="edgeSpacingFactor"/}}
++
++
  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.
  [[image:attach:edgeSpacingFactor.png]]
@@ -743,22 +743,29 @@
  == Edge Label Side Selection ==
--
--
  {{id name="edgeLabelSideSelection"/}}
--{{warning}}
--Document!
--{{/warning}}
--
--== Feedback Edges ==
++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 ==
  {{id name="feedbackEdges"/}}
++
++
  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:
@@ -771,10 +771,10 @@
  == Fixed Alignment ==
--
--
  {{id name="fixedAlignment"/}}
++
++
  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.
@@ -781,10 +781,10 @@
  == Interactive Reference Point ==
--
--
  {{id name="interactiveReferencePoint"/}}
++
++
  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:
  * TOP_LEFT
@@ -794,30 +794,44 @@
  == Layer Constraint ==
++{{id name="layerConstraint"/}}
++
--{{id name="layerConstraint"/}}
++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.
--{{warning}}
--Document!
--{{/warning}}
++[[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"/}}
++
--== Maximal Iterations ==
++{{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 ==
  {{id name="maximalIterations"/}}
++
++
  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.
  == Merge Edges ==
--
--
  {{id name="mergeEdges"/}}
++
++
  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.
  [[image:attach:merging.png]]
@@ -824,10 +824,10 @@
  == Merge Hierarchy-Crossing Edges ==
--
--
  {{id name="mergeHierarchyEdges"/}}
++
++
  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]]
@@ -834,10 +834,10 @@
  == Node Layering ==
--
--
  {{id name="nodeLayering"/}}
++
++
  Decides which algorithm is used to compute the layer each node is placed in. We have different algorithms available, with different optimization goals:
  * NETWORK_SIMPLEX
@@ -849,37 +849,27 @@
  == Node Placement ==
--
--
  {{id name="nodePlacement"/}}
++
++
  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
++* {{code language="none"}}BRANDES_KOEPF{{/code}}
  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
++* {{code language="none"}}LINEAR_SEGMENTS{{/code}}
  Computes a balanced placement.
--* BUCHHEIM_JUENGER_LEIPERT
++* {{code language="none"}}BUCHHEIM_JUENGER_LEIPERT{{/code}}
  Also computes a balanced placement, but a little faster.
--* SIMPLE
++* {{code language="none"}}INTERACTIVE{{/code}}
++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.
++* {{code language="none"}}SIMPLE{{/code}}
  Minimizes the area at the expense of... well, pretty much everything else.
--== Port Anchor Offset ==
--
--
--
--{{id name="portAnchor"/}}
--
--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 ==
--
--
  {{id name="thoroughness"/}}
++
++
  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 @@
--9470142
++10751227

URL

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

Changes for page KLay Layered Layout Options

Summary

Details

Navigation

Quick Links