This page documents how KLay Layered implements label placement, port placement, and node sizing.
Introducing Important Stuff
When talking about label placement and node sizing, it helps to know what the two actually are. Let's start with node sizing:
Label placement can be divided into port label placement and node label placement:
Relationship Between Label Placement, Port Placement, and Node Sizing
At first glance, label placement and node sizing are two separate problems. However, out of the three types of labels we currently support, two have considerable influence on the size of nodes (node labels and port labels, but you already figured this out yourself). Well, in fact, that's not completely true. It's not the labels that influence the size of nodes, it's the placement of labels. And if we didn't care for readability, the placement wouldn't influence node size at all. But we do. Take this simple example:
The two nodes have two labelled ports each. Let's assume port positions to be fixed, and labels to be placed inside the nodes. While the port labels fit perfectly fine into Node 1, Node 2 is clearly too narrow for them to be placed without overlaps: we would have to increase the width of the node. Label placement influences node sizing.
Matters get more complicated if we allow port positions to be changed. If the western port is moved upwards and the eastern port downwards, the labels don't overlap any more. Thus, label placement also influences port placement.
Just how much and in what ways the three influence each other is one source of complexity. One important task in implementing label placement, port placement, and node sizing is to determine the cases where we simply give up. If the user gives us fixed node sizes and fixed port positions, he cannot expect us to find an overlap-free label placement if port labels are to be placed inside the node.
Anatomy of a Node
When it comes to label placement and node size calculations, we can think of a node as having the following anatomy:
The insets area is the part of the node where port and node labels are placed (if they are placed inside the node as opposed to outside the node). The child area is what is left of the node with the insets subtracted. With the
SizeOptions.COMPUTE_INSETS, KLay Layered can compute the child area and return it. This makes it easy to use in cases where the child area of the node is going to be used for displaying graphics or further text. If a minimum size is set on the node and the options
SizeOptions.MINIMUM_SIZE_ACCOUNTS_FOR_INSETS are set, the minimum size will effectively only apply to the child area. Thus, KLay Layered can be told to ensure that the child area of a node has at least a given size, whatever space the port labels and node labels require.
Limitations of Our Algorithms
We cannot support everything – actually, many combinations of label placement, port placement, and node sizing constraints don't even make much sense. So here's a (possibly still growing – science can only do so much...) list of things we don't support:
- More than one port label.
- Different placements for each node label. As of now, node labels are placed by arranging them in a vertical stack at the desired node label position.
The general approach to solving label placement, port placement, and node sizing follows the following general pattern:
- Place port labels
- Calculate required insets
- Resize node
- Place ports
- Place node labels
- Calculate insets
Each task will be described in more detail in the following.
Place Port Labels
Each port's labels are placed. The exact placement strategy may differ depending on node sizing and port placement constraints. The easiest way of placing port labels, however, is not to care about other constraints just yet.
Calculate Required Insets
Before resizing the node, we will need to find out how large it will have to be at the minimum. This requires iterating over ports and labels to find out how much space they will need, which is what this step is all about.
With the insets calculated, this step resizes the node, ensuring that the node size constraints are met. If the node is to have a minimum size, it may be resized accordingly, for instance. If ports are to be taken into account for the size calculation, the node size is adjusted to accommodate for its ports.
All ports are placed. If node sizing constraints allow for it, ports are placed in a way that ensures that port labels don't overlap each other. This is only possible, though, if
SizeConstraint.PORT_LABELSis set. In all other cases, we can only hope that the result is free of overlaps.
The only cases where we even have to talk about the placement of ports are those where their position is not fixed. That more or less leaves us with the three port constraints
FIXED_ORDER. The first is reduced to the second by assigning ports to the eastern or western side depending on the number of incoming and outgoing edges (if a port has more outgoing edges than incoming ones, it can be regarded as an output port). The second is reduced to the third during crossing minimization, in an attempt to find an order that will yield the fewest amount of edge crossings. Thus, the only case of real interest to us is
Port placement is influenced in the following ways by label placement and node sizing:
- Label Placement: Ports should be placed in a way that avoids label overlaps.
- Node Sizing: If node sizing doesn't pay any attention to ports, port placement options may be severely restricted.
Place Node Labels
With the node size set and ports placed, the node labels are now placed.
Layout Options Influencing This Stuff
The following layout options influence how the algorithm places ports and labels and calculates the node size:
Determines where node labels are placed. A valid set of values contains exactly one constant from each of the following sets of constants:
|Node||Determines where port labels are placed: inside or outside their node.|
|Graph||Determines the amount of space left between labels and the objects they label.|
|Node||The amount of freedom in determining the size of a node.|
|Node||Options for node size calculation.|
|Node||The minimal width of a node. If set, overrides the default minimal width.|
|Node||The minimal height of a node. If set, overrides the default minimal height.|
|Node||Freedom in placing ports.|
|Node||How much space should be left between ports.|