KLay Layered Layout Options
KLay Layered supports a whole bunch of layout options. Every single one of them is documented here.
Contents
Overview
Beside a human-readable name, layout options are defined by the following properties:
- An ID to identify them.
- A type. One of Boolean, String, Int, Float, Enum, EnumSet (a Set over a given enumeration), or Object. The types Enum and EnumSet have to be further defined by an enumeration class. The Object type can be constricted to a certain class.
- The kinds of graph objects the option applies to. At least one of Parents (nodes that have children, including the diagram root node), Nodes, Edges, Ports, and Labels.
- An optional default value. If an option is not set on an object and if the option does not have a default value, null is returned when it is accessed.
KLay Layered supports layout options defined by KIML and defines additional custom layout options.
Supported KIML 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 Spacing XX | de.cau.cs.kieler.labelSpacing | Float | Edges | -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 |
|
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 |
KLay Layered Layout Options
Option | ID | Type | Applies to | Default |
|---|---|---|---|---|
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 |
Distribute Nodes | de.cau.cs.kieler.klay.layered.distributeNodes | Boolean | Parents | false |
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 |
Interactive Reference Point | de.cau.cs.kieler.klay.layered.interactiveReferencePoint | Enum | Parents | CENTER |
Label Side | de.cau.cs.kieler.klay.layered.LabelSide | Enum | Parents | SMART |
Layer Constraint | de.cau.cs.kieler.klay.layered.layerConstraint | Enum | Nodes | NONE |
Merge Edges | de.cau.cs.kieler.klay.layered.mergePorts | Boolean | Parents | false |
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 |
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 for more information on KIML layout options. Those options are only mentioned here if KLay Layered adds some custom behavior.