Skip to end of metadata
Go to start of metadata

 

KIML defines a whole set of standard layout options that many layout algorithms support. When an option is supported by an algorithm, that algorithm may override the option's default value. Algorithms may also provide more specialized documentation for layout options.

Contents

Overview

Beside a user-friendly 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 (a non-primitive Java object). The types Enum and EnumSet have to be further defined by an enumeration class. The Object type can be constricted to a certain Java class.
  • The kinds of graph objects the option applies to. At least one of Nodes, Edges, Ports, Labels, or Parents (nodes that have children, including the diagram root node). Parents-applicable options affect whole graphs or subgraphs, while options with other application targets affect only single graph elements.
  • An optional default value. A default value may also be provided by the layout algorithm using the option, or by the modeling application you are using. In these cases the value given here is overridden.

Layout options can be assigned to two main categories: user options and programmatic options.

User Options

User options are those that you can see in the "Layout View" available in Eclipse if the KIML user interface is installed. That view is restricted to layout options that are supported by the currently active layout algorithm. Furthermore, some options are visible only when the Show Advanced Properties button is active in the view.

OptionIDTypeApplies toDefault
Alignmentde.cau.cs.kieler.alignmentEnumNodesAUTOMATIC
Aspect Ratiode.cau.cs.kieler.aspectRatioFloatParents0.0
Bend Pointsde.cau.cs.kieler.bendPointsObjectEdges 
Border Spacingde.cau.cs.kieler.borderSpacingFloatParents 
Debug Modede.cau.cs.kieler.debugModeBooleanParentsfalse
Directionde.cau.cs.kieler.directionEnumParents 
Edge Routingde.cau.cs.kieler.edgeRoutingEnumParents 
Expand Nodesde.cau.cs.kieler.expandNodesBooleanParentsfalse
Interactivede.cau.cs.kieler.interactiveBooleanParentsfalse
Label Spacingde.cau.cs.kieler.labelSpacingFloatEdges
Nodes
 
Layout Hierarchyde.cau.cs.kieler.layoutHierarchyBooleanParentsfalse
Layout Algorithmde.cau.cs.kieler.algorithmStringParents 
Node Label Placementde.cau.cs.kieler.nodeLabelPlacementEnumSetNodes
Labels
 
Port Constraintsde.cau.cs.kieler.portConstraintsEnumNodes 
Port Label Placementde.cau.cs.kieler.portLabelPlacementEnumNodesOUTSIDE
Port Spacingde.cau.cs.kieler.portSpacingFloatNodes 
Port Alignmentde.cau.cs.kieler.portAlignmentEnum

Nodes
Parents

JUSTIFIED
Port Alignment for Northern Portsde.cau.cs.kieler.portAlignment.northEnum

Nodes
Parents

UNDEFINED
Port Alignment for Souther Portsde.cau.cs.kieler.portAlignment.southEnumNodes
Parents
UNDEFINED
Port Alignment for Eastern Portsde.cau.cs.kieler.portAlignment.eastEnumNodes
Parents
UNDEFINED
Port Alignment for Western Portsde.cau.cs.kieler.portAlignment.westEnumNodes
Parents
UNDEFINED
Positionde.cau.cs.kieler.positionObject

Labels
Nodes
Ports

 
Priorityde.cau.cs.kieler.priorityIntEdges
Nodes
 
Randomization Seedde.cau.cs.kieler.randomSeedIntParents 
Separate Connected Componentsde.cau.cs.kieler.separateConnCompBooleanParents 
Size Constraintde.cau.cs.kieler.sizeConstraintEnumSetNodes 
Size Optionsde.cau.cs.kieler.sizeOptionsEnumSetNodesDEFAULT_MINIMUM_SIZE
Spacingde.cau.cs.kieler.spacingFloatParents 

Programmatic Options

Programmatic options are such that are meant to be configured exclusively through the KIML API. They should not be visible in the user interface.

OptionIDTypeApplies toDefault
Additional Port Spacede.cau.cs.kieler.additionalPortSpaceMarginsNodes0, 0, 0, 0

Animate

de.cau.cs.kieler.animate

BooleanParentstrue

Animation Time Factor

de.cau.cs.kieler.animTimeFactor

IntParents100

Comment Box

de.cau.cs.kieler.commentBox

BooleanNodesfalse
Diagram Typede.cau.cs.kieler.diagramTypeStringParents 
Edge Label Placementde.cau.cs.kieler.edgeLabelPlacementEnumLabels 
Edge Typede.cau.cs.kieler.edgeTypeEnumEdgesNONE
Font Namede.cau.cs.kieler.fontNameStringLabels 
Font Sizede.cau.cs.kieler.fontSizeIntLabels 
Hypernodede.cau.cs.kieler.hypernodeBooleanNodesfalse

Layout Ancestors

de.cau.cs.kieler.layoutAncestors

BooleanParentsfalse

Maximal Animation Time

de.cau.cs.kieler.maxAnimTim

IntParents4000

Minimal Animation Time

de.cau.cs.kieler.minAnimTim

IntParents400
Minimal Heightde.cau.cs.kieler.minHeightFloat

Nodes
Parents

0.0
Minimal Widthde.cau.cs.kieler.minWidthFloat

Nodes
Parents

0.0
No Layoutde.cau.cs.kieler.noLayoutBoolean false
Port Anchor Offsetde.cau.cs.kieler.klay.layered.portAnchorObjectPorts 

Port Index

de.cau.cs.kieler.portIndex

IntPorts 
Port Offsetde.cau.cs.kieler.offsetFloatPorts 
Port Sidede.cau.cs.kieler.portSideEnumPorts 

Progress Bar

de.cau.cs.kieler.progressBar

BooleanParentsfalse
Scale Factor

de.cau.cs.kieler.scaleFactor

FloatNodes1.0
Thicknessde.cau.cs.kieler.thicknessFloatEdges1.0

Zoom to Fit

de.cau.cs.kieler.zoomToFit

BooleanParentsfalse

Layout Output Properties

A few properties are used as additional information in the output of a layout algorithm. This information should be considered when the layout is applied to the original diagram

PropertyIDTypeApplies to
Edge Routingde.cau.cs.kieler.edgeRoutingEnumEdges
Junction Points

de.cau.cs.kieler.junctionPoints

ObjectEdges

 

Detailed Documentation

This section explains every layout option in more detail.

The Most Important Options

While most layout options are used to affect how the active layout algorithm computes concrete coordinates for the graph elements, there are some layout options that have a special role in KIML.

Layout Algorithm

The option with identifier de.cau.cs.kieler.algorithm specifies which layout algorithm to use for a graph or subgraph. The value can be either the identifier of a layout algorithm or the identifier of a layout type. In the latter case the algorithm with highest priority of that type is applied. It is possible to set different values for this option on subgraphs of a hierarchical graph, where a subgraph is identified by a parent node. A layout algorithm is responsible to process only the direct content of a given parent node. An exception from this rule is made when the Layout Hierarchy option is active.

The following layout has been created by setting a force-based layout algorithm on the inner hierarchy level and a layer-based layout algorithm on the top level.

Available Algorithms and Libraries

  • The KLay Project - Java implementations of standard layout approaches, augmented with special processing of graph features such as ports and labels.
  • Randomizer - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
  • Box Layout - Ignores edges, places all nodes in rows. Can be used to layout collections of unconnected boxes, such as Statechart regions.

  • Fixed Layout - Does not compute a new layout, but leaves all nodes and edges where they are. If the Position and Bend Points options are set for the elements of the graph, the pre-defined layout is applied.
  • OGDF (www.ogdf.net) - A self-contained C++ class library for the automatic layout of diagrams. The version that is shipped with KIELER is compiled as an executable that reads files in OGML format and outputs the computed concrete layout.
  • Graphviz (www.graphviz.org) - An open source graph visualization tool with several graph layout programs, web and interactive graphical interfaces, auxiliary tools, libraries, and language bindings. Graphviz needs to be installed separately in order to be used within KIELER, since it is called in a separate process using the DOT language for communication.

Predefined Layout Types

  • Layered - The layer-based method emphasizes the direction of edges by pointing as many edges as possible into the same direction. The nodes are arranged in layers and then reordered such that the number of edge crossings is minimized. Afterwards, concrete coordinates are computed for the nodes and edge bend points.
  • Orthogonal - Orthogonal methods follow the "topology-shape-metrics" approach, which first applies a planarization technique, resulting in a planar representation of the graph, then compute an orthogonal shape, and finally determine concrete coordinates for nodes and edge bend points by applying a compaction method.
  • Force - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
  • Circular - Circular layout algorithms emphasize biconnected components of a graph by arranging them in circles. This is useful if a drawing is desired where such components are clearly grouped, or where cycles are shown as prominent properties of the graph.
  • Tree - Specialized layout methods for trees, i.e. acyclic graphs. The regular structure of graphs that have no undirected cycles can be emphasized using an algorithm of this type.

Diagram Type

Diagram types are used to classify graphical diagrams for setting default layout option values for a set of similar diagrams. The diagram type of an element is specified with the layout option de.cau.cs.kieler.diagramType. Layout algorithms can declare which diagram types they support well, and give a priority value for each supported type. KIML decides at runtime which layout algorithm has the highest priority for a given diagram, so that the most suitable algorithm is always used. Usual values for such priorities are between 1 and 10, where the highest value should only be assigned if the algorithm is especially designed for diagrams of the respective type, or if it has proven to be very adequate for them. Lower values should be given if the algorithm is able to draw the diagrams correctly, but with lower quality of the resulting layout.

The following diagram types are predefined:

  • General - This type is automatically assigned to all diagrams for which no specific type is declared. A layout algorithm that has the highest priority on the General diagram type is taken as the default algorithm when no further information on a diagram is available to KIML.
  • State Machine - All kinds of state machines, automata, and activity diagrams. Examples: SCCharts / SyncCharts, UML Activity diagrams.
  • Data Flow Diagram - Actor-oriented diagrams, where connections are mostly done between ports of nodes. These diagrams can only be handled properly by very special layout algorithms, such as those developed in the KLay project.
  • Class Diagram - Class diagrams such as Ecore diagrams for the EMF or UML Class diagrams.
  • Use Case Diagram - Use case diagrams as defined by the UML.
  • Unconnected Boxes - Sets of nodes that have no connections and are treated as resizable boxes. This is related to mathematical packing problems. Example: Regions in SCCharts / SyncCharts.

Edge Routing

This option influences the way in which edges are routed between the nodes they connect. The following settings are available:

  • POLYLINE
    Edges consist of one or more segments defined by a list of bend points.
  • ORTHOGONAL
    Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically.
  • SPLINES
    Edges are routed as splines (smooth curves).
  • UNDEFINED
    No particular edge routing style is selected. Usually this value points to the default setting of the selected layout algorithm.

When used as layout option, the edge routing is set for a whole graph or subgraph, i.e. on a parent node. However, the property is additionally used for the output of the layout algorithm in order to mark individual edges. If the edge routing assigned to an edge is anything other than SPLINES, the bend points of that edge are interpreted with their normal meaning, i.e. straight lines are drawn between consecutive bend points. If, on the other hand, a layout algorithm marks an edge with the value SPLINES, the bend points have to be interpreted as control points for a series of cubic splines following this procedure:

  1. Start at the source point of the edge.
  2. As long as there are at least three bend points left:
    1. Draw a cubic spline segment to the third bend point with the other two bend points as control points.
    2. Use the third bend point as start point for the next segment.
    3. Consume the three bend points and proceed to the next segment.
  3. Check the number of remaining bend points:
    1. Two bend points – draw a cubic spline segment to the target point of the edge.
    2. One bend point – draw a quadratic spline segment to the target point of the edge.
    3. No bend point – draw a straight line to the target point of the edge.

Other Options

Additional Port Space

This option controls the usable space for ports on each side:

If the option is not set, the value of Port Spacing is used instead for all four components.

This option is only relevant if port constraints are FREEFIXED_SIDE, or FIXED_ORDER. If size constraints include PORTS, the additional port space, together with the port spacing and the size of ports, determines a lower bound on the node size.

Alignment

Determines the alignment of a node in relation to other nodes of the same row or column. For layer-based algorithms, for instance, this option controls how a node is positioned inside its assigned layer.

Aspect Ratio

The aspect ratio of a drawing is the ratio of its total width to its total height. This option gives some control over that ratio, although in most cases it is only interpreted as a hint on how to arrange multiple connected components, hence the actual aspect ratio will probably be different from what has been specified with the option.

Comment Box

A node that is marked as comment box is treated as a label that needs to be placed somewhere. In contrast to normal node labels (modeled with a KLabel instance), comment boxes may have connections to other nodes, as in the following example.

Hypernode

A node that is marked as hypernode has a special role in the graph structure, since all its incident edges are treated as parts of the same hyperedge. Example: relation vertices in Ptolemy models.

Layout Hierarchy

If this option is supported and active, the layout algorithm is requested to process the full hierarchy contained in the input node. This means that instead of executing another algorithm on each hierarchy level, all levels are arranged in a single algorithm execution.

No Layout

Elements that are marked with this option are excluded from layout. This is used to identify diagram objects that should not be regarded as graph elements.

Port Alignment

The port alignment controls how ports are distributed over their respective edge.

This option is only relevant if port constraints are FREEFIXED_SIDE, or FIXED_ORDER.

The following settings are possible:

  • UNDEFINED
    Defaults to JUSTIFIED.
  • JUSTIFIED
    Distributes the ports evenly over the whole usable space (for usable space, see additional port space).
  • BEGIN
    Places the ports at top-/leftmost position with port spacing between them.
  • CENTER
    Places the ports centered in the usable space with port spacing between them.
  • END
    Places the ports at bottom-/rightmost position with port spacing between them.

Port alignment can also be set as specialized options portAlignment.{north|south|east|west}. These options overwrite the general policy for the respective side. Setting one of these to UNDEFINED defaults it to the general port alignment.

Port Anchor Offset

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:

Port Offset

The port offset is used to specify how much space a layout algorithm should leave between a port and the border of its node. This is usually zero, but doesn't have to be. If the offset is not defined for a given port, a layout algorithm can try to infer the offset from the port's coordinates and its node's size in the input graph. This of course requires both properties to be set to sensible values.

Set this property if one of the following cases applies:

  • The port constraints on a node are set to FREE, FIXED_SIDES or FIXED_ORDER.
  • The port constraints on a node are set to FIXED_RATIO or FIXED_POS, and the size of the node is not fixed. (Note that this is especially true for ports of compound nodes.)

Port Spacing

The port spacing determines how much space KLay Layered should leave between the ports of each side. This option is only relevant if the node size depends on the ports, that is, if the size constraints include SizeConstraint.PORTS.

  • No labels