This is preliminary and incomplete documentation. You've been warned. |
KLay Layered supports a whole bunch of layout options. Every single one of them is documented here.
Contents
For a general introduction on layout options, see the KIML documentation. KLay Layered supports layout options defined by KIML and defines additional custom layout options.
KLay Layered supports the following standard layout options defined by KIML. Note that the default value may be altered (highlighted yellow).
Option | ID | Type | Applies to | Default |
---|---|---|---|---|
Alignment | de.cau.cs.kieler.alignment | Enum | Nodes | AUTOMATIC |
Aspect Ratio | de.cau.cs.kieler.aspectRatio | Float | Parents | 1.6 |
Border Spacing | de.cau.cs.kieler.borderSpacing | Float | Parents | 20 |
Comment Box XX | de.cau.cs.kieler.commentBox | Boolean | Nodes | false |
Debug Mode | de.cau.cs.kieler.debugMode | Boolean | Parents | false |
Diagram Type | de.cau.cs.kieler.diagramType | String | ||
Direction | de.cau.cs.kieler.direction | Enum | Parents | RIGHT |
Edge Label Placement XX | de.cau.cs.kieler.edgeLabelPlacement | Enum | Labels | UNDEFINED |
Edge Routing | de.cau.cs.kieler.edgeRouting | Enum | Parents | POLYLINE |
Hypernode XX | de.cau.cs.kieler.hypernode | Boolean | Nodes | false |
Label Side | de.cau.cs.kieler.labelSide | Enum | Parents | SMART |
Label Spacing XX | de.cau.cs.kieler.labelSpacing | Float | Edges Nodes | -1.0 |
Layout Hierarchy | de.cau.cs.kieler.layoutHierarchy | Boolean | Parents | false |
Minimal Height XX | de.cau.cs.kieler.minHeight | Float | Nodes | 0.0 |
Minimal Width XX | de.cau.cs.kieler.minWidth | Float | Nodes | 0.0 |
No Layout XX | de.cau.cs.kieler.noLayout | Boolean | false | |
Node Label Placement | de.cau.cs.kieler.nodeLabelPlacement | EnumSet | Nodes | |
Port Constraints | de.cau.cs.kieler.portConstraints | Enum | Nodes | UNDEFINED |
Port Label Placement | de.cau.cs.kieler.portLabelPlacement | Enum | Nodes | OUTSIDE |
Port Offset XX | de.cau.cs.kieler.offset | Float | Ports | |
Port Side XX | de.cau.cs.kieler.portSide | Enum | Ports | UNDEFINED |
Priority | de.cau.cs.kieler.priority | Int | Edges Nodes | |
Randomization Seed | de.cau.cs.kieler.randomSeed | Int | Parents | 1 |
Separate Connected Components | de.cau.cs.kieler.separateConnComp | Boolean | Parents | true |
Size Constraint | de.cau.cs.kieler.sizeConstraint | EnumSet | Nodes | |
Size Options | de.cau.cs.kieler.sizeOptions | EnumSet | Nodes | DEFAULT_MINIMUM_SIZE |
Spacing | de.cau.cs.kieler.spacing | Float | Parents | 20 |
Option | ID | Type | Applies to | Default | Dependency |
---|---|---|---|---|---|
Crossing Minimization | de.cau.cs.kieler.klay.layered.crossMin | Enum | Parents | LAYER_SWEEP | |
Cycle Breaking | de.cau.cs.kieler.klay.layered.cycleBreaking | Enum | Parents | GREEDY | |
Edge Spacing Factor | de.cau.cs.kieler.klay.layered.edgeSpacingFactor | Float | Parents | 0.5 | |
Feedback Edges | de.cau.cs.kieler.klay.layered.feedBackEdges | Boolean | Parents | false | |
Fixed Alignment | de.cau.cs.kieler.klay.layered.fixedAlignment | Enum | Parents | NONE | nodePlace=BRANDES_KOEPF |
Interactive Reference Point | de.cau.cs.kieler.klay.layered.interactiveReferencePoint | Enum | Parents | CENTER | |
Layer Constraint | de.cau.cs.kieler.klay.layered.layerConstraint | Enum | Nodes | NONE | |
Maximal Iterations | de.cau.cs.kieler.klay.layered.nodeLayering | Int | Parents | 10.000.000 | nodeLayering=NETWORK_SIMPLEX |
Merge Edges | de.cau.cs.kieler.klay.layered.mergePorts | Boolean | Parents | false | |
Merge Hierarchy-crossing Edges | de.cau.cs.kieler.klay.layered.mergeHierarchyPorts | Boolean | Parents | true | |
Node Layering | de.cau.cs.kieler.klay.layered.nodeLayering | Enum | Parents | NETWORK_SIMPLEX | |
Node Placement | de.cau.cs.kieler.klay.layered.nodePlace | Enum | Parents | BRANDES_KOEPF | |
Port Anchor Offset | de.cau.cs.kieler.klay.layered.portAnchor | Object | Ports | ||
Thoroughness | de.cau.cs.kieler.klay.layered.thoroughness | Int | Parents | 7 |
TODO: Write a bit of documentation about the most important layout options and how to use them, possibly with a simple example or something.
This section explains every layout option in more detail. See the KIML documentation for more information on KIML layout options. Those options are only mentioned here if KLay Layered adds some custom behavior.
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:
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:
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.
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:
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.
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.