Skip to Content

Wiki source code of KIML Layout Options

Version 28.1 by uru on 2015/01/28 15:54
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 (((
cds 26.1 215
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 (((
cds 26.1 352 [[Additional Port Space>>doc:||anchor="addPortSpace"]]
353 )))|(% colspan="1" %)(% colspan="1" %)
354 (((
355 de.cau.cs.kieler.additionalPortSpace
356 )))|(% colspan="1" %)(% colspan="1" %)
357 (((
358 Margins
359 )))|(% colspan="1" %)(% colspan="1" %)
360 (((
361 Nodes
362 )))|(% colspan="1" %)(% colspan="1" %)
363 (((
364 0, 0, 0, 0
365 )))
366 |(% colspan="1" %)(% colspan="1" %)
367 (((
msp 19.1 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 (((
uru 28.1 600 [[Port Anchor Offset>>doc:||anchor="portAnchor"]]
601 )))|(% colspan="1" %)(% colspan="1" %)
602 (((
603 de.cau.cs.kieler.klay.layered.portAnchor
604 )))|(% colspan="1" %)(% colspan="1" %)
605 (((
606 Object
607 )))|(% colspan="1" %)(% colspan="1" %)
608 (((
609 Ports
610 )))|(% colspan="1" %)(% colspan="1" %)
611 (((
612
613 )))
614 |(% colspan="1" %)(% colspan="1" %)
615 (((
msp 19.1 616 Port Index
617 )))|(% colspan="1" %)(% colspan="1" %)
618 (((
619 de.cau.cs.kieler.portIndex
620 )))|(% colspan="1" %)(% colspan="1" %)
621 (((
622 Int
623 )))|(% colspan="1" %)(% colspan="1" %)
624 (((
625 Ports
626 )))|(% colspan="1" %)(% colspan="1" %)
627 (((
628
629 )))
630 |(% colspan="1" %)(% colspan="1" %)
631 (((
msp 18.1 632 [[Port Offset>>doc:||anchor="portOffset"]]
633 )))|(% colspan="1" %)(% colspan="1" %)
634 (((
635 de.cau.cs.kieler.offset
636 )))|(% colspan="1" %)(% colspan="1" %)
637 (((
638 Float
639 )))|(% colspan="1" %)(% colspan="1" %)
640 (((
641 Ports
642 )))|(% colspan="1" %)(% colspan="1" %)
643 (((
644
645 )))
646 |(% colspan="1" %)(% colspan="1" %)
647 (((
648 Port Side
649 )))|(% colspan="1" %)(% colspan="1" %)
650 (((
651 de.cau.cs.kieler.portSide
652 )))|(% colspan="1" %)(% colspan="1" %)
653 (((
654 Enum
655 )))|(% colspan="1" %)(% colspan="1" %)
656 (((
657 Ports
658 )))|(% colspan="1" %)(% colspan="1" %)
659 (((
660
661 )))
msp 19.1 662 |(% colspan="1" %)(% colspan="1" %)
663 (((
664 Progress Bar
665 )))|(% colspan="1" %)(% colspan="1" %)
666 (((
667 de.cau.cs.kieler.progressBar
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 )))
678 |(% colspan="1" %)(% colspan="1" %)
679 (((
680 Scale Factor
681 )))|(% colspan="1" %)(% colspan="1" %)
682 (((
683 de.cau.cs.kieler.scaleFactor
684 )))|(% colspan="1" %)(% colspan="1" %)
685 (((
686 Float
687 )))|(% colspan="1" %)(% colspan="1" %)
688 (((
689 Nodes
690 )))|(% colspan="1" %)(% colspan="1" %)
691 (((
692 1.0
693 )))
694 |(% colspan="1" %)(% colspan="1" %)
695 (((
msp 23.1 696 Thickness
697 )))|(% colspan="1" %)(% colspan="1" %)
698 (((
699 de.cau.cs.kieler.thickness
700 )))|(% colspan="1" %)(% colspan="1" %)
701 (((
702 Float
703 )))|(% colspan="1" %)(% colspan="1" %)
704 (((
705 Edges
706 )))|(% colspan="1" %)(% colspan="1" %)
707 (((
708 1.0
709 )))
710 |(% colspan="1" %)(% colspan="1" %)
711 (((
msp 19.1 712 Zoom to Fit
713 )))|(% colspan="1" %)(% colspan="1" %)
714 (((
715 de.cau.cs.kieler.zoomToFit
716 )))|(% colspan="1" %)(% colspan="1" %)
717 (((
718 Boolean
719 )))|(% colspan="1" %)(% colspan="1" %)
720 (((
721 Parents
722 )))|(% colspan="1" %)(% colspan="1" %)
723 (((
724 false
725 )))
cds 1.1 726
msp 19.1 727 === Layout Output Properties ===
728
729 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
730
731 |=(((
732 Property
733 )))|=(((
734 ID
735 )))|=(((
736 Type
737 )))|=(((
738 Applies to
739 )))
740 |(((
741 [[Edge Routing>>doc:||anchor="edgeRouting"]]
742 )))|(((
743 de.cau.cs.kieler.edgeRouting
744 )))|(((
745 Enum
746 )))|(((
747 Edges
748 )))
749 |(((
750 Junction Points
751 )))|(((
752 de.cau.cs.kieler.junctionPoints
753 )))|(((
754 Object
755 )))|(((
756 Edges
757 )))
758
759
760
msp 18.1 761 = Detailed Documentation =
cds 1.1 762
msp 21.1 763 This section explains every layout option in more detail.
764
msp 18.1 765 == The Most Important Options ==
766
msp 16.1 767 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 768
msp 18.1 769 === Layout Algorithm ===
msp 16.1 770
771 {{id name="layoutAlgorithm"/}}
772
msp 21.1 773 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 774
msp 20.1 775 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 776
msp 20.1 777 [[image:attach:layout_algorithm.png]]
msp 16.1 778
msp 21.1 779 ==== Available Algorithms and Libraries ====
msp 16.1 780
msp 20.1 781 * **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 782 * **Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
783 * (((
784 **Box Layout** - Ignores edges, places all nodes in rows. Can be used to layout collections of unconnected boxes, such as Statechart regions.
785 )))
786 * **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.
787 * **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.
788 * **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.
789
msp 21.1 790 ==== Predefined Layout Types ====
msp 20.1 791
792 * **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.
793 * **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.
794 * **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
795 * **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.
796 * **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.
797
msp 18.1 798 === Diagram Type ===
msp 16.1 799
800 {{id name="diagramType"/}}
801
802 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.
803
804 The following diagram types are predefined:
805
806 * **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.
807 * **State Machine** - All kinds of state machines, automata, and activity diagrams. Examples: [[doc:SCCharts SyncCharts]], UML Activity diagrams.
808 * **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)]].
809 * **Class Diagram** - Class diagrams such as Ecore diagrams for the [[EMF>>url:http://www.eclipse.org/modeling/emf/||shape="rect"]] or UML Class diagrams.
810 * **Use Case Diagram** - Use case diagrams as defined by the UML.
811 * **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]].
812
msp 18.1 813 === Edge Routing ===
cds 12.1 814
815 {{id name="edgeRouting"/}}
816
817 This option influences the way in which edges are routed between the nodes they connect. The following settings are available:
818
819 * POLYLINE
820 Edges consist of one or more segments defined by a list of bend points.
821 * ORTHOGONAL
msp 21.1 822 Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically.
823 * SPLINES
824 Edges are routed as splines (smooth curves).
cds 12.1 825 * UNDEFINED
msp 21.1 826 No particular edge routing style is selected. Usually this value points to the default setting of the selected layout algorithm.
cds 12.1 827
msp 21.1 828 [[image:attach:edge_routing.png]]
cds 14.1 829
msp 21.1 830 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:
831
832 1. Start at the source point of the edge.
833 1. As long as there are at least three bend points left:
834 11. Draw a cubic spline segment to the third bend point with the other two bend points as control points.
835 11. Use the third bend point as start point for the next segment.
836 11. Consume the three bend points and proceed to the next segment.
837 1. Check the number of remaining bend points:
838 11. Two bend points – draw a cubic spline segment to the target point of the edge.
839 11. One bend point – draw a quadratic spline segment to the target point of the edge.
840 11. No bend point – draw a straight line to the target point of the edge.
841
842 == Other Options ==
843
cds 26.1 844 === Additional Port Space ===
845
846 {{id name="addPortSpace"/}}
847
848 This option controls additional port space left around the set of ports on each side:
849
cds 27.1 850 [[image:attach:addPortSpace.png]]
cds 26.1 851
cds 27.1 852 This option is only relevant if port constraints are {{code language="none"}}FREE{{/code}}, {{code language="none"}}FIXED_SIDE{{/code}}, or {{code language="none"}}FIXED_ORDER{{/code}}. If size constraints include {{code language="none"}}PORTS{{/code}}, the additional port space, together with the port spacing and the size of ports, determines a lower bound on the node size.
853
msp 22.1 854 === Alignment ===
855
856 {{id name="alignment"/}}
857
858 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.
859
860 === Aspect Ratio ===
861
862 {{id name="aspectRatio"/}}
863
864 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.
865
msp 21.1 866 === Comment Box ===
867
868 {{id name="commentBox"/}}
869
870 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.
871
872 [[image:attach:comment_box.png]]
873
874 === (% style="line-height: 1.5625;" %)Hypernode(%%) ===
875
876 {{id name="hypernode"/}}
877
878 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.
879
880 === Layout Hierarchy ===
881
882 {{id name="layoutHierarchy"/}}
883
884 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.
885
886 === No Layout ===
887
888 {{id name="noLayout"/}}
889
890 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.
891
uru 28.1 892 === Port Anchor Offset ===
893
894 {{id name="portAnchor"/}}
895
896
897
898 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.
899
900 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:
901
902 [[image:attach:KLay Layered Layout Options@port_anchors.png]]
903
msp 18.1 904 === Port Offset ===
cds 1.1 905
cds 9.1 906 {{id name="portOffset"/}}
cds 5.1 907
cds 1.1 908 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 909
910 Set this property if one of the following cases applies:
911
912 * The port constraints on a node are set to FREE, FIXED_SIDES or FIXED_ORDER.
913 * 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.)
cds 26.1 914
915 === Port Spacing ===
916
917 {{id name="portSpacing"/}}
918
919 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 {{code language="none"}}SizeConstraint.PORTS{{/code}}.