Skip to Content

Wiki source code of KIML Layout Options

Version 18.1 by msp on 2014/03/07 17:04
Show last authors
1 {{warning}}
2 This is preliminary and incomplete documentation. You've been warned.
3 {{/warning}}
4
5 KIML defines a whole set of standard layout options that many layout algorithms support. Whether an algorithm supports a layout option depends on the option and on the algorithm. 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.
6
7 **Contents**
8
9
10
11 {{toc maxLevel="2"/}}
12
13 = Overview =
14
15 Beside a user-friendly name, layout options are defined by the following properties:
16
17 * An ID to identify them.
18 * A type. One of Boolean, String, Int, Float, Enum, EnumSet (a s{{code language="none"}}et{{/code}} 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.
19 * 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, or Labels.
20 * 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.
21
22 Layout options can be assigned to two main categories: user options and programmatic options.
23
24 == User Options ==
25
26 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.
27
28 |=(((
29 Option
30 )))|=(((
31 ID
32 )))|=(((
33 Type
34 )))|=(((
35 Applies to
36 )))|=(((
37 Default
38 )))
39 |(((
40 Alignment
41 )))|(((
42 de.cau.cs.kieler.alignment
43 )))|(((
44 Enum
45 )))|(((
46 Nodes
47 )))|(((
48 AUTOMATIC
49 )))
50 |(((
51 Aspect Ratio
52 )))|(((
53 de.cau.cs.kieler.aspectRatio
54 )))|(((
55 Float
56 )))|(((
57 Parents
58 )))|(((
59 0.0
60 )))
61 |(((
62 Bend Points
63 )))|(((
64 de.cau.cs.kieler.bendPoints
65 )))|(((
66 Object
67 )))|(((
68 Edges
69 )))|(((
70
71 )))
72 |(((
73 Border Spacing
74 )))|(((
75 de.cau.cs.kieler.borderSpacing
76 )))|(((
77 Float
78 )))|(((
79 Parents
80 )))|(((
81
82 )))
83 |(((
84 Debug Mode
85 )))|(((
86 de.cau.cs.kieler.debugMode
87 )))|(((
88 Boolean
89 )))|(((
90 Parents
91 )))|(((
92 false
93 )))
94 |(((
95 Direction
96 )))|(((
97 de.cau.cs.kieler.direction
98 )))|(((
99 Enum
100 )))|(((
101 Parents
102 )))|(((
103
104 )))
105 |(((
106 [[Edge Routing>>doc:||anchor="edgeRouting"]]
107 )))|(((
108 de.cau.cs.kieler.edgeRouting
109 )))|(((
110 Enum
111 )))|(((
112 Parents
113 )))|(((
114
115 )))
116 |(((
117 Expand Nodes
118 )))|(((
119 de.cau.cs.kieler.expandNodes
120 )))|(((
121 Boolean
122 )))|(((
123 Parents
124 )))|(((
125 false
126 )))
127 |(((
128 Interactive
129 )))|(((
130 de.cau.cs.kieler.interactive
131 )))|(((
132 Boolean
133 )))|(((
134 Parents
135 )))|(((
136 false
137 )))
138 |(((
139 Label Spacing
140 )))|(((
141 de.cau.cs.kieler.labelSpacing
142 )))|(((
143 Float
144 )))|(((
145 Edges
146 Nodes
147 )))|(((
148
149 )))
150 |(((
151 Layout Hierarchy
152 )))|(((
153 de.cau.cs.kieler.layoutHierarchy
154 )))|(((
155 Boolean
156 )))|(((
157 Parents
158 )))|(((
159 false
160 )))
161 |(((
162 [[Layout Algorithm>>doc:||anchor="layoutAlgorithm"]]
163 )))|(((
164 de.cau.cs.kieler.algorithm
165 )))|(((
166 String
167 )))|(((
168 Parents
169 )))|(((
170
171 )))
172 |(% colspan="1" %)(% colspan="1" %)
173 (((
174 Node Label Placement
175 )))|(% colspan="1" %)(% colspan="1" %)
176 (((
177 de.cau.cs.kieler.nodeLabelPlacement
178 )))|(% colspan="1" %)(% colspan="1" %)
179 (((
180 EnumSet
181 )))|(% colspan="1" %)(% colspan="1" %)
182 (((
183 Nodes
184 )))|(% colspan="1" %)(% colspan="1" %)
185 (((
186
187 )))
188 |(((
189 Port Constraints
190 )))|(((
191 de.cau.cs.kieler.portConstraints
192 )))|(((
193 Enum
194 )))|(((
195 Nodes
196 )))|(((
197
198 )))
199 |(% colspan="1" %)(% colspan="1" %)
200 (((
201 Port Label Placement
202 )))|(% colspan="1" %)(% colspan="1" %)
203 (((
204 de.cau.cs.kieler.portLabelPlacement
205 )))|(% colspan="1" %)(% colspan="1" %)
206 (((
207 Enum
208 )))|(% colspan="1" %)(% colspan="1" %)
209 (((
210 Nodes
211 )))|(% colspan="1" %)(% colspan="1" %)
212 (((
213 OUTSIDE
214 )))
215 |(% colspan="1" %)(% colspan="1" %)
216 (((
217 Port Spacing
218 )))|(% colspan="1" %)(% colspan="1" %)
219 (((
220 de.cau.cs.kieler.portSpacing
221 )))|(% colspan="1" %)(% colspan="1" %)
222 (((
223 Float
224 )))|(% colspan="1" %)(% colspan="1" %)
225 (((
226 Nodes
227 )))|(% colspan="1" %)(% colspan="1" %)
228 (((
229
230 )))
231 |(((
232 Position
233 )))|(((
234 de.cau.cs.kieler.position
235 )))|(((
236 Object
237 )))|(((
238 Labels
239 Nodes
240 Ports
241 )))|(((
242
243 )))
244 |(((
245 Priority
246 )))|(((
247 de.cau.cs.kieler.priority
248 )))|(((
249 Int
250 )))|(((
251 Edges
252 Nodes
253 )))|(((
254
255 )))
256 |(% colspan="1" %)(% colspan="1" %)
257 (((
258 Randomization Seed
259 )))|(% colspan="1" %)(% colspan="1" %)
260 (((
261 de.cau.cs.kieler.randomSeed
262 )))|(% colspan="1" %)(% colspan="1" %)
263 (((
264 Int
265 )))|(% colspan="1" %)(% colspan="1" %)
266 (((
267 Parents
268 )))|(% colspan="1" %)(% colspan="1" %)
269 (((
270
271 )))
272 |(% colspan="1" %)(% colspan="1" %)
273 (((
274 Separate Connected Components
275 )))|(% colspan="1" %)(% colspan="1" %)
276 (((
277 de.cau.cs.kieler.separateConnComp
278 )))|(% colspan="1" %)(% colspan="1" %)
279 (((
280 Boolean
281 )))|(% colspan="1" %)(% colspan="1" %)
282 (((
283 Parents
284 )))|(% colspan="1" %)(% colspan="1" %)
285 (((
286
287 )))
288 |(% colspan="1" %)(% colspan="1" %)
289 (((
290 Size Constraint
291 )))|(% colspan="1" %)(% colspan="1" %)
292 (((
293 de.cau.cs.kieler.sizeConstraint
294 )))|(% colspan="1" %)(% colspan="1" %)
295 (((
296 EnumSet
297 )))|(% colspan="1" %)(% colspan="1" %)
298 (((
299 Nodes
300 )))|(% colspan="1" %)(% colspan="1" %)
301 (((
302
303 )))
304 |(% colspan="1" %)(% colspan="1" %)
305 (((
306 Size Options
307 )))|(% colspan="1" %)(% colspan="1" %)
308 (((
309 de.cau.cs.kieler.sizeOptions
310 )))|(% colspan="1" %)(% colspan="1" %)
311 (((
312 EnumSet
313 )))|(% colspan="1" %)(% colspan="1" %)
314 (((
315 Nodes
316 )))|(% colspan="1" %)(% colspan="1" %)
317 (((
318 DEFAULT_MINIMUM_SIZE
319 )))
320 |(% colspan="1" %)(% colspan="1" %)
321 (((
322 Spacing
323 )))|(% colspan="1" %)(% colspan="1" %)
324 (((
325 de.cau.cs.kieler.spacing
326 )))|(% colspan="1" %)(% colspan="1" %)
327 (((
328 Float
329 )))|(% colspan="1" %)(% colspan="1" %)
330 (((
331 Parents
332 )))|(% colspan="1" %)(% colspan="1" %)
333 (((
334
335 )))
336
337 == Programmatic Options ==
338
339 Programmatic options are such that are meant to be configured exclusively through the KIML API. They should not be visible in the user interface.
340
341 |=(((
342 Option
343 )))|=(((
344 ID
345 )))|=(((
346 Type
347 )))|=(((
348 Applies to
349 )))|=(((
350 Default
351 )))
352 |(((
353 [[Diagram Type>>doc:||anchor="diagramType"]]
354 )))|(((
355 de.cau.cs.kieler.diagramType
356 )))|(((
357 String
358 )))|(((
359 Parents
360 )))|(((
361
362 )))
363 |(((
364 Edge Label Placement
365 )))|(((
366 de.cau.cs.kieler.edgeLabelPlacement
367 )))|(((
368 Enum
369 )))|(((
370 Labels
371 )))|(((
372
373 )))
374 |(% colspan="1" %)(% colspan="1" %)
375 (((
376 Edge Type
377 )))|(% colspan="1" %)(% colspan="1" %)
378 (((
379 de.cau.cs.kieler.edgeType
380 )))|(% colspan="1" %)(% colspan="1" %)
381 (((
382 Enum
383 )))|(% colspan="1" %)(% colspan="1" %)
384 (((
385 Edges
386 )))|(% colspan="1" %)(% colspan="1" %)
387 (((
388 NONE
389 )))
390 |(% colspan="1" %)(% colspan="1" %)
391 (((
392 Font Name
393 )))|(% colspan="1" %)(% colspan="1" %)
394 (((
395 de.cau.cs.kieler.fontName
396 )))|(% colspan="1" %)(% colspan="1" %)
397 (((
398 String
399 )))|(% colspan="1" %)(% colspan="1" %)
400 (((
401 Labels
402 )))|(% colspan="1" %)(% colspan="1" %)
403 (((
404
405 )))
406 |(% colspan="1" %)(% colspan="1" %)
407 (((
408 Font Size
409 )))|(% colspan="1" %)(% colspan="1" %)
410 (((
411 de.cau.cs.kieler.fontSize
412 )))|(% colspan="1" %)(% colspan="1" %)
413 (((
414 Int
415 )))|(% colspan="1" %)(% colspan="1" %)
416 (((
417 Labels
418 )))|(% colspan="1" %)(% colspan="1" %)
419 (((
420
421 )))
422 |(% colspan="1" %)(% colspan="1" %)
423 (((
424 Hypernode
425 )))|(% colspan="1" %)(% colspan="1" %)
426 (((
427 de.cau.cs.kieler.hypernode
428 )))|(% colspan="1" %)(% colspan="1" %)
429 (((
430 Boolean
431 )))|(% colspan="1" %)(% colspan="1" %)
432 (((
433 Nodes
434 )))|(% colspan="1" %)(% colspan="1" %)
435 (((
436 false
437 )))
438 |(% colspan="1" %)(% colspan="1" %)
439 (((
440 Minimal Height
441 )))|(% colspan="1" %)(% colspan="1" %)
442 (((
443 de.cau.cs.kieler.minHeight
444 )))|(% colspan="1" %)(% colspan="1" %)
445 (((
446 Float
447 )))|(% colspan="1" %)(% colspan="1" %)
448 (((
449 Nodes
450 Parents
451 )))|(% colspan="1" %)(% colspan="1" %)
452 (((
453 0.0
454 )))
455 |(% colspan="1" %)(% colspan="1" %)
456 (((
457 Minimal Width
458 )))|(% colspan="1" %)(% colspan="1" %)
459 (((
460 de.cau.cs.kieler.minWidth
461 )))|(% colspan="1" %)(% colspan="1" %)
462 (((
463 Float
464 )))|(% colspan="1" %)(% colspan="1" %)
465 (((
466 Nodes
467 Parents
468 )))|(% colspan="1" %)(% colspan="1" %)
469 (((
470 0.0
471 )))
472 |(% colspan="1" %)(% colspan="1" %)
473 (((
474 No Layout
475 )))|(% colspan="1" %)(% colspan="1" %)
476 (((
477 de.cau.cs.kieler.noLayout
478 )))|(% colspan="1" %)(% colspan="1" %)
479 (((
480 Boolean
481 )))|(% colspan="1" %)(% colspan="1" %)
482 (((
483
484 )))|(% colspan="1" %)(% colspan="1" %)
485 (((
486 false
487 )))
488 |(% colspan="1" %)(% colspan="1" %)
489 (((
490 [[Port Offset>>doc:||anchor="portOffset"]]
491 )))|(% colspan="1" %)(% colspan="1" %)
492 (((
493 de.cau.cs.kieler.offset
494 )))|(% colspan="1" %)(% colspan="1" %)
495 (((
496 Float
497 )))|(% colspan="1" %)(% colspan="1" %)
498 (((
499 Ports
500 )))|(% colspan="1" %)(% colspan="1" %)
501 (((
502
503 )))
504 |(% colspan="1" %)(% colspan="1" %)
505 (((
506 Port Side
507 )))|(% colspan="1" %)(% colspan="1" %)
508 (((
509 de.cau.cs.kieler.portSide
510 )))|(% colspan="1" %)(% colspan="1" %)
511 (((
512 Enum
513 )))|(% colspan="1" %)(% colspan="1" %)
514 (((
515 Ports
516 )))|(% colspan="1" %)(% colspan="1" %)
517 (((
518
519 )))
520
521 = Detailed Documentation =
522
523 == The Most Important Options ==
524
525 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.
526
527 === Layout Algorithm ===
528
529 {{id name="layoutAlgorithm"/}}
530
531 The option with identifier {{code language="none"}}de.cau.cs.kieler.algorithm{{/code}} specifies which layout algorithm to use for the content of a composite node. 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.
532
533 The following layout types are predefined:
534
535 * **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.
536 * **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.
537 * **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
538 * **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.
539 * **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.
540
541 === Available Algorithms and Libraries ===
542
543 * **The [[KLay Project>>doc:Layout Algorithms (KLay)]]** - Java implementations of standard layout approaches, augmented with special processing of graph features such as ports and edge labels.
544 * **Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
545 * (((
546 **Box Layout** - Ignores edges, places all nodes in rows. Can be used to layout collections of unconnected boxes, such as Statechart regions.
547 )))
548 * **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.
549 * **OGDF** ((% style="color: rgb(0,0,0);" %)[[www.ogdf.net>>url:http://www.ogdf.net/||shape="rect"]](%%)) - 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.
550 * **Graphviz** ([[www.graphviz.org>>url:http://www.graphviz.org/||shape="rect"]]) - 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.
551
552 === Diagram Type ===
553
554 {{id name="diagramType"/}}
555
556 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 {{code language="none"}}de.cau.cs.kieler.diagramType{{/code}}. 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.
557
558 The following diagram types are predefined:
559
560 * **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.
561 * **State Machine** - All kinds of state machines, automata, and activity diagrams. Examples: [[doc:SCCharts SyncCharts]], UML Activity diagrams.
562 * **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>>doc:Layout Algorithms (KLay)]].
563 * **Class Diagram** - Class diagrams such as Ecore diagrams for the [[EMF>>url:http://www.eclipse.org/modeling/emf/||shape="rect"]] or UML Class diagrams.
564 * **Use Case Diagram** - Use case diagrams as defined by the UML.
565 * **Unconnected Boxes** - Sets of nodes that have no connections and are treated as resizable boxes. This is related to mathematical [[packing problems>>url:http://en.wikipedia.org/wiki/Packing_problem||shape="rect"]]. Example: Regions in [[doc:SCCharts SyncCharts]].
566
567 == Other Options ==
568
569 * **Layout Hierarchy** ({{code language="none"}}de.cau.cs.kieler.layoutHierarchy{{/code}}) - 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.
570 * **Hypernode** ({{code language="none"}}de.cau.cs.kieler.hypernode{{/code}}) - 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>>url:http://en.wikipedia.org/wiki/Hypergraph||shape="rect"]]. Example: relation vertices in [[Ptolemy>>url:http://ptolemy.eecs.berkeley.edu/||shape="rect"]] models.
571 * **Comment Box** ({{code language="none"}}de.cau.cs.kieler.commentBox{{/code}}) - A node that is marked as comment box is treated as a label that needs to be placed somewhere. This is different to normal node labels, which are usually regarded as fixed.
572 * **No Layout** ({{code language="none"}}de.cau.cs.kieler.noLayout{{/code}}) - 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.
573
574 This section explains every layout option in more detail.
575
576 === Edge Routing ===
577
578 {{id name="edgeRouting"/}}
579
580 This option influences the way in which edges are routed between the nodes they connect. The following settings are available:
581
582 * POLYLINE
583 Edges consist of one or more segments defined by a list of bend points.
584 * ORTHOGONAL
585 Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically, but never at an angle.
586 * SPLINE
587 Edges are routed as splines (smooth curves). (% style="color: rgb(153,51,0);" %)**TODO:** Add more documentation on how the returned bend points are to be interpreted.
588 * UNDEFINED
589 No particular edge routing style is selected. The result produced by the layout algorithm may be undefined.
590
591 (% style="color: rgb(153,51,0);" %)**TODO:** Add an image illustrating the different routing styles.
592
593 === Port Offset ===
594
595 {{id name="portOffset"/}}
596
597 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.
598
599 Set this property if one of the following cases applies:
600
601 * The port constraints on a node are set to FREE, FIXED_SIDES or FIXED_ORDER.
602 * 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.)