Skip to Content

Wiki source code of KIML Layout Options

Version 24.1 by cds on 2014/03/14 14:31
Hide last authors
msp 20.1 1
cds 1.1 2
msp 20.1 3 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.
cds 1.1 4
5 **Contents**
6
7
cds 7.1 8
msp 18.1 9 {{toc maxLevel="2"/}}
cds 7.1 10
cds 1.1 11 = Overview =
12
msp 18.1 13 Beside a user-friendly name, layout options are defined by the following properties:
cds 1.1 14
15 * An ID to identify them.
msp 18.1 16 * 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.
msp 19.1 17 * 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.
msp 18.1 18 * 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.
cds 1.1 19
msp 18.1 20 Layout options can be assigned to two main categories: user options and programmatic options.
cds 1.1 21
msp 18.1 22 == User Options ==
23
24 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.
25
cds 1.1 26 |=(((
27 Option
28 )))|=(((
29 ID
30 )))|=(((
31 Type
32 )))|=(((
33 Applies to
34 )))|=(((
35 Default
36 )))
37 |(((
msp 22.1 38 [[Alignment>>doc:||anchor="alignment"]]
cds 1.1 39 )))|(((
40 de.cau.cs.kieler.alignment
41 )))|(((
42 Enum
43 )))|(((
44 Nodes
45 )))|(((
46 AUTOMATIC
47 )))
48 |(((
msp 22.1 49 [[Aspect Ratio>>doc:||anchor="aspectRatio"]]
cds 1.1 50 )))|(((
51 de.cau.cs.kieler.aspectRatio
52 )))|(((
53 Float
54 )))|(((
55 Parents
56 )))|(((
57 0.0
58 )))
59 |(((
60 Bend Points
61 )))|(((
62 de.cau.cs.kieler.bendPoints
63 )))|(((
64 Object
65 )))|(((
66 Edges
67 )))|(((
68
69 )))
70 |(((
71 Border Spacing
72 )))|(((
73 de.cau.cs.kieler.borderSpacing
74 )))|(((
75 Float
76 )))|(((
77 Parents
78 )))|(((
msp 17.1 79
cds 1.1 80 )))
81 |(((
82 Debug Mode
83 )))|(((
84 de.cau.cs.kieler.debugMode
85 )))|(((
86 Boolean
87 )))|(((
88 Parents
89 )))|(((
90 false
91 )))
92 |(((
93 Direction
94 )))|(((
95 de.cau.cs.kieler.direction
96 )))|(((
97 Enum
98 )))|(((
99 Parents
100 )))|(((
msp 17.1 101
cds 1.1 102 )))
103 |(((
cds 13.1 104 [[Edge Routing>>doc:||anchor="edgeRouting"]]
cds 1.1 105 )))|(((
106 de.cau.cs.kieler.edgeRouting
107 )))|(((
108 Enum
109 )))|(((
110 Parents
111 )))|(((
msp 17.1 112
cds 1.1 113 )))
114 |(((
115 Expand Nodes
116 )))|(((
117 de.cau.cs.kieler.expandNodes
118 )))|(((
119 Boolean
120 )))|(((
121 Parents
122 )))|(((
123 false
124 )))
125 |(((
126 Interactive
127 )))|(((
128 de.cau.cs.kieler.interactive
129 )))|(((
130 Boolean
131 )))|(((
132 Parents
133 )))|(((
134 false
135 )))
cds 24.1 136 |(% colspan="1" %)(% colspan="1" %)
137 (((
138 Label Side
139 )))|(% colspan="1" %)(% colspan="1" %)
140 (((
141 de.cau.cs.kieler.labelSide
142 )))|(% colspan="1" %)(% colspan="1" %)
143 (((
144 Enum
145 )))|(% colspan="1" %)(% colspan="1" %)
146 (((
147 Parents
148 )))|(% colspan="1" %)(% colspan="1" %)
149 (((
150 SMART
151 )))
cds 1.1 152 |(((
153 Label Spacing
154 )))|(((
155 de.cau.cs.kieler.labelSpacing
156 )))|(((
157 Float
158 )))|(((
159 Edges
160 Nodes
161 )))|(((
msp 17.1 162
cds 1.1 163 )))
164 |(((
msp 21.1 165 [[Layout Hierarchy>>doc:||anchor="layoutHierarchy"]]
cds 1.1 166 )))|(((
167 de.cau.cs.kieler.layoutHierarchy
168 )))|(((
169 Boolean
170 )))|(((
171 Parents
172 )))|(((
173 false
174 )))
175 |(((
msp 16.1 176 [[Layout Algorithm>>doc:||anchor="layoutAlgorithm"]]
cds 1.1 177 )))|(((
178 de.cau.cs.kieler.algorithm
179 )))|(((
180 String
181 )))|(((
182 Parents
183 )))|(((
184
185 )))
186 |(% colspan="1" %)(% colspan="1" %)
187 (((
msp 18.1 188 Node Label Placement
cds 1.1 189 )))|(% colspan="1" %)(% colspan="1" %)
190 (((
msp 18.1 191 de.cau.cs.kieler.nodeLabelPlacement
cds 1.1 192 )))|(% colspan="1" %)(% colspan="1" %)
193 (((
msp 18.1 194 EnumSet
cds 1.1 195 )))|(% colspan="1" %)(% colspan="1" %)
196 (((
cds 3.1 197 Nodes
cds 1.1 198 )))|(% colspan="1" %)(% colspan="1" %)
199 (((
msp 18.1 200
cds 1.1 201 )))
msp 18.1 202 |(((
203 Port Constraints
204 )))|(((
205 de.cau.cs.kieler.portConstraints
206 )))|(((
207 Enum
208 )))|(((
cds 3.1 209 Nodes
msp 18.1 210 )))|(((
211
cds 1.1 212 )))
213 |(% colspan="1" %)(% colspan="1" %)
214 (((
msp 18.1 215 Port Label Placement
cds 1.1 216 )))|(% colspan="1" %)(% colspan="1" %)
217 (((
msp 18.1 218 de.cau.cs.kieler.portLabelPlacement
cds 1.1 219 )))|(% colspan="1" %)(% colspan="1" %)
220 (((
msp 18.1 221 Enum
cds 1.1 222 )))|(% colspan="1" %)(% colspan="1" %)
223 (((
msp 18.1 224 Nodes
cds 1.1 225 )))|(% colspan="1" %)(% colspan="1" %)
226 (((
msp 18.1 227 OUTSIDE
cds 1.1 228 )))
229 |(% colspan="1" %)(% colspan="1" %)
230 (((
msp 18.1 231 Port Spacing
cds 1.1 232 )))|(% colspan="1" %)(% colspan="1" %)
233 (((
msp 18.1 234 de.cau.cs.kieler.portSpacing
cds 1.1 235 )))|(% colspan="1" %)(% colspan="1" %)
236 (((
msp 18.1 237 Float
cds 1.1 238 )))|(% colspan="1" %)(% colspan="1" %)
239 (((
240 Nodes
241 )))|(% colspan="1" %)(% colspan="1" %)
242 (((
243
244 )))
245 |(((
msp 18.1 246 Position
cds 1.1 247 )))|(((
msp 18.1 248 de.cau.cs.kieler.position
cds 1.1 249 )))|(((
msp 18.1 250 Object
cds 1.1 251 )))|(((
msp 18.1 252 Labels
cds 1.1 253 Nodes
msp 18.1 254 Ports
cds 1.1 255 )))|(((
msp 17.1 256
cds 1.1 257 )))
msp 18.1 258 |(((
259 Priority
260 )))|(((
261 de.cau.cs.kieler.priority
262 )))|(((
263 Int
264 )))|(((
265 Edges
266 Nodes
267 )))|(((
268
269 )))
cds 1.1 270 |(% colspan="1" %)(% colspan="1" %)
271 (((
msp 18.1 272 Randomization Seed
cds 1.1 273 )))|(% colspan="1" %)(% colspan="1" %)
274 (((
msp 18.1 275 de.cau.cs.kieler.randomSeed
cds 1.1 276 )))|(% colspan="1" %)(% colspan="1" %)
277 (((
msp 18.1 278 Int
cds 1.1 279 )))|(% colspan="1" %)(% colspan="1" %)
280 (((
msp 18.1 281 Parents
cds 1.1 282 )))|(% colspan="1" %)(% colspan="1" %)
283 (((
msp 18.1 284
cds 1.1 285 )))
286 |(% colspan="1" %)(% colspan="1" %)
287 (((
msp 18.1 288 Separate Connected Components
cds 1.1 289 )))|(% colspan="1" %)(% colspan="1" %)
290 (((
msp 18.1 291 de.cau.cs.kieler.separateConnComp
cds 1.1 292 )))|(% colspan="1" %)(% colspan="1" %)
293 (((
msp 18.1 294 Boolean
cds 1.1 295 )))|(% colspan="1" %)(% colspan="1" %)
296 (((
msp 18.1 297 Parents
cds 1.1 298 )))|(% colspan="1" %)(% colspan="1" %)
299 (((
300
301 )))
302 |(% colspan="1" %)(% colspan="1" %)
303 (((
msp 18.1 304 Size Constraint
cds 1.1 305 )))|(% colspan="1" %)(% colspan="1" %)
306 (((
msp 18.1 307 de.cau.cs.kieler.sizeConstraint
cds 1.1 308 )))|(% colspan="1" %)(% colspan="1" %)
309 (((
msp 18.1 310 EnumSet
cds 1.1 311 )))|(% colspan="1" %)(% colspan="1" %)
312 (((
msp 18.1 313 Nodes
cds 1.1 314 )))|(% colspan="1" %)(% colspan="1" %)
315 (((
msp 17.1 316
cds 1.1 317 )))
msp 17.1 318 |(% colspan="1" %)(% colspan="1" %)
319 (((
msp 18.1 320 Size Options
msp 17.1 321 )))|(% colspan="1" %)(% colspan="1" %)
322 (((
msp 18.1 323 de.cau.cs.kieler.sizeOptions
msp 17.1 324 )))|(% colspan="1" %)(% colspan="1" %)
325 (((
msp 18.1 326 EnumSet
msp 17.1 327 )))|(% colspan="1" %)(% colspan="1" %)
328 (((
329 Nodes
330 )))|(% colspan="1" %)(% colspan="1" %)
331 (((
msp 18.1 332 DEFAULT_MINIMUM_SIZE
333 )))
334 |(% colspan="1" %)(% colspan="1" %)
335 (((
336 Spacing
337 )))|(% colspan="1" %)(% colspan="1" %)
338 (((
339 de.cau.cs.kieler.spacing
340 )))|(% colspan="1" %)(% colspan="1" %)
341 (((
342 Float
343 )))|(% colspan="1" %)(% colspan="1" %)
344 (((
345 Parents
346 )))|(% colspan="1" %)(% colspan="1" %)
347 (((
msp 17.1 348
349 )))
msp 18.1 350
351 == Programmatic Options ==
352
353 Programmatic options are such that are meant to be configured exclusively through the KIML API. They should not be visible in the user interface.
354
355 |=(((
356 Option
357 )))|=(((
358 ID
359 )))|=(((
360 Type
361 )))|=(((
362 Applies to
363 )))|=(((
364 Default
365 )))
msp 19.1 366 |(% colspan="1" %)(% colspan="1" %)
367 (((
368 Animate
369 )))|(% colspan="1" %)(% colspan="1" %)
370 (((
371 de.cau.cs.kieler.animate
372 )))|(% colspan="1" %)(% colspan="1" %)
373 (((
374 Boolean
375 )))|(% colspan="1" %)(% colspan="1" %)
376 (((
377 Parents
378 )))|(% colspan="1" %)(% colspan="1" %)
379 (((
380 true
381 )))
382 |(% colspan="1" %)(% colspan="1" %)
383 (((
384 Animation Time Factor
385 )))|(% colspan="1" %)(% colspan="1" %)
386 (((
387 de.cau.cs.kieler.animTimeFactor
388 )))|(% colspan="1" %)(% colspan="1" %)
389 (((
390 Int
391 )))|(% colspan="1" %)(% colspan="1" %)
392 (((
393 Parents
394 )))|(% colspan="1" %)(% colspan="1" %)
395 (((
396 100
397 )))
398 |(% colspan="1" %)(% colspan="1" %)
399 (((
msp 21.1 400 [[Comment Box>>doc:||anchor="commentBox"]]
msp 19.1 401 )))|(% colspan="1" %)(% colspan="1" %)
402 (((
403 de.cau.cs.kieler.commentBox
404 )))|(% colspan="1" %)(% colspan="1" %)
405 (((
406 Boolean
407 )))|(% colspan="1" %)(% colspan="1" %)
408 (((
409 Nodes
410 )))|(% colspan="1" %)(% colspan="1" %)
411 (((
412 false
413 )))
cds 1.1 414 |(((
msp 18.1 415 [[Diagram Type>>doc:||anchor="diagramType"]]
cds 1.1 416 )))|(((
msp 18.1 417 de.cau.cs.kieler.diagramType
cds 1.1 418 )))|(((
msp 18.1 419 String
cds 1.1 420 )))|(((
msp 18.1 421 Parents
cds 1.1 422 )))|(((
423
424 )))
425 |(((
msp 18.1 426 Edge Label Placement
cds 1.1 427 )))|(((
msp 18.1 428 de.cau.cs.kieler.edgeLabelPlacement
cds 1.1 429 )))|(((
msp 18.1 430 Enum
cds 1.1 431 )))|(((
msp 18.1 432 Labels
cds 1.1 433 )))|(((
434
435 )))
436 |(% colspan="1" %)(% colspan="1" %)
437 (((
msp 18.1 438 Edge Type
cds 1.1 439 )))|(% colspan="1" %)(% colspan="1" %)
440 (((
msp 18.1 441 de.cau.cs.kieler.edgeType
cds 1.1 442 )))|(% colspan="1" %)(% colspan="1" %)
443 (((
msp 18.1 444 Enum
cds 1.1 445 )))|(% colspan="1" %)(% colspan="1" %)
446 (((
msp 18.1 447 Edges
cds 1.1 448 )))|(% colspan="1" %)(% colspan="1" %)
449 (((
msp 18.1 450 NONE
451 )))
452 |(% colspan="1" %)(% colspan="1" %)
453 (((
454 Font Name
455 )))|(% colspan="1" %)(% colspan="1" %)
456 (((
457 de.cau.cs.kieler.fontName
458 )))|(% colspan="1" %)(% colspan="1" %)
459 (((
460 String
461 )))|(% colspan="1" %)(% colspan="1" %)
462 (((
463 Labels
464 )))|(% colspan="1" %)(% colspan="1" %)
465 (((
cds 1.1 466
467 )))
468 |(% colspan="1" %)(% colspan="1" %)
469 (((
msp 18.1 470 Font Size
cds 1.1 471 )))|(% colspan="1" %)(% colspan="1" %)
472 (((
msp 18.1 473 de.cau.cs.kieler.fontSize
cds 1.1 474 )))|(% colspan="1" %)(% colspan="1" %)
475 (((
msp 18.1 476 Int
cds 1.1 477 )))|(% colspan="1" %)(% colspan="1" %)
478 (((
msp 18.1 479 Labels
cds 1.1 480 )))|(% colspan="1" %)(% colspan="1" %)
481 (((
482
483 )))
484 |(% colspan="1" %)(% colspan="1" %)
485 (((
msp 21.1 486 [[Hypernode>>doc:||anchor="hypernode"]]
cds 1.1 487 )))|(% colspan="1" %)(% colspan="1" %)
488 (((
msp 18.1 489 de.cau.cs.kieler.hypernode
cds 1.1 490 )))|(% colspan="1" %)(% colspan="1" %)
491 (((
msp 18.1 492 Boolean
cds 1.1 493 )))|(% colspan="1" %)(% colspan="1" %)
494 (((
495 Nodes
496 )))|(% colspan="1" %)(% colspan="1" %)
497 (((
msp 18.1 498 false
cds 1.1 499 )))
500 |(% colspan="1" %)(% colspan="1" %)
501 (((
msp 19.1 502 Layout Ancestors
503 )))|(% colspan="1" %)(% colspan="1" %)
504 (((
505 de.cau.cs.kieler.layoutAncestors
506 )))|(% colspan="1" %)(% colspan="1" %)
507 (((
508 Boolean
509 )))|(% colspan="1" %)(% colspan="1" %)
510 (((
511 Parents
512 )))|(% colspan="1" %)(% colspan="1" %)
513 (((
514 false
515 )))
516 |(% colspan="1" %)(% colspan="1" %)
517 (((
518 Maximal Animation Time
519 )))|(% colspan="1" %)(% colspan="1" %)
520 (((
521 de.cau.cs.kieler.maxAnimTim
522 )))|(% colspan="1" %)(% colspan="1" %)
523 (((
524 Int
525 )))|(% colspan="1" %)(% colspan="1" %)
526 (((
527 Parents
528 )))|(% colspan="1" %)(% colspan="1" %)
529 (((
530 4000
531 )))
532 |(% colspan="1" %)(% colspan="1" %)
533 (((
534 Minimal Animation Time
535 )))|(% colspan="1" %)(% colspan="1" %)
536 (((
537 de.cau.cs.kieler.minAnimTim
538 )))|(% colspan="1" %)(% colspan="1" %)
539 (((
540 Int
541 )))|(% colspan="1" %)(% colspan="1" %)
542 (((
543 Parents
544 )))|(% colspan="1" %)(% colspan="1" %)
545 (((
546 400
547 )))
548 |(% colspan="1" %)(% colspan="1" %)
549 (((
msp 18.1 550 Minimal Height
cds 1.1 551 )))|(% colspan="1" %)(% colspan="1" %)
552 (((
msp 18.1 553 de.cau.cs.kieler.minHeight
cds 1.1 554 )))|(% colspan="1" %)(% colspan="1" %)
555 (((
msp 18.1 556 Float
cds 1.1 557 )))|(% colspan="1" %)(% colspan="1" %)
558 (((
559 Nodes
msp 18.1 560 Parents
cds 1.1 561 )))|(% colspan="1" %)(% colspan="1" %)
562 (((
msp 18.1 563 0.0
cds 1.1 564 )))
565 |(% colspan="1" %)(% colspan="1" %)
566 (((
msp 18.1 567 Minimal Width
cds 1.1 568 )))|(% colspan="1" %)(% colspan="1" %)
569 (((
msp 18.1 570 de.cau.cs.kieler.minWidth
cds 1.1 571 )))|(% colspan="1" %)(% colspan="1" %)
572 (((
573 Float
574 )))|(% colspan="1" %)(% colspan="1" %)
575 (((
msp 18.1 576 Nodes
cds 1.1 577 Parents
578 )))|(% colspan="1" %)(% colspan="1" %)
579 (((
msp 18.1 580 0.0
581 )))
582 |(% colspan="1" %)(% colspan="1" %)
583 (((
msp 21.1 584 [[No Layout>>doc:||anchor="noLayout"]]
msp 18.1 585 )))|(% colspan="1" %)(% colspan="1" %)
586 (((
587 de.cau.cs.kieler.noLayout
588 )))|(% colspan="1" %)(% colspan="1" %)
589 (((
590 Boolean
591 )))|(% colspan="1" %)(% colspan="1" %)
592 (((
msp 17.1 593
msp 18.1 594 )))|(% colspan="1" %)(% colspan="1" %)
595 (((
596 false
cds 1.1 597 )))
msp 18.1 598 |(% colspan="1" %)(% colspan="1" %)
599 (((
msp 19.1 600 Port Index
601 )))|(% colspan="1" %)(% colspan="1" %)
602 (((
603 de.cau.cs.kieler.portIndex
604 )))|(% colspan="1" %)(% colspan="1" %)
605 (((
606 Int
607 )))|(% colspan="1" %)(% colspan="1" %)
608 (((
609 Ports
610 )))|(% colspan="1" %)(% colspan="1" %)
611 (((
612
613 )))
614 |(% colspan="1" %)(% colspan="1" %)
615 (((
msp 18.1 616 [[Port Offset>>doc:||anchor="portOffset"]]
617 )))|(% colspan="1" %)(% colspan="1" %)
618 (((
619 de.cau.cs.kieler.offset
620 )))|(% colspan="1" %)(% colspan="1" %)
621 (((
622 Float
623 )))|(% colspan="1" %)(% colspan="1" %)
624 (((
625 Ports
626 )))|(% colspan="1" %)(% colspan="1" %)
627 (((
628
629 )))
630 |(% colspan="1" %)(% colspan="1" %)
631 (((
632 Port Side
633 )))|(% colspan="1" %)(% colspan="1" %)
634 (((
635 de.cau.cs.kieler.portSide
636 )))|(% colspan="1" %)(% colspan="1" %)
637 (((
638 Enum
639 )))|(% colspan="1" %)(% colspan="1" %)
640 (((
641 Ports
642 )))|(% colspan="1" %)(% colspan="1" %)
643 (((
644
645 )))
msp 19.1 646 |(% colspan="1" %)(% colspan="1" %)
647 (((
648 Progress Bar
649 )))|(% colspan="1" %)(% colspan="1" %)
650 (((
651 de.cau.cs.kieler.progressBar
652 )))|(% colspan="1" %)(% colspan="1" %)
653 (((
654 Boolean
655 )))|(% colspan="1" %)(% colspan="1" %)
656 (((
657 Parents
658 )))|(% colspan="1" %)(% colspan="1" %)
659 (((
660 false
661 )))
662 |(% colspan="1" %)(% colspan="1" %)
663 (((
664 Scale Factor
665 )))|(% colspan="1" %)(% colspan="1" %)
666 (((
667 de.cau.cs.kieler.scaleFactor
668 )))|(% colspan="1" %)(% colspan="1" %)
669 (((
670 Float
671 )))|(% colspan="1" %)(% colspan="1" %)
672 (((
673 Nodes
674 )))|(% colspan="1" %)(% colspan="1" %)
675 (((
676 1.0
677 )))
678 |(% colspan="1" %)(% colspan="1" %)
679 (((
msp 23.1 680 Thickness
681 )))|(% colspan="1" %)(% colspan="1" %)
682 (((
683 de.cau.cs.kieler.thickness
684 )))|(% colspan="1" %)(% colspan="1" %)
685 (((
686 Float
687 )))|(% colspan="1" %)(% colspan="1" %)
688 (((
689 Edges
690 )))|(% colspan="1" %)(% colspan="1" %)
691 (((
692 1.0
693 )))
694 |(% colspan="1" %)(% colspan="1" %)
695 (((
msp 19.1 696 Zoom to Fit
697 )))|(% colspan="1" %)(% colspan="1" %)
698 (((
699 de.cau.cs.kieler.zoomToFit
700 )))|(% colspan="1" %)(% colspan="1" %)
701 (((
702 Boolean
703 )))|(% colspan="1" %)(% colspan="1" %)
704 (((
705 Parents
706 )))|(% colspan="1" %)(% colspan="1" %)
707 (((
708 false
709 )))
cds 1.1 710
msp 19.1 711 === Layout Output Properties ===
712
713 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
714
715 |=(((
716 Property
717 )))|=(((
718 ID
719 )))|=(((
720 Type
721 )))|=(((
722 Applies to
723 )))
724 |(((
725 [[Edge Routing>>doc:||anchor="edgeRouting"]]
726 )))|(((
727 de.cau.cs.kieler.edgeRouting
728 )))|(((
729 Enum
730 )))|(((
731 Edges
732 )))
733 |(((
734 Junction Points
735 )))|(((
736 de.cau.cs.kieler.junctionPoints
737 )))|(((
738 Object
739 )))|(((
740 Edges
741 )))
742
743
744
msp 18.1 745 = Detailed Documentation =
cds 1.1 746
msp 21.1 747 This section explains every layout option in more detail.
748
msp 18.1 749 == The Most Important Options ==
750
msp 16.1 751 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.
cds 1.1 752
msp 18.1 753 === Layout Algorithm ===
msp 16.1 754
755 {{id name="layoutAlgorithm"/}}
756
msp 21.1 757 The option with identifier {{code language="none"}}de.cau.cs.kieler.algorithm{{/code}} 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>>doc:||anchor="layoutHierarchy"]] option is active.
msp 16.1 758
msp 20.1 759 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.
msp 16.1 760
msp 20.1 761 [[image:attach:layout_algorithm.png]]
msp 16.1 762
msp 21.1 763 ==== Available Algorithms and Libraries ====
msp 16.1 764
msp 20.1 765 * **The [[KLay Project>>doc:Layout Algorithms (KLay)]]** - Java implementations of standard layout approaches, augmented with special processing of graph features such as ports and labels.
msp 16.1 766 * **Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
767 * (((
768 **Box Layout** - Ignores edges, places all nodes in rows. Can be used to layout collections of unconnected boxes, such as Statechart regions.
769 )))
770 * **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.
771 * **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.
772 * **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.
773
msp 21.1 774 ==== Predefined Layout Types ====
msp 20.1 775
776 * **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.
777 * **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.
778 * **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
779 * **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.
780 * **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.
781
msp 18.1 782 === Diagram Type ===
msp 16.1 783
784 {{id name="diagramType"/}}
785
786 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.
787
788 The following diagram types are predefined:
789
790 * **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.
791 * **State Machine** - All kinds of state machines, automata, and activity diagrams. Examples: [[doc:SCCharts SyncCharts]], UML Activity diagrams.
792 * **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)]].
793 * **Class Diagram** - Class diagrams such as Ecore diagrams for the [[EMF>>url:http://www.eclipse.org/modeling/emf/||shape="rect"]] or UML Class diagrams.
794 * **Use Case Diagram** - Use case diagrams as defined by the UML.
795 * **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]].
796
msp 18.1 797 === Edge Routing ===
cds 12.1 798
799 {{id name="edgeRouting"/}}
800
801 This option influences the way in which edges are routed between the nodes they connect. The following settings are available:
802
803 * POLYLINE
804 Edges consist of one or more segments defined by a list of bend points.
805 * ORTHOGONAL
msp 21.1 806 Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically.
807 * SPLINES
808 Edges are routed as splines (smooth curves).
cds 12.1 809 * UNDEFINED
msp 21.1 810 No particular edge routing style is selected. Usually this value points to the default setting of the selected layout algorithm.
cds 12.1 811
msp 21.1 812 [[image:attach:edge_routing.png]]
cds 14.1 813
msp 21.1 814 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:
815
816 1. Start at the source point of the edge.
817 1. As long as there are at least three bend points left:
818 11. Draw a cubic spline segment to the third bend point with the other two bend points as control points.
819 11. Use the third bend point as start point for the next segment.
820 11. Consume the three bend points and proceed to the next segment.
821 1. Check the number of remaining bend points:
822 11. Two bend points – draw a cubic spline segment to the target point of the edge.
823 11. One bend point – draw a quadratic spline segment to the target point of the edge.
824 11. No bend point – draw a straight line to the target point of the edge.
825
826 == Other Options ==
827
msp 22.1 828 === Alignment ===
829
830 {{id name="alignment"/}}
831
832 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.
833
834 === Aspect Ratio ===
835
836 {{id name="aspectRatio"/}}
837
838 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.
839
msp 21.1 840 === Comment Box ===
841
842 {{id name="commentBox"/}}
843
844 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.
845
846 [[image:attach:comment_box.png]]
847
848 === (% style="line-height: 1.5625;" %)Hypernode(%%) ===
849
850 {{id name="hypernode"/}}
851
852 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.
853
854 === Layout Hierarchy ===
855
856 {{id name="layoutHierarchy"/}}
857
858 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.
859
860 === No Layout ===
861
862 {{id name="noLayout"/}}
863
864 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.
865
msp 18.1 866 === Port Offset ===
cds 1.1 867
cds 9.1 868 {{id name="portOffset"/}}
cds 5.1 869
cds 1.1 870 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.
cds 3.1 871
872 Set this property if one of the following cases applies:
873
874 * The port constraints on a node are set to FREE, FIXED_SIDES or FIXED_ORDER.
875 * 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.)