Skip to Content

Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
From version 25.1
edited by cds
on 2014/03/17 11:10
Change comment: There is no comment for this version
To version 17.1
edited by msp
on 2014/03/07 16:46
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cds
1 +XWiki.msp
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  )))|(((
... ... @@ -78,44 +78,27 @@
78 78  )))|(((
79 79  
80 80  )))
81 -|(((
82 -Debug Mode
83 -)))|(((
84 -de.cau.cs.kieler.debugMode
85 -)))|(((
79 +|(% colspan="1" %)(% colspan="1" %)
80 +(((
81 +Comment Box
82 +)))|(% colspan="1" %)(% colspan="1" %)
83 +(((
84 +de.cau.cs.kieler.commentBox
85 +)))|(% colspan="1" %)(% colspan="1" %)
86 +(((
86 86  Boolean
87 -)))|(((
88 -Parents
89 -)))|(((
88 +)))|(% colspan="1" %)(% colspan="1" %)
89 +(((
90 +Nodes
91 +)))|(% colspan="1" %)(% colspan="1" %)
92 +(((
90 90  false
91 91  )))
92 92  |(((
93 -Direction
96 +Debug Mode
94 94  )))|(((
95 -de.cau.cs.kieler.direction
98 +de.cau.cs.kieler.debugMode
96 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 119  Boolean
120 120  )))|(((
121 121  Parents
... ... @@ -122,179 +122,99 @@
122 122  )))|(((
123 123  false
124 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
108 +[[Diagram Type>>doc:||anchor="diagramType"]]
173 173  )))|(% colspan="1" %)(% colspan="1" %)
174 174  (((
175 -de.cau.cs.kieler.nodeLabelPlacement
111 +de.cau.cs.kieler.diagramType
176 176  )))|(% colspan="1" %)(% colspan="1" %)
177 177  (((
178 -EnumSet
114 +String
179 179  )))|(% colspan="1" %)(% colspan="1" %)
180 180  (((
181 -Nodes
117 +
182 182  )))|(% colspan="1" %)(% colspan="1" %)
183 183  (((
184 184  
185 185  )))
186 186  |(((
187 -Port Constraints
123 +Direction
188 188  )))|(((
189 -de.cau.cs.kieler.portConstraints
125 +de.cau.cs.kieler.direction
190 190  )))|(((
191 191  Enum
192 192  )))|(((
193 -Nodes
129 +Parents
194 194  )))|(((
195 195  
196 196  )))
197 197  |(% colspan="1" %)(% colspan="1" %)
198 198  (((
199 -Port Label Placement
135 +Edge Label Placement
200 200  )))|(% colspan="1" %)(% colspan="1" %)
201 201  (((
202 -de.cau.cs.kieler.portLabelPlacement
138 +de.cau.cs.kieler.edgeLabelPlacement
203 203  )))|(% colspan="1" %)(% colspan="1" %)
204 204  (((
205 205  Enum
206 206  )))|(% colspan="1" %)(% colspan="1" %)
207 207  (((
208 -Nodes
144 +Labels
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
150 +[[Edge Routing>>doc:||anchor="edgeRouting"]]
231 231  )))|(((
232 -de.cau.cs.kieler.position
152 +de.cau.cs.kieler.edgeRouting
233 233  )))|(((
234 -Object
154 +Enum
235 235  )))|(((
236 -Labels
237 -Nodes
238 -Ports
156 +Parents
239 239  )))|(((
240 240  
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
162 +Edge Type
257 257  )))|(% colspan="1" %)(% colspan="1" %)
258 258  (((
259 -de.cau.cs.kieler.randomSeed
165 +de.cau.cs.kieler.edgeType
260 260  )))|(% colspan="1" %)(% colspan="1" %)
261 261  (((
262 -Int
168 +Enum
263 263  )))|(% colspan="1" %)(% colspan="1" %)
264 264  (((
265 -Parents
171 +Edges
266 266  )))|(% colspan="1" %)(% colspan="1" %)
267 267  (((
268 -
174 +NONE
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 -(((
176 +|(((
177 +Expand Nodes
178 +)))|(((
179 +de.cau.cs.kieler.expandNodes
180 +)))|(((
278 278  Boolean
279 -)))|(% colspan="1" %)(% colspan="1" %)
280 -(((
182 +)))|(((
281 281  Parents
282 -)))|(% colspan="1" %)(% colspan="1" %)
283 -(((
284 -
184 +)))|(((
185 +false
285 285  )))
286 286  |(% colspan="1" %)(% colspan="1" %)
287 287  (((
288 -Size Constraint
189 +Font Name
289 289  )))|(% colspan="1" %)(% colspan="1" %)
290 290  (((
291 -de.cau.cs.kieler.sizeConstraint
192 +de.cau.cs.kieler.fontName
292 292  )))|(% colspan="1" %)(% colspan="1" %)
293 293  (((
294 -EnumSet
195 +String
295 295  )))|(% colspan="1" %)(% colspan="1" %)
296 296  (((
297 -Nodes
198 +Labels
298 298  )))|(% colspan="1" %)(% colspan="1" %)
299 299  (((
300 300  
... ... @@ -301,95 +301,31 @@
301 301  )))
302 302  |(% colspan="1" %)(% colspan="1" %)
303 303  (((
304 -Size Options
205 +Font Size
305 305  )))|(% colspan="1" %)(% colspan="1" %)
306 306  (((
307 -de.cau.cs.kieler.sizeOptions
208 +de.cau.cs.kieler.fontSize
308 308  )))|(% colspan="1" %)(% colspan="1" %)
309 309  (((
310 -EnumSet
211 +Int
311 311  )))|(% colspan="1" %)(% colspan="1" %)
312 312  (((
313 -Nodes
214 +Labels
314 314  )))|(% colspan="1" %)(% colspan="1" %)
315 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 332  
333 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 350  |(% colspan="1" %)(% colspan="1" %)
351 351  (((
352 -Animate
221 +Hypernode
353 353  )))|(% colspan="1" %)(% colspan="1" %)
354 354  (((
355 -de.cau.cs.kieler.animate
224 +de.cau.cs.kieler.hypernode
356 356  )))|(% colspan="1" %)(% colspan="1" %)
357 357  (((
358 358  Boolean
359 359  )))|(% colspan="1" %)(% colspan="1" %)
360 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 393  Nodes
394 394  )))|(% colspan="1" %)(% colspan="1" %)
395 395  (((
... ... @@ -396,103 +396,96 @@
396 396  false
397 397  )))
398 398  |(((
399 -[[Diagram Type>>doc:||anchor="diagramType"]]
236 +Interactive
400 400  )))|(((
401 -de.cau.cs.kieler.diagramType
238 +de.cau.cs.kieler.interactive
402 402  )))|(((
403 -String
240 +Boolean
404 404  )))|(((
405 405  Parents
406 406  )))|(((
407 -
244 +false
408 408  )))
409 409  |(((
410 -Edge Label Placement
247 +Label Spacing
411 411  )))|(((
412 -de.cau.cs.kieler.edgeLabelPlacement
249 +de.cau.cs.kieler.labelSpacing
413 413  )))|(((
414 -Enum
251 +Float
415 415  )))|(((
416 -Labels
253 +Edges
254 +Nodes
417 417  )))|(((
418 418  
419 419  )))
420 -|(% colspan="1" %)(% colspan="1" %)
421 -(((
422 -Edge Type
423 -)))|(% colspan="1" %)(% colspan="1" %)
424 -(((
425 -de.cau.cs.kieler.edgeType
426 -)))|(% colspan="1" %)(% colspan="1" %)
427 -(((
428 -Enum
429 -)))|(% colspan="1" %)(% colspan="1" %)
430 -(((
431 -Edges
432 -)))|(% colspan="1" %)(% colspan="1" %)
433 -(((
434 -NONE
258 +|(((
259 +Layout Hierarchy
260 +)))|(((
261 +de.cau.cs.kieler.layoutHierarchy
262 +)))|(((
263 +Boolean
264 +)))|(((
265 +Parents
266 +)))|(((
267 +false
435 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 -(((
269 +|(((
270 +[[Layout Algorithm>>doc:||anchor="layoutAlgorithm"]]
271 +)))|(((
272 +de.cau.cs.kieler.algorithm
273 +)))|(((
444 444  String
445 -)))|(% colspan="1" %)(% colspan="1" %)
446 -(((
447 -Labels
448 -)))|(% colspan="1" %)(% colspan="1" %)
449 -(((
275 +)))|(((
276 +Parents
277 +)))|(((
450 450  
451 451  )))
452 452  |(% colspan="1" %)(% colspan="1" %)
453 453  (((
454 -Font Size
282 +Minimal Height
455 455  )))|(% colspan="1" %)(% colspan="1" %)
456 456  (((
457 -de.cau.cs.kieler.fontSize
285 +de.cau.cs.kieler.minHeight
458 458  )))|(% colspan="1" %)(% colspan="1" %)
459 459  (((
460 -Int
288 +Float
461 461  )))|(% colspan="1" %)(% colspan="1" %)
462 462  (((
463 -Labels
291 +Nodes
292 +Parents
464 464  )))|(% colspan="1" %)(% colspan="1" %)
465 465  (((
466 -
295 +0.0
467 467  )))
468 468  |(% colspan="1" %)(% colspan="1" %)
469 469  (((
470 -[[Hypernode>>doc:||anchor="hypernode"]]
299 +Minimal Width
471 471  )))|(% colspan="1" %)(% colspan="1" %)
472 472  (((
473 -de.cau.cs.kieler.hypernode
302 +de.cau.cs.kieler.minWidth
474 474  )))|(% colspan="1" %)(% colspan="1" %)
475 475  (((
476 -Boolean
305 +Float
477 477  )))|(% colspan="1" %)(% colspan="1" %)
478 478  (((
479 479  Nodes
309 +Parents
480 480  )))|(% colspan="1" %)(% colspan="1" %)
481 481  (((
482 -false
312 +0.0
483 483  )))
484 484  |(% colspan="1" %)(% colspan="1" %)
485 485  (((
486 -Layout Ancestors
316 +No Layout
487 487  )))|(% colspan="1" %)(% colspan="1" %)
488 488  (((
489 -de.cau.cs.kieler.layoutAncestors
319 +de.cau.cs.kieler.noLayout
490 490  )))|(% colspan="1" %)(% colspan="1" %)
491 491  (((
492 492  Boolean
493 493  )))|(% colspan="1" %)(% colspan="1" %)
494 494  (((
495 -Parents
325 +
496 496  )))|(% colspan="1" %)(% colspan="1" %)
497 497  (((
498 498  false
... ... @@ -499,95 +499,72 @@
499 499  )))
500 500  |(% colspan="1" %)(% colspan="1" %)
501 501  (((
502 -Maximal Animation Time
332 +Node Label Placement
503 503  )))|(% colspan="1" %)(% colspan="1" %)
504 504  (((
505 -de.cau.cs.kieler.maxAnimTim
335 +de.cau.cs.kieler.nodeLabelPlacement
506 506  )))|(% colspan="1" %)(% colspan="1" %)
507 507  (((
508 -Int
338 +EnumSet
509 509  )))|(% colspan="1" %)(% colspan="1" %)
510 510  (((
511 -Parents
341 +Nodes
512 512  )))|(% colspan="1" %)(% colspan="1" %)
513 513  (((
514 -4000
344 +
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 -(((
527 -Parents
528 -)))|(% colspan="1" %)(% colspan="1" %)
529 -(((
530 -400
346 +|(((
347 +Port Constraints
348 +)))|(((
349 +de.cau.cs.kieler.portConstraints
350 +)))|(((
351 +Enum
352 +)))|(((
353 +Nodes
354 +)))|(((
355 +
531 531  )))
532 532  |(% colspan="1" %)(% colspan="1" %)
533 533  (((
534 -Minimal Height
359 +Port Label Placement
535 535  )))|(% colspan="1" %)(% colspan="1" %)
536 536  (((
537 -de.cau.cs.kieler.minHeight
362 +de.cau.cs.kieler.portLabelPlacement
538 538  )))|(% colspan="1" %)(% colspan="1" %)
539 539  (((
540 -Float
365 +Enum
541 541  )))|(% colspan="1" %)(% colspan="1" %)
542 542  (((
543 543  Nodes
544 -Parents
545 545  )))|(% colspan="1" %)(% colspan="1" %)
546 546  (((
547 -0.0
371 +OUTSIDE
548 548  )))
549 549  |(% colspan="1" %)(% colspan="1" %)
550 550  (((
551 -Minimal Width
375 +[[Port Offset>>doc:||anchor="portOffset"]]
552 552  )))|(% colspan="1" %)(% colspan="1" %)
553 553  (((
554 -de.cau.cs.kieler.minWidth
378 +de.cau.cs.kieler.offset
555 555  )))|(% colspan="1" %)(% colspan="1" %)
556 556  (((
557 557  Float
558 558  )))|(% colspan="1" %)(% colspan="1" %)
559 559  (((
560 -Nodes
561 -Parents
384 +Ports
562 562  )))|(% colspan="1" %)(% colspan="1" %)
563 563  (((
564 -0.0
565 -)))
566 -|(% colspan="1" %)(% colspan="1" %)
567 -(((
568 -[[No Layout>>doc:||anchor="noLayout"]]
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 -(((
577 577  
578 -)))|(% colspan="1" %)(% colspan="1" %)
579 -(((
580 -false
581 581  )))
582 582  |(% colspan="1" %)(% colspan="1" %)
583 583  (((
584 -Port Index
391 +Port Side
585 585  )))|(% colspan="1" %)(% colspan="1" %)
586 586  (((
587 -de.cau.cs.kieler.portIndex
394 +de.cau.cs.kieler.portSide
588 588  )))|(% colspan="1" %)(% colspan="1" %)
589 589  (((
590 -Int
397 +Enum
591 591  )))|(% colspan="1" %)(% colspan="1" %)
592 592  (((
593 593  Ports
... ... @@ -597,32 +597,57 @@
597 597  )))
598 598  |(% colspan="1" %)(% colspan="1" %)
599 599  (((
600 -[[Port Offset>>doc:||anchor="portOffset"]]
407 +Port Spacing
601 601  )))|(% colspan="1" %)(% colspan="1" %)
602 602  (((
603 -de.cau.cs.kieler.offset
410 +de.cau.cs.kieler.portSpacing
604 604  )))|(% colspan="1" %)(% colspan="1" %)
605 605  (((
606 606  Float
607 607  )))|(% colspan="1" %)(% colspan="1" %)
608 608  (((
609 -Ports
416 +Nodes
610 610  )))|(% colspan="1" %)(% colspan="1" %)
611 611  (((
612 612  
613 613  )))
421 +|(((
422 +Position
423 +)))|(((
424 +de.cau.cs.kieler.position
425 +)))|(((
426 +Object
427 +)))|(((
428 +Labels
429 +Nodes
430 +Ports
431 +)))|(((
432 +
433 +)))
434 +|(((
435 +Priority
436 +)))|(((
437 +de.cau.cs.kieler.priority
438 +)))|(((
439 +Int
440 +)))|(((
441 +Edges
442 +Nodes
443 +)))|(((
444 +
445 +)))
614 614  |(% colspan="1" %)(% colspan="1" %)
615 615  (((
616 -Port Side
448 +Randomization Seed
617 617  )))|(% colspan="1" %)(% colspan="1" %)
618 618  (((
619 -de.cau.cs.kieler.portSide
451 +de.cau.cs.kieler.randomSeed
620 620  )))|(% colspan="1" %)(% colspan="1" %)
621 621  (((
622 -Enum
454 +Int
623 623  )))|(% colspan="1" %)(% colspan="1" %)
624 624  (((
625 -Ports
457 +Parents
626 626  )))|(% colspan="1" %)(% colspan="1" %)
627 627  (((
628 628  
... ... @@ -629,10 +629,10 @@
629 629  )))
630 630  |(% colspan="1" %)(% colspan="1" %)
631 631  (((
632 -Progress Bar
464 +Separate Connected Components
633 633  )))|(% colspan="1" %)(% colspan="1" %)
634 634  (((
635 -de.cau.cs.kieler.progressBar
467 +de.cau.cs.kieler.separateConnComp
636 636  )))|(% colspan="1" %)(% colspan="1" %)
637 637  (((
638 638  Boolean
... ... @@ -641,112 +641,78 @@
641 641  Parents
642 642  )))|(% colspan="1" %)(% colspan="1" %)
643 643  (((
644 -false
476 +
645 645  )))
646 646  |(% colspan="1" %)(% colspan="1" %)
647 647  (((
648 -Scale Factor
480 +Size Constraint
649 649  )))|(% colspan="1" %)(% colspan="1" %)
650 650  (((
651 -de.cau.cs.kieler.scaleFactor
483 +de.cau.cs.kieler.sizeConstraint
652 652  )))|(% colspan="1" %)(% colspan="1" %)
653 653  (((
654 -Float
486 +EnumSet
655 655  )))|(% colspan="1" %)(% colspan="1" %)
656 656  (((
657 657  Nodes
658 658  )))|(% colspan="1" %)(% colspan="1" %)
659 659  (((
660 -1.0
492 +
661 661  )))
662 662  |(% colspan="1" %)(% colspan="1" %)
663 663  (((
664 -Thickness
496 +Size Options
665 665  )))|(% colspan="1" %)(% colspan="1" %)
666 666  (((
667 -de.cau.cs.kieler.thickness
499 +de.cau.cs.kieler.sizeOptions
668 668  )))|(% colspan="1" %)(% colspan="1" %)
669 669  (((
670 -Float
502 +EnumSet
671 671  )))|(% colspan="1" %)(% colspan="1" %)
672 672  (((
673 -Edges
505 +Nodes
674 674  )))|(% colspan="1" %)(% colspan="1" %)
675 675  (((
676 -1.0
508 +DEFAULT_MINIMUM_SIZE
677 677  )))
678 678  |(% colspan="1" %)(% colspan="1" %)
679 679  (((
680 -Zoom to Fit
512 +Spacing
681 681  )))|(% colspan="1" %)(% colspan="1" %)
682 682  (((
683 -de.cau.cs.kieler.zoomToFit
515 +de.cau.cs.kieler.spacing
684 684  )))|(% colspan="1" %)(% colspan="1" %)
685 685  (((
686 -Boolean
518 +Float
687 687  )))|(% colspan="1" %)(% colspan="1" %)
688 688  (((
689 689  Parents
690 690  )))|(% colspan="1" %)(% colspan="1" %)
691 691  (((
692 -false
524 +
693 693  )))
694 694  
695 -=== Layout Output Properties ===
527 += 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
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 -= Detailed Documentation =
730 -
731 -This section explains every layout option in more detail.
732 -
733 -== The Most Important Options ==
734 -
735 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 ===
531 +== Layout Algorithm ==
738 738  
739 739  {{id name="layoutAlgorithm"/}}
740 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.
535 +The option with identifier {{code language="none"}}de.cau.cs.kieler.algorithm{{/code}} specifies which layout algorithm to use for the content of a composite node. The value can be either the identifier of a layout algorithm or the identifier of a layout type. In the latter case the algorithm with highest priority of that type is applied.
742 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.
537 +The following layout types are predefined:
744 744  
745 -[[image:attach:layout_algorithm.png]]
539 +* **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.
540 +* **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.
541 +* **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
542 +* **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.
543 +* **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.
746 746  
747 -==== Available Algorithms and Libraries ====
545 +=== Available Algorithms and Libraries ===
748 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.
547 +* **The [[KLay Project>>doc:Layout Algorithms (KLay)]]** - Java implementations of standard layout approaches, augmented with special processing of graph features such as ports and edge labels.
750 750  * **Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
751 751  * (((
752 752  **Box Layout** - Ignores edges, places all nodes in rows. Can be used to layout collections of unconnected boxes, such as Statechart regions.
... ... @@ -755,16 +755,8 @@
755 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 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 757  
758 -==== Predefined Layout Types ====
556 +== Diagram Type ==
759 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 768  {{id name="diagramType"/}}
769 769  
770 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.
... ... @@ -778,8 +778,19 @@
778 778  * **Use Case Diagram** - Use case diagrams as defined by the UML.
779 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 780  
781 -=== Edge Routing ===
571 +== Other Options ==
782 782  
573 +* **Layout Hierarchy** ({{code language="none"}}de.cau.cs.kieler.layoutHierarchy{{/code}}) - If this option is supported and active, the layout algorithm is requested to process the full hierarchy contained in the input node. This means that instead of executing another algorithm on each hierarchy level, all levels are arranged in a single algorithm execution.
574 +* **Hypernode** ({{code language="none"}}de.cau.cs.kieler.hypernode{{/code}}) - A node that is marked as hypernode has a special role in the graph structure, since all its incident edges are treated as parts of the same [[hyperedge>>url:http://en.wikipedia.org/wiki/Hypergraph||shape="rect"]]. Example: relation vertices in [[Ptolemy>>url:http://ptolemy.eecs.berkeley.edu/||shape="rect"]] models.
575 +* **Comment Box** ({{code language="none"}}de.cau.cs.kieler.commentBox{{/code}}) - A node that is marked as comment box is treated as a label that needs to be placed somewhere. This is different to normal node labels, which are usually regarded as fixed.
576 +* **No Layout** ({{code language="none"}}de.cau.cs.kieler.noLayout{{/code}}) - Elements that are marked with this option are excluded from layout. This is used to identify diagram objects that should not be regarded as graph elements.
577 +
578 += Detailed Documentation =
579 +
580 +This section explains every layout option in more detail.
581 +
582 +== Edge Routing ==
583 +
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,16 @@
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).
591 +Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically, but never at an angle.
592 +* SPLINE
593 +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.
595 +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]]
597 +(% 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:
599 +== 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 -
810 -== Other Options ==
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 -9470235
1 +9470006
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470235/KIML Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470006/KIML Layout Options