Skip to Content

Changes for page KIML Layout Options

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

Summary

Details

Page properties
Content
... ... @@ -2,25 +2,29 @@
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, it may change the option's default value. Algorithms may also provide more specialized documentation for a given layout option.
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.
6 6  
7 7  **Contents**
8 8  
9 9  
10 10  
11 -{{toc/}}
11 +{{toc maxLevel="2"/}}
12 12  
13 13  = Overview =
14 14  
15 -Beside a human-readable name, layout options are defined by the following properties:
15 +Beside a user-friendly 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 {{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.
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.
21 21  
22 -KIML defines the following set of layout options:
22 +Layout options can be assigned to two main categories: user options and programmatic 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 +
24 24  |=(((
25 25  Option
26 26  )))|=(((
... ... @@ -76,27 +76,44 @@
76 76  )))|(((
77 77  
78 78  )))
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 -(((
83 +|(((
84 +Debug Mode
85 +)))|(((
86 +de.cau.cs.kieler.debugMode
87 +)))|(((
87 87  Boolean
88 -)))|(% colspan="1" %)(% colspan="1" %)
89 -(((
90 -Nodes
91 -)))|(% colspan="1" %)(% colspan="1" %)
92 -(((
89 +)))|(((
90 +Parents
91 +)))|(((
93 93  false
94 94  )))
95 95  |(((
96 -Debug Mode
95 +Direction
97 97  )))|(((
98 -de.cau.cs.kieler.debugMode
97 +de.cau.cs.kieler.direction
99 99  )))|(((
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 +)))|(((
100 100  Boolean
101 101  )))|(((
102 102  Parents
... ... @@ -103,99 +103,179 @@
103 103  )))|(((
104 104  false
105 105  )))
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 +)))
106 106  |(% colspan="1" %)(% colspan="1" %)
107 107  (((
108 -[[Diagram Type>>doc:||anchor="diagramType"]]
174 +Node Label Placement
109 109  )))|(% colspan="1" %)(% colspan="1" %)
110 110  (((
111 -de.cau.cs.kieler.diagramType
177 +de.cau.cs.kieler.nodeLabelPlacement
112 112  )))|(% colspan="1" %)(% colspan="1" %)
113 113  (((
114 -String
180 +EnumSet
115 115  )))|(% colspan="1" %)(% colspan="1" %)
116 116  (((
117 -
183 +Nodes
118 118  )))|(% colspan="1" %)(% colspan="1" %)
119 119  (((
120 120  
121 121  )))
122 122  |(((
123 -Direction
189 +Port Constraints
124 124  )))|(((
125 -de.cau.cs.kieler.direction
191 +de.cau.cs.kieler.portConstraints
126 126  )))|(((
127 127  Enum
128 128  )))|(((
129 -Parents
195 +Nodes
130 130  )))|(((
131 131  
132 132  )))
133 133  |(% colspan="1" %)(% colspan="1" %)
134 134  (((
135 -Edge Label Placement
201 +Port Label Placement
136 136  )))|(% colspan="1" %)(% colspan="1" %)
137 137  (((
138 -de.cau.cs.kieler.edgeLabelPlacement
204 +de.cau.cs.kieler.portLabelPlacement
139 139  )))|(% colspan="1" %)(% colspan="1" %)
140 140  (((
141 141  Enum
142 142  )))|(% colspan="1" %)(% colspan="1" %)
143 143  (((
144 -Labels
210 +Nodes
145 145  )))|(% colspan="1" %)(% colspan="1" %)
146 146  (((
213 +OUTSIDE
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 +(((
147 147  
148 148  )))
149 149  |(((
150 -[[Edge Routing>>doc:||anchor="edgeRouting"]]
232 +Position
151 151  )))|(((
152 -de.cau.cs.kieler.edgeRouting
234 +de.cau.cs.kieler.position
153 153  )))|(((
154 -Enum
236 +Object
155 155  )))|(((
156 -Parents
238 +Labels
239 +Nodes
240 +Ports
157 157  )))|(((
158 158  
159 159  )))
244 +|(((
245 +Priority
246 +)))|(((
247 +de.cau.cs.kieler.priority
248 +)))|(((
249 +Int
250 +)))|(((
251 +Edges
252 +Nodes
253 +)))|(((
254 +
255 +)))
160 160  |(% colspan="1" %)(% colspan="1" %)
161 161  (((
162 -Edge Type
258 +Randomization Seed
163 163  )))|(% colspan="1" %)(% colspan="1" %)
164 164  (((
165 -de.cau.cs.kieler.edgeType
261 +de.cau.cs.kieler.randomSeed
166 166  )))|(% colspan="1" %)(% colspan="1" %)
167 167  (((
168 -Enum
264 +Int
169 169  )))|(% colspan="1" %)(% colspan="1" %)
170 170  (((
171 -Edges
267 +Parents
172 172  )))|(% colspan="1" %)(% colspan="1" %)
173 173  (((
174 -NONE
270 +
175 175  )))
176 -|(((
177 -Expand Nodes
178 -)))|(((
179 -de.cau.cs.kieler.expandNodes
180 -)))|(((
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 +(((
181 181  Boolean
182 -)))|(((
281 +)))|(% colspan="1" %)(% colspan="1" %)
282 +(((
183 183  Parents
184 -)))|(((
185 -false
284 +)))|(% colspan="1" %)(% colspan="1" %)
285 +(((
286 +
186 186  )))
187 187  |(% colspan="1" %)(% colspan="1" %)
188 188  (((
189 -Font Name
290 +Size Constraint
190 190  )))|(% colspan="1" %)(% colspan="1" %)
191 191  (((
192 -de.cau.cs.kieler.fontName
293 +de.cau.cs.kieler.sizeConstraint
193 193  )))|(% colspan="1" %)(% colspan="1" %)
194 194  (((
195 -String
296 +EnumSet
196 196  )))|(% colspan="1" %)(% colspan="1" %)
197 197  (((
198 -Labels
299 +Nodes
199 199  )))|(% colspan="1" %)(% colspan="1" %)
200 200  (((
201 201  
... ... @@ -202,212 +202,240 @@
202 202  )))
203 203  |(% colspan="1" %)(% colspan="1" %)
204 204  (((
205 -Font Size
306 +Size Options
206 206  )))|(% colspan="1" %)(% colspan="1" %)
207 207  (((
208 -de.cau.cs.kieler.fontSize
309 +de.cau.cs.kieler.sizeOptions
209 209  )))|(% colspan="1" %)(% colspan="1" %)
210 210  (((
211 -Int
312 +EnumSet
212 212  )))|(% colspan="1" %)(% colspan="1" %)
213 213  (((
214 -Labels
315 +Nodes
215 215  )))|(% colspan="1" %)(% colspan="1" %)
216 216  (((
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 +(((
217 217  
218 218  )))
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 +)))
219 219  |(% colspan="1" %)(% colspan="1" %)
220 220  (((
221 -Hypernode
354 +Animate
222 222  )))|(% colspan="1" %)(% colspan="1" %)
223 223  (((
224 -de.cau.cs.kieler.hypernode
357 +de.cau.cs.kieler.animate
225 225  )))|(% colspan="1" %)(% colspan="1" %)
226 226  (((
227 227  Boolean
228 228  )))|(% colspan="1" %)(% colspan="1" %)
229 229  (((
230 -Nodes
363 +Parents
231 231  )))|(% colspan="1" %)(% colspan="1" %)
232 232  (((
233 -false
366 +true
234 234  )))
235 -|(((
236 -Interactive
237 -)))|(((
238 -de.cau.cs.kieler.interactive
239 -)))|(((
240 -Boolean
241 -)))|(((
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 +(((
242 242  Parents
243 -)))|(((
244 -false
380 +)))|(% colspan="1" %)(% colspan="1" %)
381 +(((
382 +100
245 245  )))
246 -|(((
247 -Label Spacing
248 -)))|(((
249 -de.cau.cs.kieler.labelSpacing
250 -)))|(((
251 -Float
252 -)))|(((
253 -Edges
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 +(((
254 254  Nodes
255 -)))|(((
256 -
396 +)))|(% colspan="1" %)(% colspan="1" %)
397 +(((
398 +false
257 257  )))
258 258  |(((
259 -Layout Hierarchy
401 +[[Diagram Type>>doc:||anchor="diagramType"]]
260 260  )))|(((
261 -de.cau.cs.kieler.layoutHierarchy
403 +de.cau.cs.kieler.diagramType
262 262  )))|(((
263 -Boolean
405 +String
264 264  )))|(((
265 265  Parents
266 266  )))|(((
267 -false
409 +
268 268  )))
269 269  |(((
270 -[[Layout Algorithm>>doc:||anchor="layoutAlgorithm"]]
412 +Edge Label Placement
271 271  )))|(((
272 -de.cau.cs.kieler.algorithm
414 +de.cau.cs.kieler.edgeLabelPlacement
273 273  )))|(((
274 -String
416 +Enum
275 275  )))|(((
276 -Parents
418 +Labels
277 277  )))|(((
278 278  
279 279  )))
280 280  |(% colspan="1" %)(% colspan="1" %)
281 281  (((
282 -Minimal Height
424 +Edge Type
283 283  )))|(% colspan="1" %)(% colspan="1" %)
284 284  (((
285 -de.cau.cs.kieler.minHeight
427 +de.cau.cs.kieler.edgeType
286 286  )))|(% colspan="1" %)(% colspan="1" %)
287 287  (((
288 -Float
430 +Enum
289 289  )))|(% colspan="1" %)(% colspan="1" %)
290 290  (((
291 -Nodes
292 -Parents
433 +Edges
293 293  )))|(% colspan="1" %)(% colspan="1" %)
294 294  (((
295 -0.0
436 +NONE
296 296  )))
297 297  |(% colspan="1" %)(% colspan="1" %)
298 298  (((
299 -Minimal Width
440 +Font Name
300 300  )))|(% colspan="1" %)(% colspan="1" %)
301 301  (((
302 -de.cau.cs.kieler.minWidth
443 +de.cau.cs.kieler.fontName
303 303  )))|(% colspan="1" %)(% colspan="1" %)
304 304  (((
305 -Float
446 +String
306 306  )))|(% colspan="1" %)(% colspan="1" %)
307 307  (((
308 -Nodes
309 -Parents
449 +Labels
310 310  )))|(% colspan="1" %)(% colspan="1" %)
311 311  (((
312 -0.0
452 +
313 313  )))
314 314  |(% colspan="1" %)(% colspan="1" %)
315 315  (((
316 -No Layout
456 +Font Size
317 317  )))|(% colspan="1" %)(% colspan="1" %)
318 318  (((
319 -de.cau.cs.kieler.noLayout
459 +de.cau.cs.kieler.fontSize
320 320  )))|(% colspan="1" %)(% colspan="1" %)
321 321  (((
322 -Boolean
462 +Int
323 323  )))|(% colspan="1" %)(% colspan="1" %)
324 324  (((
325 -
465 +Labels
326 326  )))|(% colspan="1" %)(% colspan="1" %)
327 327  (((
328 -false
468 +
329 329  )))
330 330  |(% colspan="1" %)(% colspan="1" %)
331 331  (((
332 -Node Label Placement
472 +Hypernode
333 333  )))|(% colspan="1" %)(% colspan="1" %)
334 334  (((
335 -de.cau.cs.kieler.nodeLabelPlacement
475 +de.cau.cs.kieler.hypernode
336 336  )))|(% colspan="1" %)(% colspan="1" %)
337 337  (((
338 -EnumSet
478 +Boolean
339 339  )))|(% colspan="1" %)(% colspan="1" %)
340 340  (((
341 341  Nodes
342 342  )))|(% colspan="1" %)(% colspan="1" %)
343 343  (((
344 -
484 +false
345 345  )))
346 -|(((
347 -Port Constraints
348 -)))|(((
349 -de.cau.cs.kieler.portConstraints
350 -)))|(((
351 -Enum
352 -)))|(((
353 -Nodes
354 -)))|(((
355 -
356 -)))
357 357  |(% colspan="1" %)(% colspan="1" %)
358 358  (((
359 -Port Label Placement
488 +Layout Ancestors
360 360  )))|(% colspan="1" %)(% colspan="1" %)
361 361  (((
362 -de.cau.cs.kieler.portLabelPlacement
491 +de.cau.cs.kieler.layoutAncestors
363 363  )))|(% colspan="1" %)(% colspan="1" %)
364 364  (((
365 -Enum
494 +Boolean
366 366  )))|(% colspan="1" %)(% colspan="1" %)
367 367  (((
368 -Nodes
497 +Parents
369 369  )))|(% colspan="1" %)(% colspan="1" %)
370 370  (((
371 -OUTSIDE
500 +false
372 372  )))
373 373  |(% colspan="1" %)(% colspan="1" %)
374 374  (((
375 -[[Port Offset>>doc:||anchor="portOffset"]]
504 +Maximal Animation Time
376 376  )))|(% colspan="1" %)(% colspan="1" %)
377 377  (((
378 -de.cau.cs.kieler.offset
507 +de.cau.cs.kieler.maxAnimTim
379 379  )))|(% colspan="1" %)(% colspan="1" %)
380 380  (((
381 -Float
510 +Int
382 382  )))|(% colspan="1" %)(% colspan="1" %)
383 383  (((
384 -Ports
513 +Parents
385 385  )))|(% colspan="1" %)(% colspan="1" %)
386 386  (((
387 -
516 +4000
388 388  )))
389 389  |(% colspan="1" %)(% colspan="1" %)
390 390  (((
391 -Port Side
520 +Minimal Animation Time
392 392  )))|(% colspan="1" %)(% colspan="1" %)
393 393  (((
394 -de.cau.cs.kieler.portSide
523 +de.cau.cs.kieler.minAnimTim
395 395  )))|(% colspan="1" %)(% colspan="1" %)
396 396  (((
397 -Enum
526 +Int
398 398  )))|(% colspan="1" %)(% colspan="1" %)
399 399  (((
400 -Ports
529 +Parents
401 401  )))|(% colspan="1" %)(% colspan="1" %)
402 402  (((
403 -
532 +400
404 404  )))
405 405  |(% colspan="1" %)(% colspan="1" %)
406 406  (((
407 -Port Spacing
536 +Minimal Height
408 408  )))|(% colspan="1" %)(% colspan="1" %)
409 409  (((
410 -de.cau.cs.kieler.portSpacing
539 +de.cau.cs.kieler.minHeight
411 411  )))|(% colspan="1" %)(% colspan="1" %)
412 412  (((
413 413  Float
... ... @@ -414,47 +414,56 @@
414 414  )))|(% colspan="1" %)(% colspan="1" %)
415 415  (((
416 416  Nodes
546 +Parents
417 417  )))|(% colspan="1" %)(% colspan="1" %)
418 418  (((
419 -
549 +0.0
420 420  )))
421 -|(((
422 -Position
423 -)))|(((
424 -de.cau.cs.kieler.position
425 -)))|(((
426 -Object
427 -)))|(((
428 -Labels
551 +|(% colspan="1" %)(% colspan="1" %)
552 +(((
553 +Minimal Width
554 +)))|(% colspan="1" %)(% colspan="1" %)
555 +(((
556 +de.cau.cs.kieler.minWidth
557 +)))|(% colspan="1" %)(% colspan="1" %)
558 +(((
559 +Float
560 +)))|(% colspan="1" %)(% colspan="1" %)
561 +(((
429 429  Nodes
430 -Ports
431 -)))|(((
432 -
563 +Parents
564 +)))|(% colspan="1" %)(% colspan="1" %)
565 +(((
566 +0.0
433 433  )))
434 -|(((
435 -Priority
436 -)))|(((
437 -de.cau.cs.kieler.priority
438 -)))|(((
439 -Int
440 -)))|(((
441 -Edges
442 -Nodes
443 -)))|(((
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 +(((
444 444  
580 +)))|(% colspan="1" %)(% colspan="1" %)
581 +(((
582 +false
445 445  )))
446 446  |(% colspan="1" %)(% colspan="1" %)
447 447  (((
448 -Randomization Seed
586 +Port Index
449 449  )))|(% colspan="1" %)(% colspan="1" %)
450 450  (((
451 -de.cau.cs.kieler.randomSeed
589 +de.cau.cs.kieler.portIndex
452 452  )))|(% colspan="1" %)(% colspan="1" %)
453 453  (((
454 454  Int
455 455  )))|(% colspan="1" %)(% colspan="1" %)
456 456  (((
457 -Parents
595 +Ports
458 458  )))|(% colspan="1" %)(% colspan="1" %)
459 459  (((
460 460  
... ... @@ -461,16 +461,16 @@
461 461  )))
462 462  |(% colspan="1" %)(% colspan="1" %)
463 463  (((
464 -Separate Connected Components
602 +[[Port Offset>>doc:||anchor="portOffset"]]
465 465  )))|(% colspan="1" %)(% colspan="1" %)
466 466  (((
467 -de.cau.cs.kieler.separateConnComp
605 +de.cau.cs.kieler.offset
468 468  )))|(% colspan="1" %)(% colspan="1" %)
469 469  (((
470 -Boolean
608 +Float
471 471  )))|(% colspan="1" %)(% colspan="1" %)
472 472  (((
473 -Parents
611 +Ports
474 474  )))|(% colspan="1" %)(% colspan="1" %)
475 475  (((
476 476  
... ... @@ -477,16 +477,16 @@
477 477  )))
478 478  |(% colspan="1" %)(% colspan="1" %)
479 479  (((
480 -Size Constraint
618 +Port Side
481 481  )))|(% colspan="1" %)(% colspan="1" %)
482 482  (((
483 -de.cau.cs.kieler.sizeConstraint
621 +de.cau.cs.kieler.portSide
484 484  )))|(% colspan="1" %)(% colspan="1" %)
485 485  (((
486 -EnumSet
624 +Enum
487 487  )))|(% colspan="1" %)(% colspan="1" %)
488 488  (((
489 -Nodes
627 +Ports
490 490  )))|(% colspan="1" %)(% colspan="1" %)
491 491  (((
492 492  
... ... @@ -493,42 +493,94 @@
493 493  )))
494 494  |(% colspan="1" %)(% colspan="1" %)
495 495  (((
496 -Size Options
634 +Progress Bar
497 497  )))|(% colspan="1" %)(% colspan="1" %)
498 498  (((
499 -de.cau.cs.kieler.sizeOptions
637 +de.cau.cs.kieler.progressBar
500 500  )))|(% colspan="1" %)(% colspan="1" %)
501 501  (((
502 -EnumSet
640 +Boolean
503 503  )))|(% colspan="1" %)(% colspan="1" %)
504 504  (((
505 -Nodes
643 +Parents
506 506  )))|(% colspan="1" %)(% colspan="1" %)
507 507  (((
508 -DEFAULT_MINIMUM_SIZE
646 +false
509 509  )))
510 510  |(% colspan="1" %)(% colspan="1" %)
511 511  (((
512 -Spacing
650 +Scale Factor
513 513  )))|(% colspan="1" %)(% colspan="1" %)
514 514  (((
515 -de.cau.cs.kieler.spacing
653 +de.cau.cs.kieler.scaleFactor
516 516  )))|(% colspan="1" %)(% colspan="1" %)
517 517  (((
518 518  Float
519 519  )))|(% colspan="1" %)(% colspan="1" %)
520 520  (((
659 +Nodes
660 +)))|(% colspan="1" %)(% colspan="1" %)
661 +(((
662 +1.0
663 +)))
664 +|(% colspan="1" %)(% colspan="1" %)
665 +(((
666 +Zoom to Fit
667 +)))|(% colspan="1" %)(% colspan="1" %)
668 +(((
669 +de.cau.cs.kieler.zoomToFit
670 +)))|(% colspan="1" %)(% colspan="1" %)
671 +(((
672 +Boolean
673 +)))|(% colspan="1" %)(% colspan="1" %)
674 +(((
521 521  Parents
522 522  )))|(% colspan="1" %)(% colspan="1" %)
523 523  (((
524 -
678 +false
525 525  )))
526 526  
527 -= The Most Important Options =
681 +=== Layout Output Properties ===
528 528  
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
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 +)))
712 +
713 +
714 +
715 += Detailed Documentation =
716 +
717 +== The Most Important Options ==
718 +
529 529  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.
530 530  
531 -== Layout Algorithm ==
721 +=== Layout Algorithm ===
532 532  
533 533  {{id name="layoutAlgorithm"/}}
534 534  
... ... @@ -553,7 +553,7 @@
553 553  * **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.
554 554  * **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.
555 555  
556 -== Diagram Type ==
746 +=== Diagram Type ===
557 557  
558 558  {{id name="diagramType"/}}
559 559  
... ... @@ -575,11 +575,9 @@
575 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 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 577  
578 -= Detailed Documentation =
579 -
580 580  This section explains every layout option in more detail.
581 581  
582 -== Edge Routing ==
770 +=== Edge Routing ===
583 583  
584 584  {{id name="edgeRouting"/}}
585 585  
... ... @@ -596,7 +596,7 @@
596 596  
597 597  (% style="color: rgb(153,51,0);" %)**TODO:** Add an image illustrating the different routing styles.
598 598  
599 -== Port Offset ==
787 +=== Port Offset ===
600 600  
601 601  {{id name="portOffset"/}}
602 602  
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470006
1 +9470012
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470006/KIML Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470012/KIML Layout Options