Skip to Content

Wiki source code of KIML Layout Options

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