Skip to Content

Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
From version 24.1
edited by cds
on 2014/03/14 14:31
Change comment: There is no comment for this version
To version 6.1
edited by cds
on 2013/06/03 10:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,28 +1,24 @@
1 -
1 +{{warning}}
2 +This is preliminary 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  
9 +
7 7  
8 -
9 -{{toc maxLevel="2"/}}
10 -
11 11  = Overview =
12 12  
13 -Beside a user-friendly name, layout options are defined by the following properties:
13 +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.
16 +* 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.
17 +* 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.
18 +* 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.
20 +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"]]
34 +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"]]
45 +Aspect Ratio
50 50  )))|(((
51 51  de.cau.cs.kieler.aspectRatio
52 52  )))|(((
... ... @@ -76,96 +76,29 @@
76 76  )))|(((
77 77  Parents
78 78  )))|(((
79 -
75 +-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 136  |(% colspan="1" %)(% colspan="1" %)
137 137  (((
138 -Label Side
79 +Comment Box
139 139  )))|(% colspan="1" %)(% colspan="1" %)
140 140  (((
141 -de.cau.cs.kieler.labelSide
82 +de.cau.cs.kieler.commentBox
142 142  )))|(% colspan="1" %)(% colspan="1" %)
143 143  (((
144 -Enum
85 +Boolean
145 145  )))|(% colspan="1" %)(% colspan="1" %)
146 146  (((
147 -Parents
88 +Nodes
148 148  )))|(% colspan="1" %)(% colspan="1" %)
149 149  (((
150 -SMART
91 +false
151 151  )))
152 152  |(((
153 -Label Spacing
94 +Debug Mode
154 154  )))|(((
155 -de.cau.cs.kieler.labelSpacing
96 +de.cau.cs.kieler.debugMode
156 156  )))|(((
157 -Float
158 -)))|(((
159 -Edges
160 -Nodes
161 -)))|(((
162 -
163 -)))
164 -|(((
165 -[[Layout Hierarchy>>doc:||anchor="layoutHierarchy"]]
166 -)))|(((
167 -de.cau.cs.kieler.layoutHierarchy
168 -)))|(((
169 169  Boolean
170 170  )))|(((
171 171  Parents
... ... @@ -172,145 +172,99 @@
172 172  )))|(((
173 173  false
174 174  )))
175 -|(((
176 -[[Layout Algorithm>>doc:||anchor="layoutAlgorithm"]]
177 -)))|(((
178 -de.cau.cs.kieler.algorithm
179 -)))|(((
180 -String
181 -)))|(((
182 -Parents
183 -)))|(((
184 -
185 -)))
186 186  |(% colspan="1" %)(% colspan="1" %)
187 187  (((
188 -Node Label Placement
106 +Diagram Type
189 189  )))|(% colspan="1" %)(% colspan="1" %)
190 190  (((
191 -de.cau.cs.kieler.nodeLabelPlacement
109 +de.cau.cs.kieler.diagramType
192 192  )))|(% colspan="1" %)(% colspan="1" %)
193 193  (((
194 -EnumSet
112 +String
195 195  )))|(% colspan="1" %)(% colspan="1" %)
196 196  (((
197 -Nodes
115 +
198 198  )))|(% colspan="1" %)(% colspan="1" %)
199 199  (((
200 200  
201 201  )))
202 202  |(((
203 -Port Constraints
121 +Direction
204 204  )))|(((
205 -de.cau.cs.kieler.portConstraints
123 +de.cau.cs.kieler.direction
206 206  )))|(((
207 207  Enum
208 208  )))|(((
209 -Nodes
127 +Parents
210 210  )))|(((
211 -
129 +UNDEFINED
212 212  )))
213 213  |(% colspan="1" %)(% colspan="1" %)
214 214  (((
215 -Port Label Placement
133 +Edge Label Placement
216 216  )))|(% colspan="1" %)(% colspan="1" %)
217 217  (((
218 -de.cau.cs.kieler.portLabelPlacement
136 +de.cau.cs.kieler.edgeLabelPlacement
219 219  )))|(% colspan="1" %)(% colspan="1" %)
220 220  (((
221 221  Enum
222 222  )))|(% colspan="1" %)(% colspan="1" %)
223 223  (((
224 -Nodes
142 +Labels
225 225  )))|(% colspan="1" %)(% colspan="1" %)
226 226  (((
227 -OUTSIDE
145 +UNDEFINED
228 228  )))
229 -|(% colspan="1" %)(% colspan="1" %)
230 -(((
231 -Port Spacing
232 -)))|(% colspan="1" %)(% colspan="1" %)
233 -(((
234 -de.cau.cs.kieler.portSpacing
235 -)))|(% colspan="1" %)(% colspan="1" %)
236 -(((
237 -Float
238 -)))|(% colspan="1" %)(% colspan="1" %)
239 -(((
240 -Nodes
241 -)))|(% colspan="1" %)(% colspan="1" %)
242 -(((
243 -
244 -)))
245 245  |(((
246 -Position
148 +Edge Routing
247 247  )))|(((
248 -de.cau.cs.kieler.position
150 +de.cau.cs.kieler.edgeRouting
249 249  )))|(((
250 -Object
152 +Enum
251 251  )))|(((
252 -Labels
253 -Nodes
254 -Ports
154 +Parents
255 255  )))|(((
256 -
156 +UNDEFINED
257 257  )))
258 -|(((
259 -Priority
260 -)))|(((
261 -de.cau.cs.kieler.priority
262 -)))|(((
263 -Int
264 -)))|(((
265 -Edges
266 -Nodes
267 -)))|(((
268 -
269 -)))
270 270  |(% colspan="1" %)(% colspan="1" %)
271 271  (((
272 -Randomization Seed
160 +Edge Type
273 273  )))|(% colspan="1" %)(% colspan="1" %)
274 274  (((
275 -de.cau.cs.kieler.randomSeed
163 +de.cau.cs.kieler.edgeType
276 276  )))|(% colspan="1" %)(% colspan="1" %)
277 277  (((
278 -Int
166 +Enum
279 279  )))|(% colspan="1" %)(% colspan="1" %)
280 280  (((
281 -Parents
169 +Edges
282 282  )))|(% colspan="1" %)(% colspan="1" %)
283 283  (((
284 -
172 +NONE
285 285  )))
286 -|(% colspan="1" %)(% colspan="1" %)
287 -(((
288 -Separate Connected Components
289 -)))|(% colspan="1" %)(% colspan="1" %)
290 -(((
291 -de.cau.cs.kieler.separateConnComp
292 -)))|(% colspan="1" %)(% colspan="1" %)
293 -(((
174 +|(((
175 +Expand Nodes
176 +)))|(((
177 +de.cau.cs.kieler.expandNodes
178 +)))|(((
294 294  Boolean
295 -)))|(% colspan="1" %)(% colspan="1" %)
296 -(((
180 +)))|(((
297 297  Parents
298 -)))|(% colspan="1" %)(% colspan="1" %)
299 -(((
300 -
182 +)))|(((
183 +false
301 301  )))
302 302  |(% colspan="1" %)(% colspan="1" %)
303 303  (((
304 -Size Constraint
187 +Font Name
305 305  )))|(% colspan="1" %)(% colspan="1" %)
306 306  (((
307 -de.cau.cs.kieler.sizeConstraint
190 +de.cau.cs.kieler.fontName
308 308  )))|(% colspan="1" %)(% colspan="1" %)
309 309  (((
310 -EnumSet
193 +String
311 311  )))|(% colspan="1" %)(% colspan="1" %)
312 312  (((
313 -Nodes
196 +Labels
314 314  )))|(% colspan="1" %)(% colspan="1" %)
315 315  (((
316 316  
... ... @@ -317,95 +317,31 @@
317 317  )))
318 318  |(% colspan="1" %)(% colspan="1" %)
319 319  (((
320 -Size Options
203 +Font Size
321 321  )))|(% colspan="1" %)(% colspan="1" %)
322 322  (((
323 -de.cau.cs.kieler.sizeOptions
206 +de.cau.cs.kieler.fontSize
324 324  )))|(% colspan="1" %)(% colspan="1" %)
325 325  (((
326 -EnumSet
209 +Int
327 327  )))|(% colspan="1" %)(% colspan="1" %)
328 328  (((
329 -Nodes
212 +Labels
330 330  )))|(% colspan="1" %)(% colspan="1" %)
331 331  (((
332 -DEFAULT_MINIMUM_SIZE
333 -)))
334 -|(% colspan="1" %)(% colspan="1" %)
335 -(((
336 -Spacing
337 -)))|(% colspan="1" %)(% colspan="1" %)
338 -(((
339 -de.cau.cs.kieler.spacing
340 -)))|(% colspan="1" %)(% colspan="1" %)
341 -(((
342 -Float
343 -)))|(% colspan="1" %)(% colspan="1" %)
344 -(((
345 -Parents
346 -)))|(% colspan="1" %)(% colspan="1" %)
347 -(((
348 348  
349 349  )))
350 -
351 -== Programmatic Options ==
352 -
353 -Programmatic options are such that are meant to be configured exclusively through the KIML API. They should not be visible in the user interface.
354 -
355 -|=(((
356 -Option
357 -)))|=(((
358 -ID
359 -)))|=(((
360 -Type
361 -)))|=(((
362 -Applies to
363 -)))|=(((
364 -Default
365 -)))
366 366  |(% colspan="1" %)(% colspan="1" %)
367 367  (((
368 -Animate
219 +Hypernode
369 369  )))|(% colspan="1" %)(% colspan="1" %)
370 370  (((
371 -de.cau.cs.kieler.animate
222 +de.cau.cs.kieler.hypernode
372 372  )))|(% colspan="1" %)(% colspan="1" %)
373 373  (((
374 374  Boolean
375 375  )))|(% colspan="1" %)(% colspan="1" %)
376 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 -(((
400 -[[Comment Box>>doc:||anchor="commentBox"]]
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 409  Nodes
410 410  )))|(% colspan="1" %)(% colspan="1" %)
411 411  (((
... ... @@ -412,103 +412,96 @@
412 412  false
413 413  )))
414 414  |(((
415 -[[Diagram Type>>doc:||anchor="diagramType"]]
234 +Interactive
416 416  )))|(((
417 -de.cau.cs.kieler.diagramType
236 +de.cau.cs.kieler.interactive
418 418  )))|(((
419 -String
238 +Boolean
420 420  )))|(((
421 421  Parents
422 422  )))|(((
423 -
242 +false
424 424  )))
425 425  |(((
426 -Edge Label Placement
245 +Label Spacing
427 427  )))|(((
428 -de.cau.cs.kieler.edgeLabelPlacement
247 +de.cau.cs.kieler.labelSpacing
429 429  )))|(((
430 -Enum
249 +Float
431 431  )))|(((
432 -Labels
251 +Edges
252 +Nodes
433 433  )))|(((
434 -
254 +-1.0
435 435  )))
436 -|(% colspan="1" %)(% colspan="1" %)
437 -(((
438 -Edge Type
439 -)))|(% colspan="1" %)(% colspan="1" %)
440 -(((
441 -de.cau.cs.kieler.edgeType
442 -)))|(% colspan="1" %)(% colspan="1" %)
443 -(((
444 -Enum
445 -)))|(% colspan="1" %)(% colspan="1" %)
446 -(((
447 -Edges
448 -)))|(% colspan="1" %)(% colspan="1" %)
449 -(((
450 -NONE
256 +|(((
257 +Layout Hierarchy
258 +)))|(((
259 +de.cau.cs.kieler.layoutHierarchy
260 +)))|(((
261 +Boolean
262 +)))|(((
263 +Parents
264 +)))|(((
265 +false
451 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 -(((
267 +|(((
268 +Layout Algorithm
269 +)))|(((
270 +de.cau.cs.kieler.algorithm
271 +)))|(((
460 460  String
461 -)))|(% colspan="1" %)(% colspan="1" %)
462 -(((
463 -Labels
464 -)))|(% colspan="1" %)(% colspan="1" %)
465 -(((
273 +)))|(((
274 +Parents
275 +)))|(((
466 466  
467 467  )))
468 468  |(% colspan="1" %)(% colspan="1" %)
469 469  (((
470 -Font Size
280 +Minimal Height
471 471  )))|(% colspan="1" %)(% colspan="1" %)
472 472  (((
473 -de.cau.cs.kieler.fontSize
283 +de.cau.cs.kieler.minHeight
474 474  )))|(% colspan="1" %)(% colspan="1" %)
475 475  (((
476 -Int
286 +Float
477 477  )))|(% colspan="1" %)(% colspan="1" %)
478 478  (((
479 -Labels
289 +Nodes
290 +Parents
480 480  )))|(% colspan="1" %)(% colspan="1" %)
481 481  (((
482 -
293 +0.0
483 483  )))
484 484  |(% colspan="1" %)(% colspan="1" %)
485 485  (((
486 -[[Hypernode>>doc:||anchor="hypernode"]]
297 +Minimal Width
487 487  )))|(% colspan="1" %)(% colspan="1" %)
488 488  (((
489 -de.cau.cs.kieler.hypernode
300 +de.cau.cs.kieler.minWidth
490 490  )))|(% colspan="1" %)(% colspan="1" %)
491 491  (((
492 -Boolean
303 +Float
493 493  )))|(% colspan="1" %)(% colspan="1" %)
494 494  (((
495 495  Nodes
307 +Parents
496 496  )))|(% colspan="1" %)(% colspan="1" %)
497 497  (((
498 -false
310 +0.0
499 499  )))
500 500  |(% colspan="1" %)(% colspan="1" %)
501 501  (((
502 -Layout Ancestors
314 +No Layout
503 503  )))|(% colspan="1" %)(% colspan="1" %)
504 504  (((
505 -de.cau.cs.kieler.layoutAncestors
317 +de.cau.cs.kieler.noLayout
506 506  )))|(% colspan="1" %)(% colspan="1" %)
507 507  (((
508 508  Boolean
509 509  )))|(% colspan="1" %)(% colspan="1" %)
510 510  (((
511 -Parents
323 +
512 512  )))|(% colspan="1" %)(% colspan="1" %)
513 513  (((
514 514  false
... ... @@ -515,130 +515,116 @@
515 515  )))
516 516  |(% colspan="1" %)(% colspan="1" %)
517 517  (((
518 -Maximal Animation Time
330 +Node Label Placement
519 519  )))|(% colspan="1" %)(% colspan="1" %)
520 520  (((
521 -de.cau.cs.kieler.maxAnimTim
333 +de.cau.cs.kieler.nodeLabelPlacement
522 522  )))|(% colspan="1" %)(% colspan="1" %)
523 523  (((
524 -Int
336 +EnumSet
525 525  )))|(% colspan="1" %)(% colspan="1" %)
526 526  (((
527 -Parents
339 +Nodes
528 528  )))|(% colspan="1" %)(% colspan="1" %)
529 529  (((
530 -4000
342 +
531 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
344 +|(((
345 +Port Constraints
346 +)))|(((
347 +de.cau.cs.kieler.portConstraints
348 +)))|(((
349 +Enum
350 +)))|(((
351 +Nodes
352 +)))|(((
353 +UNDEFINED
547 547  )))
548 548  |(% colspan="1" %)(% colspan="1" %)
549 549  (((
550 -Minimal Height
357 +Port Label Placement
551 551  )))|(% colspan="1" %)(% colspan="1" %)
552 552  (((
553 -de.cau.cs.kieler.minHeight
360 +de.cau.cs.kieler.portLabelPlacement
554 554  )))|(% colspan="1" %)(% colspan="1" %)
555 555  (((
556 -Float
363 +Enum
557 557  )))|(% colspan="1" %)(% colspan="1" %)
558 558  (((
559 559  Nodes
560 -Parents
561 561  )))|(% colspan="1" %)(% colspan="1" %)
562 562  (((
563 -0.0
369 +OUTSIDE
564 564  )))
565 565  |(% colspan="1" %)(% colspan="1" %)
566 566  (((
567 -Minimal Width
373 +[[Port Offset>>doc:||anchor="portOffset"]]
568 568  )))|(% colspan="1" %)(% colspan="1" %)
569 569  (((
570 -de.cau.cs.kieler.minWidth
376 +de.cau.cs.kieler.offset
571 571  )))|(% colspan="1" %)(% colspan="1" %)
572 572  (((
573 573  Float
574 574  )))|(% colspan="1" %)(% colspan="1" %)
575 575  (((
576 -Nodes
577 -Parents
382 +Ports
578 578  )))|(% colspan="1" %)(% colspan="1" %)
579 579  (((
580 -0.0
581 -)))
582 -|(% colspan="1" %)(% colspan="1" %)
583 -(((
584 -[[No Layout>>doc:||anchor="noLayout"]]
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 -(((
593 593  
594 -)))|(% colspan="1" %)(% colspan="1" %)
595 -(((
596 -false
597 597  )))
598 598  |(% colspan="1" %)(% colspan="1" %)
599 599  (((
600 -Port Index
389 +Port Side
601 601  )))|(% colspan="1" %)(% colspan="1" %)
602 602  (((
603 -de.cau.cs.kieler.portIndex
392 +de.cau.cs.kieler.portSide
604 604  )))|(% colspan="1" %)(% colspan="1" %)
605 605  (((
606 -Int
395 +Enum
607 607  )))|(% colspan="1" %)(% colspan="1" %)
608 608  (((
609 609  Ports
610 610  )))|(% colspan="1" %)(% colspan="1" %)
611 611  (((
612 -
401 +UNDEFINED
613 613  )))
614 -|(% colspan="1" %)(% colspan="1" %)
615 -(((
616 -[[Port Offset>>doc:||anchor="portOffset"]]
617 -)))|(% colspan="1" %)(% colspan="1" %)
618 -(((
619 -de.cau.cs.kieler.offset
620 -)))|(% colspan="1" %)(% colspan="1" %)
621 -(((
622 -Float
623 -)))|(% colspan="1" %)(% colspan="1" %)
624 -(((
403 +|(((
404 +Position
405 +)))|(((
406 +de.cau.cs.kieler.position
407 +)))|(((
408 +Object
409 +)))|(((
410 +Labels
411 +Nodes
625 625  Ports
626 -)))|(% colspan="1" %)(% colspan="1" %)
627 -(((
413 +)))|(((
628 628  
629 629  )))
416 +|(((
417 +Priority
418 +)))|(((
419 +de.cau.cs.kieler.priority
420 +)))|(((
421 +Int
422 +)))|(((
423 +Edges
424 +Nodes
425 +)))|(((
426 +
427 +)))
630 630  |(% colspan="1" %)(% colspan="1" %)
631 631  (((
632 -Port Side
430 +Randomization Seed
633 633  )))|(% colspan="1" %)(% colspan="1" %)
634 634  (((
635 -de.cau.cs.kieler.portSide
433 +de.cau.cs.kieler.randomSeed
636 636  )))|(% colspan="1" %)(% colspan="1" %)
637 637  (((
638 -Enum
436 +Int
639 639  )))|(% colspan="1" %)(% colspan="1" %)
640 640  (((
641 -Ports
439 +Parents
642 642  )))|(% colspan="1" %)(% colspan="1" %)
643 643  (((
644 644  
... ... @@ -645,10 +645,10 @@
645 645  )))
646 646  |(% colspan="1" %)(% colspan="1" %)
647 647  (((
648 -Progress Bar
446 +Separate Connected Components
649 649  )))|(% colspan="1" %)(% colspan="1" %)
650 650  (((
651 -de.cau.cs.kieler.progressBar
449 +de.cau.cs.kieler.separateConnComp
652 652  )))|(% colspan="1" %)(% colspan="1" %)
653 653  (((
654 654  Boolean
... ... @@ -657,214 +657,67 @@
657 657  Parents
658 658  )))|(% colspan="1" %)(% colspan="1" %)
659 659  (((
660 -false
458 +
661 661  )))
662 662  |(% colspan="1" %)(% colspan="1" %)
663 663  (((
664 -Scale Factor
462 +Size Constraint
665 665  )))|(% colspan="1" %)(% colspan="1" %)
666 666  (((
667 -de.cau.cs.kieler.scaleFactor
465 +de.cau.cs.kieler.sizeConstraint
668 668  )))|(% colspan="1" %)(% colspan="1" %)
669 669  (((
670 -Float
468 +EnumSet
671 671  )))|(% colspan="1" %)(% colspan="1" %)
672 672  (((
673 673  Nodes
674 674  )))|(% colspan="1" %)(% colspan="1" %)
675 675  (((
676 -1.0
474 +
677 677  )))
678 678  |(% colspan="1" %)(% colspan="1" %)
679 679  (((
680 -Thickness
478 +Size Options
681 681  )))|(% colspan="1" %)(% colspan="1" %)
682 682  (((
683 -de.cau.cs.kieler.thickness
481 +de.cau.cs.kieler.sizeOptions
684 684  )))|(% colspan="1" %)(% colspan="1" %)
685 685  (((
686 -Float
484 +EnumSet
687 687  )))|(% colspan="1" %)(% colspan="1" %)
688 688  (((
689 -Edges
487 +Nodes
690 690  )))|(% colspan="1" %)(% colspan="1" %)
691 691  (((
692 -1.0
490 +DEFAULT_MINIMUM_SIZE
693 693  )))
694 694  |(% colspan="1" %)(% colspan="1" %)
695 695  (((
696 -Zoom to Fit
494 +Spacing
697 697  )))|(% colspan="1" %)(% colspan="1" %)
698 698  (((
699 -de.cau.cs.kieler.zoomToFit
497 +de.cau.cs.kieler.spacing
700 700  )))|(% colspan="1" %)(% colspan="1" %)
701 701  (((
702 -Boolean
500 +Float
703 703  )))|(% colspan="1" %)(% colspan="1" %)
704 704  (((
705 705  Parents
706 706  )))|(% colspan="1" %)(% colspan="1" %)
707 707  (((
708 -false
506 +-1.0
709 709  )))
710 710  
711 -=== Layout Output Properties ===
509 += The Most Important Options =
712 712  
713 -A few properties are used as additional information in the output of a layout algorithm. This information should be considered when the layout is applied to the original diagram
511 +**TODO:** Write a bit of documentation about the most important layout options and how to use them, possibly with a simple example or something.
714 714  
715 -|=(((
716 -Property
717 -)))|=(((
718 -ID
719 -)))|=(((
720 -Type
721 -)))|=(((
722 -Applies to
723 -)))
724 -|(((
725 -[[Edge Routing>>doc:||anchor="edgeRouting"]]
726 -)))|(((
727 -de.cau.cs.kieler.edgeRouting
728 -)))|(((
729 -Enum
730 -)))|(((
731 -Edges
732 -)))
733 -|(((
734 -Junction Points
735 -)))|(((
736 -de.cau.cs.kieler.junctionPoints
737 -)))|(((
738 -Object
739 -)))|(((
740 -Edges
741 -)))
742 -
743 -
744 -
745 745  = Detailed Documentation =
746 746  
747 747  This section explains every layout option in more detail.
748 748  
749 -== The Most Important Options ==
517 +== Port Offset ==
750 750  
751 -While most layout options are used to affect how the active layout algorithm computes concrete coordinates for the graph elements, there are some layout options that have a special role in KIML.
752 -
753 -=== Layout Algorithm ===
754 -
755 -{{id name="layoutAlgorithm"/}}
756 -
757 -The option with identifier {{code language="none"}}de.cau.cs.kieler.algorithm{{/code}} specifies which layout algorithm to use for a graph or subgraph. The value can be either the identifier of a layout algorithm or the identifier of a layout type. In the latter case the algorithm with highest priority of that type is applied. It is possible to set different values for this option on subgraphs of a hierarchical graph, where a subgraph is identified by a parent node. A layout algorithm is responsible to process only the direct content of a given parent node. An exception from this rule is made when the [[Layout Hierarchy>>doc:||anchor="layoutHierarchy"]] option is active.
758 -
759 -The following layout has been created by setting a force-based layout algorithm on the inner hierarchy level and a layer-based layout algorithm on the top level.
760 -
761 -[[image:attach:layout_algorithm.png]]
762 -
763 -==== Available Algorithms and Libraries ====
764 -
765 -* **The [[KLay Project>>doc:Layout Algorithms (KLay)]]** - Java implementations of standard layout approaches, augmented with special processing of graph features such as ports and labels.
766 -* **Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
767 -* (((
768 -**Box Layout** - Ignores edges, places all nodes in rows. Can be used to layout collections of unconnected boxes, such as Statechart regions.
769 -)))
770 -* **Fixed Layout** - Does not compute a new layout, but leaves all nodes and edges where they are. If the Position and Bend Points options are set for the elements of the graph, the pre-defined layout is applied.
771 -* **OGDF** ((% style="color: rgb(0,0,0);" %)[[www.ogdf.net>>url:http://www.ogdf.net/||shape="rect"]](%%)) - A self-contained C++ class library for the automatic layout of diagrams. The version that is shipped with KIELER is compiled as an executable that reads files in OGML format and outputs the computed concrete layout.
772 -* **Graphviz** ([[www.graphviz.org>>url:http://www.graphviz.org/||shape="rect"]]) - An open source graph visualization tool with several graph layout programs, web and interactive graphical interfaces, auxiliary tools, libraries, and language bindings. Graphviz needs to be installed separately in order to be used within KIELER, since it is called in a separate process using the DOT language for communication.
773 -
774 -==== Predefined Layout Types ====
775 -
776 -* **Layered** - The layer-based method emphasizes the direction of edges by pointing as many edges as possible into the same direction. The nodes are arranged in layers and then reordered such that the number of edge crossings is minimized. Afterwards, concrete coordinates are computed for the nodes and edge bend points.
777 -* **Orthogonal** - Orthogonal methods follow the "topology-shape-metrics" approach, which first applies a planarization technique, resulting in a planar representation of the graph, then compute an orthogonal shape, and finally determine concrete coordinates for nodes and edge bend points by applying a compaction method.
778 -* **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
779 -* **Circular** - Circular layout algorithms emphasize biconnected components of a graph by arranging them in circles. This is useful if a drawing is desired where such components are clearly grouped, or where cycles are shown as prominent properties of the graph.
780 -* **Tree** - Specialized layout methods for trees, i.e. acyclic graphs. The regular structure of graphs that have no undirected cycles can be emphasized using an algorithm of this type.
781 -
782 -=== Diagram Type ===
783 -
784 -{{id name="diagramType"/}}
785 -
786 -Diagram types are used to classify graphical diagrams for setting default layout option values for a set of similar diagrams. The diagram type of an element is specified with the layout option {{code language="none"}}de.cau.cs.kieler.diagramType{{/code}}. Layout algorithms can declare which diagram types they support well, and give a priority value for each supported type. KIML decides at runtime which layout algorithm has the highest priority for a given diagram, so that the most suitable algorithm is always used. Usual values for such priorities are between 1 and 10, where the highest value should only be assigned if the algorithm is especially designed for diagrams of the respective type, or if it has proven to be very adequate for them. Lower values should be given if the algorithm is able to draw the diagrams correctly, but with lower quality of the resulting layout.
787 -
788 -The following diagram types are predefined:
789 -
790 -* **General** - This type is automatically assigned to all diagrams for which no specific type is declared. A layout algorithm that has the highest priority on the //General// diagram type is taken as the default algorithm when no further information on a diagram is available to KIML.
791 -* **State Machine** - All kinds of state machines, automata, and activity diagrams. Examples: [[doc:SCCharts SyncCharts]], UML Activity diagrams.
792 -* **Data Flow Diagram** - Actor-oriented diagrams, where connections are mostly done between //ports// of nodes. These diagrams can only be handled properly by very special layout algorithms, such as those developed in the [[KLay project>>doc:Layout Algorithms (KLay)]].
793 -* **Class Diagram** - Class diagrams such as Ecore diagrams for the [[EMF>>url:http://www.eclipse.org/modeling/emf/||shape="rect"]] or UML Class diagrams.
794 -* **Use Case Diagram** - Use case diagrams as defined by the UML.
795 -* **Unconnected Boxes** - Sets of nodes that have no connections and are treated as resizable boxes. This is related to mathematical [[packing problems>>url:http://en.wikipedia.org/wiki/Packing_problem||shape="rect"]]. Example: Regions in [[doc:SCCharts SyncCharts]].
796 -
797 -=== Edge Routing ===
798 -
799 -{{id name="edgeRouting"/}}
800 -
801 -This option influences the way in which edges are routed between the nodes they connect. The following settings are available:
802 -
803 -* POLYLINE
804 -Edges consist of one or more segments defined by a list of bend points.
805 -* ORTHOGONAL
806 -Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically.
807 -* SPLINES
808 -Edges are routed as splines (smooth curves).
809 -* UNDEFINED
810 -No particular edge routing style is selected. Usually this value points to the default setting of the selected layout algorithm.
811 -
812 -[[image:attach:edge_routing.png]]
813 -
814 -When used as layout option, the edge routing is set for a whole graph or subgraph, i.e. on a parent node. However, the property is additionally used for the output of the layout algorithm in order to mark individual edges. If the edge routing assigned to an edge is anything other than SPLINES, the bend points of that edge are interpreted with their normal meaning, i.e. straight lines are drawn between consecutive bend points. If, on the other hand, a layout algorithm marks an edge with the value SPLINES, the bend points have to be interpreted as control points for a series of cubic splines following this procedure:
815 -
816 -1. Start at the source point of the edge.
817 -1. As long as there are at least three bend points left:
818 -11. Draw a cubic spline segment to the third bend point with the other two bend points as control points.
819 -11. Use the third bend point as start point for the next segment.
820 -11. Consume the three bend points and proceed to the next segment.
821 -1. Check the number of remaining bend points:
822 -11. Two bend points – draw a cubic spline segment to the target point of the edge.
823 -11. One bend point – draw a quadratic spline segment to the target point of the edge.
824 -11. No bend point – draw a straight line to the target point of the edge.
825 -
826 -== Other Options ==
827 -
828 -=== Alignment ===
829 -
830 -{{id name="alignment"/}}
831 -
832 -Determines the alignment of a node in relation to other nodes of the same row or column. For layer-based algorithms, for instance, this option controls how a node is positioned inside its assigned layer.
833 -
834 -=== Aspect Ratio ===
835 -
836 -{{id name="aspectRatio"/}}
837 -
838 -The aspect ratio of a drawing is the ratio of its total width to its total height. This option gives some control over that ratio, although in most cases it is only interpreted as a hint on how to arrange multiple connected components, hence the actual aspect ratio will probably be different from what has been specified with the option.
839 -
840 -=== Comment Box ===
841 -
842 -{{id name="commentBox"/}}
843 -
844 -A node that is marked as comment box is treated as a label that needs to be placed somewhere. In contrast to normal node labels (modeled with a KLabel instance), comment boxes may have connections to other nodes, as in the following example.
845 -
846 -[[image:attach:comment_box.png]]
847 -
848 -=== (% style="line-height: 1.5625;" %)Hypernode(%%) ===
849 -
850 -{{id name="hypernode"/}}
851 -
852 -A node that is marked as hypernode has a special role in the graph structure, since all its incident edges are treated as parts of the same [[hyperedge>>url:http://en.wikipedia.org/wiki/Hypergraph||shape="rect"]]. Example: relation vertices in [[Ptolemy>>url:http://ptolemy.eecs.berkeley.edu/||shape="rect"]] models.
853 -
854 -=== Layout Hierarchy ===
855 -
856 -{{id name="layoutHierarchy"/}}
857 -
858 -If this option is supported and active, the layout algorithm is requested to process the full hierarchy contained in the input node. This means that instead of executing another algorithm on each hierarchy level, all levels are arranged in a single algorithm execution.
859 -
860 -=== No Layout ===
861 -
862 -{{id name="noLayout"/}}
863 -
864 -Elements that are marked with this option are excluded from layout. This is used to identify diagram objects that should not be regarded as graph elements.
865 -
866 -=== Port Offset ===
867 -
868 868  {{id name="portOffset"/}}
869 869  
870 870  The port offset is used to specify how much space a layout algorithm should leave between a port and the border of its node. This is usually zero, but doesn't have to be. If the offset is not defined for a given port, a layout algorithm can try to infer the offset from the port's coordinates and its node's size in the input graph. This of course requires both properties to be set to sensible values.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470074
1 +7111110
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470074/KIML Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/7111110/KIML Layout Options