Skip to Content

Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
From version 19.1
edited by msp
on 2014/03/08 20:04
Change comment: There is no comment for this version
To version 16.1
edited by msp
on 2014/03/05 13:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,29 +2,25 @@
2 2  This is preliminary and incomplete documentation. You've been warned.
3 3  {{/warning}}
4 4  
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, 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.
6 6  
7 7  **Contents**
8 8  
9 9  
10 10  
11 -{{toc maxLevel="2"/}}
11 +{{toc/}}
12 12  
13 13  = Overview =
14 14  
15 -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:
16 16  
17 17  * An ID to identify them.
18 -* 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.
19 -* 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.
20 -* 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.
21 21  
22 -Layout options can be assigned to two main categories: user options and programmatic options.
22 +KIML defines the following set of layout options:
23 23  
24 -== User Options ==
25 -
26 -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.
27 -
28 28  |=(((
29 29  Option
30 30  )))|=(((
... ... @@ -78,46 +78,29 @@
78 78  )))|(((
79 79  Parents
80 80  )))|(((
81 -
77 +-1.0
82 82  )))
83 -|(((
84 -Debug Mode
85 -)))|(((
86 -de.cau.cs.kieler.debugMode
87 -)))|(((
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 +(((
88 88  Boolean
89 -)))|(((
90 -Parents
91 -)))|(((
88 +)))|(% colspan="1" %)(% colspan="1" %)
89 +(((
90 +Nodes
91 +)))|(% colspan="1" %)(% colspan="1" %)
92 +(((
92 92  false
93 93  )))
94 94  |(((
95 -Direction
96 +Debug Mode
96 96  )))|(((
97 -de.cau.cs.kieler.direction
98 +de.cau.cs.kieler.debugMode
98 98  )))|(((
99 -Enum
100 -)))|(((
101 -Parents
102 -)))|(((
103 -
104 -)))
105 -|(((
106 -[[Edge Routing>>doc:||anchor="edgeRouting"]]
107 -)))|(((
108 -de.cau.cs.kieler.edgeRouting
109 -)))|(((
110 -Enum
111 -)))|(((
112 -Parents
113 -)))|(((
114 -
115 -)))
116 -|(((
117 -Expand Nodes
118 -)))|(((
119 -de.cau.cs.kieler.expandNodes
120 -)))|(((
121 121  Boolean
122 122  )))|(((
123 123  Parents
... ... @@ -124,179 +124,99 @@
124 124  )))|(((
125 125  false
126 126  )))
127 -|(((
128 -Interactive
129 -)))|(((
130 -de.cau.cs.kieler.interactive
131 -)))|(((
132 -Boolean
133 -)))|(((
134 -Parents
135 -)))|(((
136 -false
137 -)))
138 -|(((
139 -Label Spacing
140 -)))|(((
141 -de.cau.cs.kieler.labelSpacing
142 -)))|(((
143 -Float
144 -)))|(((
145 -Edges
146 -Nodes
147 -)))|(((
148 -
149 -)))
150 -|(((
151 -Layout Hierarchy
152 -)))|(((
153 -de.cau.cs.kieler.layoutHierarchy
154 -)))|(((
155 -Boolean
156 -)))|(((
157 -Parents
158 -)))|(((
159 -false
160 -)))
161 -|(((
162 -[[Layout Algorithm>>doc:||anchor="layoutAlgorithm"]]
163 -)))|(((
164 -de.cau.cs.kieler.algorithm
165 -)))|(((
166 -String
167 -)))|(((
168 -Parents
169 -)))|(((
170 -
171 -)))
172 172  |(% colspan="1" %)(% colspan="1" %)
173 173  (((
174 -Node Label Placement
108 +[[Diagram Type>>doc:||anchor="diagramType"]]
175 175  )))|(% colspan="1" %)(% colspan="1" %)
176 176  (((
177 -de.cau.cs.kieler.nodeLabelPlacement
111 +de.cau.cs.kieler.diagramType
178 178  )))|(% colspan="1" %)(% colspan="1" %)
179 179  (((
180 -EnumSet
114 +String
181 181  )))|(% colspan="1" %)(% colspan="1" %)
182 182  (((
183 -Nodes
117 +
184 184  )))|(% colspan="1" %)(% colspan="1" %)
185 185  (((
186 186  
187 187  )))
188 188  |(((
189 -Port Constraints
123 +Direction
190 190  )))|(((
191 -de.cau.cs.kieler.portConstraints
125 +de.cau.cs.kieler.direction
192 192  )))|(((
193 193  Enum
194 194  )))|(((
195 -Nodes
129 +Parents
196 196  )))|(((
197 -
131 +UNDEFINED
198 198  )))
199 199  |(% colspan="1" %)(% colspan="1" %)
200 200  (((
201 -Port Label Placement
135 +Edge Label Placement
202 202  )))|(% colspan="1" %)(% colspan="1" %)
203 203  (((
204 -de.cau.cs.kieler.portLabelPlacement
138 +de.cau.cs.kieler.edgeLabelPlacement
205 205  )))|(% colspan="1" %)(% colspan="1" %)
206 206  (((
207 207  Enum
208 208  )))|(% colspan="1" %)(% colspan="1" %)
209 209  (((
210 -Nodes
144 +Labels
211 211  )))|(% colspan="1" %)(% colspan="1" %)
212 212  (((
213 -OUTSIDE
147 +UNDEFINED
214 214  )))
215 -|(% colspan="1" %)(% colspan="1" %)
216 -(((
217 -Port Spacing
218 -)))|(% colspan="1" %)(% colspan="1" %)
219 -(((
220 -de.cau.cs.kieler.portSpacing
221 -)))|(% colspan="1" %)(% colspan="1" %)
222 -(((
223 -Float
224 -)))|(% colspan="1" %)(% colspan="1" %)
225 -(((
226 -Nodes
227 -)))|(% colspan="1" %)(% colspan="1" %)
228 -(((
229 -
230 -)))
231 231  |(((
232 -Position
150 +[[Edge Routing>>doc:||anchor="edgeRouting"]]
233 233  )))|(((
234 -de.cau.cs.kieler.position
152 +de.cau.cs.kieler.edgeRouting
235 235  )))|(((
236 -Object
154 +Enum
237 237  )))|(((
238 -Labels
239 -Nodes
240 -Ports
156 +Parents
241 241  )))|(((
242 -
158 +UNDEFINED
243 243  )))
244 -|(((
245 -Priority
246 -)))|(((
247 -de.cau.cs.kieler.priority
248 -)))|(((
249 -Int
250 -)))|(((
251 -Edges
252 -Nodes
253 -)))|(((
254 -
255 -)))
256 256  |(% colspan="1" %)(% colspan="1" %)
257 257  (((
258 -Randomization Seed
162 +Edge Type
259 259  )))|(% colspan="1" %)(% colspan="1" %)
260 260  (((
261 -de.cau.cs.kieler.randomSeed
165 +de.cau.cs.kieler.edgeType
262 262  )))|(% colspan="1" %)(% colspan="1" %)
263 263  (((
264 -Int
168 +Enum
265 265  )))|(% colspan="1" %)(% colspan="1" %)
266 266  (((
267 -Parents
171 +Edges
268 268  )))|(% colspan="1" %)(% colspan="1" %)
269 269  (((
270 -
174 +NONE
271 271  )))
272 -|(% colspan="1" %)(% colspan="1" %)
273 -(((
274 -Separate Connected Components
275 -)))|(% colspan="1" %)(% colspan="1" %)
276 -(((
277 -de.cau.cs.kieler.separateConnComp
278 -)))|(% colspan="1" %)(% colspan="1" %)
279 -(((
176 +|(((
177 +Expand Nodes
178 +)))|(((
179 +de.cau.cs.kieler.expandNodes
180 +)))|(((
280 280  Boolean
281 -)))|(% colspan="1" %)(% colspan="1" %)
282 -(((
182 +)))|(((
283 283  Parents
284 -)))|(% colspan="1" %)(% colspan="1" %)
285 -(((
286 -
184 +)))|(((
185 +false
287 287  )))
288 288  |(% colspan="1" %)(% colspan="1" %)
289 289  (((
290 -Size Constraint
189 +Font Name
291 291  )))|(% colspan="1" %)(% colspan="1" %)
292 292  (((
293 -de.cau.cs.kieler.sizeConstraint
192 +de.cau.cs.kieler.fontName
294 294  )))|(% colspan="1" %)(% colspan="1" %)
295 295  (((
296 -EnumSet
195 +String
297 297  )))|(% colspan="1" %)(% colspan="1" %)
298 298  (((
299 -Nodes
198 +Labels
300 300  )))|(% colspan="1" %)(% colspan="1" %)
301 301  (((
302 302  
... ... @@ -303,95 +303,31 @@
303 303  )))
304 304  |(% colspan="1" %)(% colspan="1" %)
305 305  (((
306 -Size Options
205 +Font Size
307 307  )))|(% colspan="1" %)(% colspan="1" %)
308 308  (((
309 -de.cau.cs.kieler.sizeOptions
208 +de.cau.cs.kieler.fontSize
310 310  )))|(% colspan="1" %)(% colspan="1" %)
311 311  (((
312 -EnumSet
211 +Int
313 313  )))|(% colspan="1" %)(% colspan="1" %)
314 314  (((
315 -Nodes
214 +Labels
316 316  )))|(% colspan="1" %)(% colspan="1" %)
317 317  (((
318 -DEFAULT_MINIMUM_SIZE
319 -)))
320 -|(% colspan="1" %)(% colspan="1" %)
321 -(((
322 -Spacing
323 -)))|(% colspan="1" %)(% colspan="1" %)
324 -(((
325 -de.cau.cs.kieler.spacing
326 -)))|(% colspan="1" %)(% colspan="1" %)
327 -(((
328 -Float
329 -)))|(% colspan="1" %)(% colspan="1" %)
330 -(((
331 -Parents
332 -)))|(% colspan="1" %)(% colspan="1" %)
333 -(((
334 334  
335 335  )))
336 -
337 -== Programmatic Options ==
338 -
339 -Programmatic options are such that are meant to be configured exclusively through the KIML API. They should not be visible in the user interface.
340 -
341 -|=(((
342 -Option
343 -)))|=(((
344 -ID
345 -)))|=(((
346 -Type
347 -)))|=(((
348 -Applies to
349 -)))|=(((
350 -Default
351 -)))
352 352  |(% colspan="1" %)(% colspan="1" %)
353 353  (((
354 -Animate
221 +Hypernode
355 355  )))|(% colspan="1" %)(% colspan="1" %)
356 356  (((
357 -de.cau.cs.kieler.animate
224 +de.cau.cs.kieler.hypernode
358 358  )))|(% colspan="1" %)(% colspan="1" %)
359 359  (((
360 360  Boolean
361 361  )))|(% colspan="1" %)(% colspan="1" %)
362 362  (((
363 -Parents
364 -)))|(% colspan="1" %)(% colspan="1" %)
365 -(((
366 -true
367 -)))
368 -|(% colspan="1" %)(% colspan="1" %)
369 -(((
370 -Animation Time Factor
371 -)))|(% colspan="1" %)(% colspan="1" %)
372 -(((
373 -de.cau.cs.kieler.animTimeFactor
374 -)))|(% colspan="1" %)(% colspan="1" %)
375 -(((
376 -Int
377 -)))|(% colspan="1" %)(% colspan="1" %)
378 -(((
379 -Parents
380 -)))|(% colspan="1" %)(% colspan="1" %)
381 -(((
382 -100
383 -)))
384 -|(% colspan="1" %)(% colspan="1" %)
385 -(((
386 -Comment Box
387 -)))|(% colspan="1" %)(% colspan="1" %)
388 -(((
389 -de.cau.cs.kieler.commentBox
390 -)))|(% colspan="1" %)(% colspan="1" %)
391 -(((
392 -Boolean
393 -)))|(% colspan="1" %)(% colspan="1" %)
394 -(((
395 395  Nodes
396 396  )))|(% colspan="1" %)(% colspan="1" %)
397 397  (((
... ... @@ -398,103 +398,96 @@
398 398  false
399 399  )))
400 400  |(((
401 -[[Diagram Type>>doc:||anchor="diagramType"]]
236 +Interactive
402 402  )))|(((
403 -de.cau.cs.kieler.diagramType
238 +de.cau.cs.kieler.interactive
404 404  )))|(((
405 -String
240 +Boolean
406 406  )))|(((
407 407  Parents
408 408  )))|(((
409 -
244 +false
410 410  )))
411 411  |(((
412 -Edge Label Placement
247 +Label Spacing
413 413  )))|(((
414 -de.cau.cs.kieler.edgeLabelPlacement
249 +de.cau.cs.kieler.labelSpacing
415 415  )))|(((
416 -Enum
251 +Float
417 417  )))|(((
418 -Labels
253 +Edges
254 +Nodes
419 419  )))|(((
420 -
256 +-1.0
421 421  )))
422 -|(% colspan="1" %)(% colspan="1" %)
423 -(((
424 -Edge Type
425 -)))|(% colspan="1" %)(% colspan="1" %)
426 -(((
427 -de.cau.cs.kieler.edgeType
428 -)))|(% colspan="1" %)(% colspan="1" %)
429 -(((
430 -Enum
431 -)))|(% colspan="1" %)(% colspan="1" %)
432 -(((
433 -Edges
434 -)))|(% colspan="1" %)(% colspan="1" %)
435 -(((
436 -NONE
258 +|(((
259 +Layout Hierarchy
260 +)))|(((
261 +de.cau.cs.kieler.layoutHierarchy
262 +)))|(((
263 +Boolean
264 +)))|(((
265 +Parents
266 +)))|(((
267 +false
437 437  )))
438 -|(% colspan="1" %)(% colspan="1" %)
439 -(((
440 -Font Name
441 -)))|(% colspan="1" %)(% colspan="1" %)
442 -(((
443 -de.cau.cs.kieler.fontName
444 -)))|(% colspan="1" %)(% colspan="1" %)
445 -(((
269 +|(((
270 +[[Layout Algorithm>>doc:||anchor="layoutAlgorithm"]]
271 +)))|(((
272 +de.cau.cs.kieler.algorithm
273 +)))|(((
446 446  String
447 -)))|(% colspan="1" %)(% colspan="1" %)
448 -(((
449 -Labels
450 -)))|(% colspan="1" %)(% colspan="1" %)
451 -(((
275 +)))|(((
276 +Parents
277 +)))|(((
452 452  
453 453  )))
454 454  |(% colspan="1" %)(% colspan="1" %)
455 455  (((
456 -Font Size
282 +Minimal Height
457 457  )))|(% colspan="1" %)(% colspan="1" %)
458 458  (((
459 -de.cau.cs.kieler.fontSize
285 +de.cau.cs.kieler.minHeight
460 460  )))|(% colspan="1" %)(% colspan="1" %)
461 461  (((
462 -Int
288 +Float
463 463  )))|(% colspan="1" %)(% colspan="1" %)
464 464  (((
465 -Labels
291 +Nodes
292 +Parents
466 466  )))|(% colspan="1" %)(% colspan="1" %)
467 467  (((
468 -
295 +0.0
469 469  )))
470 470  |(% colspan="1" %)(% colspan="1" %)
471 471  (((
472 -Hypernode
299 +Minimal Width
473 473  )))|(% colspan="1" %)(% colspan="1" %)
474 474  (((
475 -de.cau.cs.kieler.hypernode
302 +de.cau.cs.kieler.minWidth
476 476  )))|(% colspan="1" %)(% colspan="1" %)
477 477  (((
478 -Boolean
305 +Float
479 479  )))|(% colspan="1" %)(% colspan="1" %)
480 480  (((
481 481  Nodes
309 +Parents
482 482  )))|(% colspan="1" %)(% colspan="1" %)
483 483  (((
484 -false
312 +0.0
485 485  )))
486 486  |(% colspan="1" %)(% colspan="1" %)
487 487  (((
488 -Layout Ancestors
316 +No Layout
489 489  )))|(% colspan="1" %)(% colspan="1" %)
490 490  (((
491 -de.cau.cs.kieler.layoutAncestors
319 +de.cau.cs.kieler.noLayout
492 492  )))|(% colspan="1" %)(% colspan="1" %)
493 493  (((
494 494  Boolean
495 495  )))|(% colspan="1" %)(% colspan="1" %)
496 496  (((
497 -Parents
325 +
498 498  )))|(% colspan="1" %)(% colspan="1" %)
499 499  (((
500 500  false
... ... @@ -501,114 +501,116 @@
501 501  )))
502 502  |(% colspan="1" %)(% colspan="1" %)
503 503  (((
504 -Maximal Animation Time
332 +Node Label Placement
505 505  )))|(% colspan="1" %)(% colspan="1" %)
506 506  (((
507 -de.cau.cs.kieler.maxAnimTim
335 +de.cau.cs.kieler.nodeLabelPlacement
508 508  )))|(% colspan="1" %)(% colspan="1" %)
509 509  (((
510 -Int
338 +EnumSet
511 511  )))|(% colspan="1" %)(% colspan="1" %)
512 512  (((
513 -Parents
341 +Nodes
514 514  )))|(% colspan="1" %)(% colspan="1" %)
515 515  (((
516 -4000
344 +
517 517  )))
518 -|(% colspan="1" %)(% colspan="1" %)
519 -(((
520 -Minimal Animation Time
521 -)))|(% colspan="1" %)(% colspan="1" %)
522 -(((
523 -de.cau.cs.kieler.minAnimTim
524 -)))|(% colspan="1" %)(% colspan="1" %)
525 -(((
526 -Int
527 -)))|(% colspan="1" %)(% colspan="1" %)
528 -(((
529 -Parents
530 -)))|(% colspan="1" %)(% colspan="1" %)
531 -(((
532 -400
346 +|(((
347 +Port Constraints
348 +)))|(((
349 +de.cau.cs.kieler.portConstraints
350 +)))|(((
351 +Enum
352 +)))|(((
353 +Nodes
354 +)))|(((
355 +UNDEFINED
533 533  )))
534 534  |(% colspan="1" %)(% colspan="1" %)
535 535  (((
536 -Minimal Height
359 +Port Label Placement
537 537  )))|(% colspan="1" %)(% colspan="1" %)
538 538  (((
539 -de.cau.cs.kieler.minHeight
362 +de.cau.cs.kieler.portLabelPlacement
540 540  )))|(% colspan="1" %)(% colspan="1" %)
541 541  (((
542 -Float
365 +Enum
543 543  )))|(% colspan="1" %)(% colspan="1" %)
544 544  (((
545 545  Nodes
546 -Parents
547 547  )))|(% colspan="1" %)(% colspan="1" %)
548 548  (((
549 -0.0
371 +OUTSIDE
550 550  )))
551 551  |(% colspan="1" %)(% colspan="1" %)
552 552  (((
553 -Minimal Width
375 +[[Port Offset>>doc:||anchor="portOffset"]]
554 554  )))|(% colspan="1" %)(% colspan="1" %)
555 555  (((
556 -de.cau.cs.kieler.minWidth
378 +de.cau.cs.kieler.offset
557 557  )))|(% colspan="1" %)(% colspan="1" %)
558 558  (((
559 559  Float
560 560  )))|(% colspan="1" %)(% colspan="1" %)
561 561  (((
562 -Nodes
563 -Parents
384 +Ports
564 564  )))|(% colspan="1" %)(% colspan="1" %)
565 565  (((
566 -0.0
567 -)))
568 -|(% colspan="1" %)(% colspan="1" %)
569 -(((
570 -No Layout
571 -)))|(% colspan="1" %)(% colspan="1" %)
572 -(((
573 -de.cau.cs.kieler.noLayout
574 -)))|(% colspan="1" %)(% colspan="1" %)
575 -(((
576 -Boolean
577 -)))|(% colspan="1" %)(% colspan="1" %)
578 -(((
579 579  
580 -)))|(% colspan="1" %)(% colspan="1" %)
581 -(((
582 -false
583 583  )))
584 584  |(% colspan="1" %)(% colspan="1" %)
585 585  (((
586 -Port Index
391 +Port Side
587 587  )))|(% colspan="1" %)(% colspan="1" %)
588 588  (((
589 -de.cau.cs.kieler.portIndex
394 +de.cau.cs.kieler.portSide
590 590  )))|(% colspan="1" %)(% colspan="1" %)
591 591  (((
592 -Int
397 +Enum
593 593  )))|(% colspan="1" %)(% colspan="1" %)
594 594  (((
595 595  Ports
596 596  )))|(% colspan="1" %)(% colspan="1" %)
597 597  (((
403 +UNDEFINED
404 +)))
405 +|(((
406 +Position
407 +)))|(((
408 +de.cau.cs.kieler.position
409 +)))|(((
410 +Object
411 +)))|(((
412 +Labels
413 +Nodes
414 +Ports
415 +)))|(((
598 598  
599 599  )))
418 +|(((
419 +Priority
420 +)))|(((
421 +de.cau.cs.kieler.priority
422 +)))|(((
423 +Int
424 +)))|(((
425 +Edges
426 +Nodes
427 +)))|(((
428 +
429 +)))
600 600  |(% colspan="1" %)(% colspan="1" %)
601 601  (((
602 -[[Port Offset>>doc:||anchor="portOffset"]]
432 +Randomization Seed
603 603  )))|(% colspan="1" %)(% colspan="1" %)
604 604  (((
605 -de.cau.cs.kieler.offset
435 +de.cau.cs.kieler.randomSeed
606 606  )))|(% colspan="1" %)(% colspan="1" %)
607 607  (((
608 -Float
438 +Int
609 609  )))|(% colspan="1" %)(% colspan="1" %)
610 610  (((
611 -Ports
441 +Parents
612 612  )))|(% colspan="1" %)(% colspan="1" %)
613 613  (((
614 614  
... ... @@ -615,16 +615,16 @@
615 615  )))
616 616  |(% colspan="1" %)(% colspan="1" %)
617 617  (((
618 -Port Side
448 +Separate Connected Components
619 619  )))|(% colspan="1" %)(% colspan="1" %)
620 620  (((
621 -de.cau.cs.kieler.portSide
451 +de.cau.cs.kieler.separateConnComp
622 622  )))|(% colspan="1" %)(% colspan="1" %)
623 623  (((
624 -Enum
454 +Boolean
625 625  )))|(% colspan="1" %)(% colspan="1" %)
626 626  (((
627 -Ports
457 +Parents
628 628  )))|(% colspan="1" %)(% colspan="1" %)
629 629  (((
630 630  
... ... @@ -631,95 +631,61 @@
631 631  )))
632 632  |(% colspan="1" %)(% colspan="1" %)
633 633  (((
634 -Progress Bar
464 +Size Constraint
635 635  )))|(% colspan="1" %)(% colspan="1" %)
636 636  (((
637 -de.cau.cs.kieler.progressBar
467 +de.cau.cs.kieler.sizeConstraint
638 638  )))|(% colspan="1" %)(% colspan="1" %)
639 639  (((
640 -Boolean
470 +EnumSet
641 641  )))|(% colspan="1" %)(% colspan="1" %)
642 642  (((
643 -Parents
473 +Nodes
644 644  )))|(% colspan="1" %)(% colspan="1" %)
645 645  (((
646 -false
476 +
647 647  )))
648 648  |(% colspan="1" %)(% colspan="1" %)
649 649  (((
650 -Scale Factor
480 +Size Options
651 651  )))|(% colspan="1" %)(% colspan="1" %)
652 652  (((
653 -de.cau.cs.kieler.scaleFactor
483 +de.cau.cs.kieler.sizeOptions
654 654  )))|(% colspan="1" %)(% colspan="1" %)
655 655  (((
656 -Float
486 +EnumSet
657 657  )))|(% colspan="1" %)(% colspan="1" %)
658 658  (((
659 659  Nodes
660 660  )))|(% colspan="1" %)(% colspan="1" %)
661 661  (((
662 -1.0
492 +DEFAULT_MINIMUM_SIZE
663 663  )))
664 664  |(% colspan="1" %)(% colspan="1" %)
665 665  (((
666 -Zoom to Fit
496 +Spacing
667 667  )))|(% colspan="1" %)(% colspan="1" %)
668 668  (((
669 -de.cau.cs.kieler.zoomToFit
499 +de.cau.cs.kieler.spacing
670 670  )))|(% colspan="1" %)(% colspan="1" %)
671 671  (((
672 -Boolean
502 +Float
673 673  )))|(% colspan="1" %)(% colspan="1" %)
674 674  (((
675 675  Parents
676 676  )))|(% colspan="1" %)(% colspan="1" %)
677 677  (((
678 -false
508 +-1.0
679 679  )))
680 680  
681 -=== Layout Output Properties ===
511 += The Most Important Options =
682 682  
683 -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 +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.
684 684  
685 -|=(((
686 -Property
687 -)))|=(((
688 -ID
689 -)))|=(((
690 -Type
691 -)))|=(((
692 -Applies to
693 -)))
694 -|(((
695 -[[Edge Routing>>doc:||anchor="edgeRouting"]]
696 -)))|(((
697 -de.cau.cs.kieler.edgeRouting
698 -)))|(((
699 -Enum
700 -)))|(((
701 -Edges
702 -)))
703 -|(((
704 -Junction Points
705 -)))|(((
706 -de.cau.cs.kieler.junctionPoints
707 -)))|(((
708 -Object
709 -)))|(((
710 -Edges
711 -)))
515 +== Layout Algorithm ==
712 712  
713 -
714 714  
715 -= Detailed Documentation =
716 716  
717 -== The Most Important Options ==
718 -
719 -While most layout options are used to affect how the active layout algorithm computes concrete coordinates for the graph elements, there are some layout options that have a special role in KIML.
720 -
721 -=== Layout Algorithm ===
722 -
723 723  {{id name="layoutAlgorithm"/}}
724 724  
725 725  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.
... ... @@ -743,8 +743,10 @@
743 743  * **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.
744 744  * **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.
745 745  
746 -=== Diagram Type ===
542 +== Diagram Type ==
747 747  
544 +
545 +
748 748  {{id name="diagramType"/}}
749 749  
750 750  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.
... ... @@ -765,10 +765,14 @@
765 765  * **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.
766 766  * **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.
767 767  
566 += Detailed Documentation =
567 +
768 768  This section explains every layout option in more detail.
769 769  
770 -=== Edge Routing ===
570 +== Edge Routing ==
771 771  
572 +
573 +
772 772  {{id name="edgeRouting"/}}
773 773  
774 774  This option influences the way in which edges are routed between the nodes they connect. The following settings are available:
... ... @@ -784,8 +784,10 @@
784 784  
785 785  (% style="color: rgb(153,51,0);" %)**TODO:** Add an image illustrating the different routing styles.
786 786  
787 -=== Port Offset ===
589 +== Port Offset ==
788 788  
591 +
592 +
789 789  {{id name="portOffset"/}}
790 790  
791 791  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 -9470012
1 +9470004
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470012/KIML Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470004/KIML Layout Options