Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of 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.

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.

...

OptionIDTypeApplies toDefault
Alignmentde.cau.cs.kieler.alignmentEnumNodesAUTOMATIC
Aspect Ratiode.cau.cs.kieler.aspectRatioFloatParents1.6
Border Spacingde.cau.cs.kieler.borderSpacingFloatParents20
Comment Box XXde.cau.cs.kieler.commentBoxBooleanNodesfalse
Debug Modede.cau.cs.kieler.debugModeBooleanParentsfalse
Diagram Typede.cau.cs.kieler.diagramTypeString  
Directionde.cau.cs.kieler.directionEnumParentsRIGHT
Edge Label Placement XXde.cau.cs.kieler.edgeLabelPlacementEnumLabelsUNDEFINED
Edge Routingde.cau.cs.kieler.edgeRoutingEnumParentsPOLYLINE
Hypernode XXde.cau.cs.kieler.hypernodeBooleanNodesfalse
Label Spacing XXde.cau.cs.kieler.labelSpacingFloatEdges
Nodes
-1.0
Layout Hierarchyde.cau.cs.kieler.layoutHierarchyBooleanParentsfalse
Minimal Height XXde.cau.cs.kieler.minHeightFloat

Nodes
Parents

0.0
Minimal Width XXde.cau.cs.kieler.minWidthFloat

Nodes
Parents

0.0
No Layout XXde.cau.cs.kieler.noLayoutBoolean false
Node Label Placementde.cau.cs.kieler.nodeLabelPlacementEnumSetNodes 
Port Constraintsde.cau.cs.kieler.portConstraintsEnumNodesUNDEFINED
Port Label Placementde.cau.cs.kieler.portLabelPlacementEnumNodesOUTSIDE
Port Offset XXde.cau.cs.kieler.offsetFloatPorts 
Port Side XXde.cau.cs.kieler.portSideEnumPortsUNDEFINED
Priorityde.cau.cs.kieler.priorityIntEdges
Nodes
 
Randomization Seedde.cau.cs.kieler.randomSeedIntParents1
Separate Connected Componentsde.cau.cs.kieler.separateConnCompBooleanParentstrue
Size Constraintde.cau.cs.kieler.sizeConstraintEnumSetNodes 
Size Optionsde.cau.cs.kieler.sizeOptionsEnumSetNodesDEFAULT_MINIMUM_SIZE
Spacingde.cau.cs.kieler.spacingFloatParents20

...

Custom Layout Options

OptionIDTypeApplies toDefault
Crossing Minimizationde.cau.cs.kieler.klay.layered.crossMinEnumParentsLAYER_SWEEP
Cycle Breakingde.cau.cs.kieler.klay.layered.cycleBreakingEnumParentsGREEDY
Distribute Nodesde.cau.cs.kieler.klay.layered.distributeNodesBooleanParentsfalse
Edge Spacing Factorde.cau.cs.kieler.klay.layered.edgeSpacingFactorFloatParents0.5
Feedback Edgesde.cau.cs.kieler.klay.layered.feedBackEdgesBooleanParentsfalse
Fixed Alignmentde.cau.cs.kieler.klay.layered.fixedAlignmentEnumParentsNONE
Interactive Reference Pointde.cau.cs.kieler.klay.layered.interactiveReferencePointEnumParentsCENTER
Label Sidede.cau.cs.kieler.klay.layered.LabelSideEnumParentsSMART
Layer Constraintde.cau.cs.kieler.klay.layered.layerConstraintEnumNodesNONE
Merge Edgesde.cau.cs.kieler.klay.layered.mergePortsBooleanParentsfalse
Node Layeringde.cau.cs.kieler.klay.layered.nodeLayeringEnumParentsNETWORK_SIMPLEX
Node Placementde.cau.cs.kieler.klay.layered.nodePlaceEnumParentsBRANDES_KOEPF
Port Anchor Offsetde.cau.cs.kieler.klay.layered.portAnchorObjectPorts 
Thoroughnessde.cau.cs.kieler.klay.layered.thoroughnessIntParents7

...