Skip to Content

Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
From version 23.1
edited by msp
on 2014/03/13 10:36
Change comment: There is no comment for this version
To version 15.1
edited by cds
on 2013/06/03 12:41
Change comment: Migrated to Confluence 5.3

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.msp
1 +XWiki.cds
Content
... ... @@ -1,28 +1,26 @@
1 -
1 +{{warning}}
2 +This is preliminary and incomplete documentation. You've been warned.
3 +{{/warning}}
2 2  
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.
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, it may change the option's default value. Algorithms may also provide more specialized documentation for a given layout option.
4 4  
5 5  **Contents**
6 6  
7 7  
8 8  
9 -{{toc maxLevel="2"/}}
11 +{{toc/}}
10 10  
11 11  = Overview =
12 12  
13 -Beside a user-friendly name, layout options are defined by the following properties:
15 +Beside a human-readable name, layout options are defined by the following properties:
14 14  
15 15  * An ID to identify them.
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.
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.
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.
18 +* A type. One of Boolean, String, Int, Float, Enum, EnumSet (a {{code language="none"}}Set{{/code}} over a given enumeration), or Object. The types Enum and EnumSet have to be further defined by an enumeration class. The Object type can be constricted to a certain 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, and Labels.
20 +* An optional default value. If an option is not set on an object and if the option does not have a default value, {{code language="none"}}null{{/code}} is returned when it is accessed.
19 19  
20 -Layout options can be assigned to two main categories: user options and programmatic options.
22 +KIML defines the following set of layout options:
21 21  
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 -
26 26  |=(((
27 27  Option
28 28  )))|=(((
... ... @@ -35,7 +35,7 @@
35 35  Default
36 36  )))
37 37  |(((
38 -[[Alignment>>doc:||anchor="alignment"]]
36 +Alignment
39 39  )))|(((
40 40  de.cau.cs.kieler.alignment
41 41  )))|(((
... ... @@ -46,7 +46,7 @@
46 46  AUTOMATIC
47 47  )))
48 48  |(((
49 -[[Aspect Ratio>>doc:||anchor="aspectRatio"]]
47 +Aspect Ratio
50 50  )))|(((
51 51  de.cau.cs.kieler.aspectRatio
52 52  )))|(((
... ... @@ -76,347 +76,89 @@
76 76  )))|(((
77 77  Parents
78 78  )))|(((
79 -
77 +-1.0
80 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 -)))|(((
101 -
102 -)))
103 -|(((
104 -[[Edge Routing>>doc:||anchor="edgeRouting"]]
105 -)))|(((
106 -de.cau.cs.kieler.edgeRouting
107 -)))|(((
108 -Enum
109 -)))|(((
110 -Parents
111 -)))|(((
112 -
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 -)))|(((
146 -
147 -)))
148 -|(((
149 -[[Layout Hierarchy>>doc:||anchor="layoutHierarchy"]]
150 -)))|(((
151 -de.cau.cs.kieler.layoutHierarchy
152 -)))|(((
153 -Boolean
154 -)))|(((
155 -Parents
156 -)))|(((
157 -false
158 -)))
159 -|(((
160 -[[Layout Algorithm>>doc:||anchor="layoutAlgorithm"]]
161 -)))|(((
162 -de.cau.cs.kieler.algorithm
163 -)))|(((
164 -String
165 -)))|(((
166 -Parents
167 -)))|(((
168 -
169 -)))
170 170  |(% colspan="1" %)(% colspan="1" %)
171 171  (((
172 -Node Label Placement
81 +Comment Box
173 173  )))|(% colspan="1" %)(% colspan="1" %)
174 174  (((
175 -de.cau.cs.kieler.nodeLabelPlacement
84 +de.cau.cs.kieler.commentBox
176 176  )))|(% colspan="1" %)(% colspan="1" %)
177 177  (((
178 -EnumSet
87 +Boolean
179 179  )))|(% colspan="1" %)(% colspan="1" %)
180 180  (((
181 181  Nodes
182 182  )))|(% colspan="1" %)(% colspan="1" %)
183 183  (((
184 -
93 +false
185 185  )))
186 186  |(((
187 -Port Constraints
96 +Debug Mode
188 188  )))|(((
189 -de.cau.cs.kieler.portConstraints
98 +de.cau.cs.kieler.debugMode
190 190  )))|(((
191 -Enum
100 +Boolean
192 192  )))|(((
193 -Nodes
102 +Parents
194 194  )))|(((
195 -
104 +false
196 196  )))
197 197  |(% colspan="1" %)(% colspan="1" %)
198 198  (((
199 -Port Label Placement
108 +Diagram Type
200 200  )))|(% colspan="1" %)(% colspan="1" %)
201 201  (((
202 -de.cau.cs.kieler.portLabelPlacement
111 +de.cau.cs.kieler.diagramType
203 203  )))|(% colspan="1" %)(% colspan="1" %)
204 204  (((
205 -Enum
114 +String
206 206  )))|(% colspan="1" %)(% colspan="1" %)
207 207  (((
208 -Nodes
117 +
209 209  )))|(% colspan="1" %)(% colspan="1" %)
210 210  (((
211 -OUTSIDE
212 -)))
213 -|(% colspan="1" %)(% colspan="1" %)
214 -(((
215 -Port Spacing
216 -)))|(% colspan="1" %)(% colspan="1" %)
217 -(((
218 -de.cau.cs.kieler.portSpacing
219 -)))|(% colspan="1" %)(% colspan="1" %)
220 -(((
221 -Float
222 -)))|(% colspan="1" %)(% colspan="1" %)
223 -(((
224 -Nodes
225 -)))|(% colspan="1" %)(% colspan="1" %)
226 -(((
227 227  
228 228  )))
229 229  |(((
230 -Position
123 +Direction
231 231  )))|(((
232 -de.cau.cs.kieler.position
125 +de.cau.cs.kieler.direction
233 233  )))|(((
234 -Object
127 +Enum
235 235  )))|(((
236 -Labels
237 -Nodes
238 -Ports
129 +Parents
239 239  )))|(((
240 -
131 +UNDEFINED
241 241  )))
242 -|(((
243 -Priority
244 -)))|(((
245 -de.cau.cs.kieler.priority
246 -)))|(((
247 -Int
248 -)))|(((
249 -Edges
250 -Nodes
251 -)))|(((
252 -
253 -)))
254 254  |(% colspan="1" %)(% colspan="1" %)
255 255  (((
256 -Randomization Seed
135 +Edge Label Placement
257 257  )))|(% colspan="1" %)(% colspan="1" %)
258 258  (((
259 -de.cau.cs.kieler.randomSeed
138 +de.cau.cs.kieler.edgeLabelPlacement
260 260  )))|(% colspan="1" %)(% colspan="1" %)
261 261  (((
262 -Int
141 +Enum
263 263  )))|(% colspan="1" %)(% colspan="1" %)
264 264  (((
265 -Parents
144 +Labels
266 266  )))|(% colspan="1" %)(% colspan="1" %)
267 267  (((
268 -
147 +UNDEFINED
269 269  )))
270 -|(% colspan="1" %)(% colspan="1" %)
271 -(((
272 -Separate Connected Components
273 -)))|(% colspan="1" %)(% colspan="1" %)
274 -(((
275 -de.cau.cs.kieler.separateConnComp
276 -)))|(% colspan="1" %)(% colspan="1" %)
277 -(((
278 -Boolean
279 -)))|(% colspan="1" %)(% colspan="1" %)
280 -(((
281 -Parents
282 -)))|(% colspan="1" %)(% colspan="1" %)
283 -(((
284 -
285 -)))
286 -|(% colspan="1" %)(% colspan="1" %)
287 -(((
288 -Size Constraint
289 -)))|(% colspan="1" %)(% colspan="1" %)
290 -(((
291 -de.cau.cs.kieler.sizeConstraint
292 -)))|(% colspan="1" %)(% colspan="1" %)
293 -(((
294 -EnumSet
295 -)))|(% colspan="1" %)(% colspan="1" %)
296 -(((
297 -Nodes
298 -)))|(% colspan="1" %)(% colspan="1" %)
299 -(((
300 -
301 -)))
302 -|(% colspan="1" %)(% colspan="1" %)
303 -(((
304 -Size Options
305 -)))|(% colspan="1" %)(% colspan="1" %)
306 -(((
307 -de.cau.cs.kieler.sizeOptions
308 -)))|(% colspan="1" %)(% colspan="1" %)
309 -(((
310 -EnumSet
311 -)))|(% colspan="1" %)(% colspan="1" %)
312 -(((
313 -Nodes
314 -)))|(% colspan="1" %)(% colspan="1" %)
315 -(((
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 -(((
332 -
333 -)))
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 -)))
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 -(((
384 -[[Comment Box>>doc:||anchor="commentBox"]]
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 -)))
398 398  |(((
399 -[[Diagram Type>>doc:||anchor="diagramType"]]
150 +[[Edge Routing>>doc:||anchor="edgeRouting"]]
400 400  )))|(((
401 -de.cau.cs.kieler.diagramType
152 +de.cau.cs.kieler.edgeRouting
402 402  )))|(((
403 -String
154 +Enum
404 404  )))|(((
405 405  Parents
406 406  )))|(((
407 -
158 +UNDEFINED
408 408  )))
409 -|(((
410 -Edge Label Placement
411 -)))|(((
412 -de.cau.cs.kieler.edgeLabelPlacement
413 -)))|(((
414 -Enum
415 -)))|(((
416 -Labels
417 -)))|(((
418 -
419 -)))
420 420  |(% colspan="1" %)(% colspan="1" %)
421 421  (((
422 422  Edge Type
... ... @@ -433,6 +433,17 @@
433 433  (((
434 434  NONE
435 435  )))
176 +|(((
177 +Expand Nodes
178 +)))|(((
179 +de.cau.cs.kieler.expandNodes
180 +)))|(((
181 +Boolean
182 +)))|(((
183 +Parents
184 +)))|(((
185 +false
186 +)))
436 436  |(% colspan="1" %)(% colspan="1" %)
437 437  (((
438 438  Font Name
... ... @@ -467,7 +467,7 @@
467 467  )))
468 468  |(% colspan="1" %)(% colspan="1" %)
469 469  (((
470 -[[Hypernode>>doc:||anchor="hypernode"]]
221 +Hypernode
471 471  )))|(% colspan="1" %)(% colspan="1" %)
472 472  (((
473 473  de.cau.cs.kieler.hypernode
... ... @@ -481,53 +481,50 @@
481 481  (((
482 482  false
483 483  )))
484 -|(% colspan="1" %)(% colspan="1" %)
485 -(((
486 -Layout Ancestors
487 -)))|(% colspan="1" %)(% colspan="1" %)
488 -(((
489 -de.cau.cs.kieler.layoutAncestors
490 -)))|(% colspan="1" %)(% colspan="1" %)
491 -(((
235 +|(((
236 +Interactive
237 +)))|(((
238 +de.cau.cs.kieler.interactive
239 +)))|(((
492 492  Boolean
493 -)))|(% colspan="1" %)(% colspan="1" %)
494 -(((
241 +)))|(((
495 495  Parents
496 -)))|(% colspan="1" %)(% colspan="1" %)
497 -(((
243 +)))|(((
498 498  false
499 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 -(((
246 +|(((
247 +Label Spacing
248 +)))|(((
249 +de.cau.cs.kieler.labelSpacing
250 +)))|(((
251 +Float
252 +)))|(((
253 +Edges
254 +Nodes
255 +)))|(((
256 +-1.0
257 +)))
258 +|(((
259 +Layout Hierarchy
260 +)))|(((
261 +de.cau.cs.kieler.layoutHierarchy
262 +)))|(((
263 +Boolean
264 +)))|(((
511 511  Parents
512 -)))|(% colspan="1" %)(% colspan="1" %)
513 -(((
514 -4000
266 +)))|(((
267 +false
515 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 -(((
269 +|(((
270 +Layout Algorithm
271 +)))|(((
272 +de.cau.cs.kieler.algorithm
273 +)))|(((
274 +String
275 +)))|(((
527 527  Parents
528 -)))|(% colspan="1" %)(% colspan="1" %)
529 -(((
530 -400
277 +)))|(((
278 +
531 531  )))
532 532  |(% colspan="1" %)(% colspan="1" %)
533 533  (((
... ... @@ -565,7 +565,7 @@
565 565  )))
566 566  |(% colspan="1" %)(% colspan="1" %)
567 567  (((
568 -[[No Layout>>doc:||anchor="noLayout"]]
316 +No Layout
569 569  )))|(% colspan="1" %)(% colspan="1" %)
570 570  (((
571 571  de.cau.cs.kieler.noLayout
... ... @@ -581,22 +581,49 @@
581 581  )))
582 582  |(% colspan="1" %)(% colspan="1" %)
583 583  (((
584 -Port Index
332 +Node Label Placement
585 585  )))|(% colspan="1" %)(% colspan="1" %)
586 586  (((
587 -de.cau.cs.kieler.portIndex
335 +de.cau.cs.kieler.nodeLabelPlacement
588 588  )))|(% colspan="1" %)(% colspan="1" %)
589 589  (((
590 -Int
338 +EnumSet
591 591  )))|(% colspan="1" %)(% colspan="1" %)
592 592  (((
593 -Ports
341 +Nodes
594 594  )))|(% colspan="1" %)(% colspan="1" %)
595 595  (((
596 596  
597 597  )))
346 +|(((
347 +Port Constraints
348 +)))|(((
349 +de.cau.cs.kieler.portConstraints
350 +)))|(((
351 +Enum
352 +)))|(((
353 +Nodes
354 +)))|(((
355 +UNDEFINED
356 +)))
598 598  |(% colspan="1" %)(% colspan="1" %)
599 599  (((
359 +Port Label Placement
360 +)))|(% colspan="1" %)(% colspan="1" %)
361 +(((
362 +de.cau.cs.kieler.portLabelPlacement
363 +)))|(% colspan="1" %)(% colspan="1" %)
364 +(((
365 +Enum
366 +)))|(% colspan="1" %)(% colspan="1" %)
367 +(((
368 +Nodes
369 +)))|(% colspan="1" %)(% colspan="1" %)
370 +(((
371 +OUTSIDE
372 +)))
373 +|(% colspan="1" %)(% colspan="1" %)
374 +(((
600 600  [[Port Offset>>doc:||anchor="portOffset"]]
601 601  )))|(% colspan="1" %)(% colspan="1" %)
602 602  (((
... ... @@ -625,16 +625,57 @@
625 625  Ports
626 626  )))|(% colspan="1" %)(% colspan="1" %)
627 627  (((
403 +UNDEFINED
404 +)))
405 +|(((
406 +Position
407 +)))|(((
408 +de.cau.cs.kieler.position
409 +)))|(((
410 +Object
411 +)))|(((
412 +Labels
413 +Nodes
414 +Ports
415 +)))|(((
628 628  
629 629  )))
418 +|(((
419 +Priority
420 +)))|(((
421 +de.cau.cs.kieler.priority
422 +)))|(((
423 +Int
424 +)))|(((
425 +Edges
426 +Nodes
427 +)))|(((
428 +
429 +)))
630 630  |(% colspan="1" %)(% colspan="1" %)
631 631  (((
632 -Progress Bar
432 +Randomization Seed
633 633  )))|(% colspan="1" %)(% colspan="1" %)
634 634  (((
635 -de.cau.cs.kieler.progressBar
435 +de.cau.cs.kieler.randomSeed
636 636  )))|(% colspan="1" %)(% colspan="1" %)
637 637  (((
438 +Int
439 +)))|(% colspan="1" %)(% colspan="1" %)
440 +(((
441 +Parents
442 +)))|(% colspan="1" %)(% colspan="1" %)
443 +(((
444 +
445 +)))
446 +|(% colspan="1" %)(% colspan="1" %)
447 +(((
448 +Separate Connected Components
449 +)))|(% colspan="1" %)(% colspan="1" %)
450 +(((
451 +de.cau.cs.kieler.separateConnComp
452 +)))|(% colspan="1" %)(% colspan="1" %)
453 +(((
638 638  Boolean
639 639  )))|(% colspan="1" %)(% colspan="1" %)
640 640  (((
... ... @@ -641,145 +641,69 @@
641 641  Parents
642 642  )))|(% colspan="1" %)(% colspan="1" %)
643 643  (((
644 -false
460 +
645 645  )))
646 646  |(% colspan="1" %)(% colspan="1" %)
647 647  (((
648 -Scale Factor
464 +Size Constraint
649 649  )))|(% colspan="1" %)(% colspan="1" %)
650 650  (((
651 -de.cau.cs.kieler.scaleFactor
467 +de.cau.cs.kieler.sizeConstraint
652 652  )))|(% colspan="1" %)(% colspan="1" %)
653 653  (((
654 -Float
470 +EnumSet
655 655  )))|(% colspan="1" %)(% colspan="1" %)
656 656  (((
657 657  Nodes
658 658  )))|(% colspan="1" %)(% colspan="1" %)
659 659  (((
660 -1.0
476 +
661 661  )))
662 662  |(% colspan="1" %)(% colspan="1" %)
663 663  (((
664 -Thickness
480 +Size Options
665 665  )))|(% colspan="1" %)(% colspan="1" %)
666 666  (((
667 -de.cau.cs.kieler.thickness
483 +de.cau.cs.kieler.sizeOptions
668 668  )))|(% colspan="1" %)(% colspan="1" %)
669 669  (((
670 -Float
486 +EnumSet
671 671  )))|(% colspan="1" %)(% colspan="1" %)
672 672  (((
673 -Edges
489 +Nodes
674 674  )))|(% colspan="1" %)(% colspan="1" %)
675 675  (((
676 -1.0
492 +DEFAULT_MINIMUM_SIZE
677 677  )))
678 678  |(% colspan="1" %)(% colspan="1" %)
679 679  (((
680 -Zoom to Fit
496 +Spacing
681 681  )))|(% colspan="1" %)(% colspan="1" %)
682 682  (((
683 -de.cau.cs.kieler.zoomToFit
499 +de.cau.cs.kieler.spacing
684 684  )))|(% colspan="1" %)(% colspan="1" %)
685 685  (((
686 -Boolean
502 +Float
687 687  )))|(% colspan="1" %)(% colspan="1" %)
688 688  (((
689 689  Parents
690 690  )))|(% colspan="1" %)(% colspan="1" %)
691 691  (((
692 -false
508 +-1.0
693 693  )))
694 694  
695 -=== Layout Output Properties ===
511 += The Most Important Options =
696 696  
697 -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
513 +**TODO:** Write a bit of documentation about the most important layout options and how to use them, possibly with a simple example or something.
698 698  
699 -|=(((
700 -Property
701 -)))|=(((
702 -ID
703 -)))|=(((
704 -Type
705 -)))|=(((
706 -Applies to
707 -)))
708 -|(((
709 -[[Edge Routing>>doc:||anchor="edgeRouting"]]
710 -)))|(((
711 -de.cau.cs.kieler.edgeRouting
712 -)))|(((
713 -Enum
714 -)))|(((
715 -Edges
716 -)))
717 -|(((
718 -Junction Points
719 -)))|(((
720 -de.cau.cs.kieler.junctionPoints
721 -)))|(((
722 -Object
723 -)))|(((
724 -Edges
725 -)))
726 -
727 -
728 -
729 729  = Detailed Documentation =
730 730  
731 731  This section explains every layout option in more detail.
732 732  
733 -== The Most Important Options ==
519 +== Edge Routing ==
734 734  
735 -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.
736 736  
737 -=== Layout Algorithm ===
738 738  
739 -{{id name="layoutAlgorithm"/}}
740 -
741 -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.
742 -
743 -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.
744 -
745 -[[image:attach:layout_algorithm.png]]
746 -
747 -==== Available Algorithms and Libraries ====
748 -
749 -* **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.
750 -* **Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
751 -* (((
752 -**Box Layout** - Ignores edges, places all nodes in rows. Can be used to layout collections of unconnected boxes, such as Statechart regions.
753 -)))
754 -* **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.
755 -* **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.
756 -* **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.
757 -
758 -==== Predefined Layout Types ====
759 -
760 -* **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.
761 -* **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.
762 -* **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
763 -* **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.
764 -* **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.
765 -
766 -=== Diagram Type ===
767 -
768 -{{id name="diagramType"/}}
769 -
770 -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.
771 -
772 -The following diagram types are predefined:
773 -
774 -* **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.
775 -* **State Machine** - All kinds of state machines, automata, and activity diagrams. Examples: [[doc:SCCharts SyncCharts]], UML Activity diagrams.
776 -* **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)]].
777 -* **Class Diagram** - Class diagrams such as Ecore diagrams for the [[EMF>>url:http://www.eclipse.org/modeling/emf/||shape="rect"]] or UML Class diagrams.
778 -* **Use Case Diagram** - Use case diagrams as defined by the UML.
779 -* **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]].
780 -
781 -=== Edge Routing ===
782 -
783 783  {{id name="edgeRouting"/}}
784 784  
785 785  This option influences the way in which edges are routed between the nodes they connect. The following settings are available:
... ... @@ -787,68 +787,18 @@
787 787  * POLYLINE
788 788  Edges consist of one or more segments defined by a list of bend points.
789 789  * ORTHOGONAL
790 -Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically.
791 -* SPLINES
792 -Edges are routed as splines (smooth curves).
530 +Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically, but never at an angle.
531 +* SPLINE
532 +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.
793 793  * UNDEFINED
794 -No particular edge routing style is selected. Usually this value points to the default setting of the selected layout algorithm.
534 +No particular edge routing style is selected. The result produced by the layout algorithm may be undefined.
795 795  
796 -[[image:attach:edge_routing.png]]
536 +(% style="color: rgb(153,51,0);" %)**TODO:** Add an image illustrating the different routing styles.
797 797  
798 -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:
538 +== Port Offset ==
799 799  
800 -1. Start at the source point of the edge.
801 -1. As long as there are at least three bend points left:
802 -11. Draw a cubic spline segment to the third bend point with the other two bend points as control points.
803 -11. Use the third bend point as start point for the next segment.
804 -11. Consume the three bend points and proceed to the next segment.
805 -1. Check the number of remaining bend points:
806 -11. Two bend points – draw a cubic spline segment to the target point of the edge.
807 -11. One bend point – draw a quadratic spline segment to the target point of the edge.
808 -11. No bend point – draw a straight line to the target point of the edge.
809 809  
810 -== Other Options ==
811 811  
812 -=== Alignment ===
813 -
814 -{{id name="alignment"/}}
815 -
816 -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.
817 -
818 -=== Aspect Ratio ===
819 -
820 -{{id name="aspectRatio"/}}
821 -
822 -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.
823 -
824 -=== Comment Box ===
825 -
826 -{{id name="commentBox"/}}
827 -
828 -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.
829 -
830 -[[image:attach:comment_box.png]]
831 -
832 -=== (% style="line-height: 1.5625;" %)Hypernode(%%) ===
833 -
834 -{{id name="hypernode"/}}
835 -
836 -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.
837 -
838 -=== Layout Hierarchy ===
839 -
840 -{{id name="layoutHierarchy"/}}
841 -
842 -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.
843 -
844 -=== No Layout ===
845 -
846 -{{id name="noLayout"/}}
847 -
848 -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.
849 -
850 -=== Port Offset ===
851 -
852 852  {{id name="portOffset"/}}
853 853  
854 854  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.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470042
1 +9469964
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470042/KIML Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9469964/KIML Layout Options