Skip to Content

Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
From version 2.1
edited by cds
on 2013/05/31 20:06
Change comment: There is no comment for this version
To version 20.1
edited by msp
on 2014/03/08 20:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Layout Options
1 +KIML Layout Options
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cds
1 +XWiki.msp
Content
... ... @@ -1,26 +1,28 @@
1 -{{warning}}
2 -This is preliminary documentation. You've been warned.
3 -{{/warning}}
1 +
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. Algorithms may provide more specialized documentation for a given layout option.
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.
6 6  
7 7  **Contents**
8 8  
9 9  
10 10  
11 -{{toc/}}
9 +{{toc maxLevel="2"/}}
12 12  
13 13  = Overview =
14 14  
15 -Beside a human-readable name, layout options are defined by the following properties:
13 +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 -* An optional definition of what 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. If this definition is omitted, a layout option will not be shown to the user in the UI, but can still be set programmatically.
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.
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.
21 21  
22 -KIML defines the following set of layout options:
20 +Layout options can be assigned to two main categories: user options and programmatic options.
23 23  
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 +
24 24  |=(((
25 25  Option
26 26  )))|=(((
... ... @@ -74,28 +74,56 @@
74 74  )))|(((
75 75  Parents
76 76  )))|(((
77 --1.0
79 +
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 -(((
81 +|(((
82 +Debug Mode
83 +)))|(((
84 +de.cau.cs.kieler.debugMode
85 +)))|(((
87 87  Boolean
88 -)))|(% colspan="1" %)(% colspan="1" %)
89 -(((
87 +)))|(((
88 +Parents
89 +)))|(((
90 +false
91 +)))
92 +|(((
93 +Direction
94 +)))|(((
95 +de.cau.cs.kieler.direction
96 +)))|(((
97 +Enum
98 +)))|(((
99 +Parents
100 +)))|(((
90 90  
91 -)))|(% colspan="1" %)(% colspan="1" %)
92 -(((
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 +)))|(((
93 93  false
94 94  )))
95 95  |(((
96 -Debug Mode
126 +Interactive
97 97  )))|(((
98 -de.cau.cs.kieler.debugMode
128 +de.cau.cs.kieler.interactive
99 99  )))|(((
100 100  Boolean
101 101  )))|(((
... ... @@ -103,99 +103,168 @@
103 103  )))|(((
104 104  false
105 105  )))
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
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 +)))
106 106  |(% colspan="1" %)(% colspan="1" %)
107 107  (((
108 -Diagram Type
172 +Node Label Placement
109 109  )))|(% colspan="1" %)(% colspan="1" %)
110 110  (((
111 -de.cau.cs.kieler.diagramType
175 +de.cau.cs.kieler.nodeLabelPlacement
112 112  )))|(% colspan="1" %)(% colspan="1" %)
113 113  (((
114 -String
178 +EnumSet
115 115  )))|(% colspan="1" %)(% colspan="1" %)
116 116  (((
117 -
181 +Nodes
118 118  )))|(% colspan="1" %)(% colspan="1" %)
119 119  (((
120 120  
121 121  )))
122 122  |(((
123 -Direction
187 +Port Constraints
124 124  )))|(((
125 -de.cau.cs.kieler.direction
189 +de.cau.cs.kieler.portConstraints
126 126  )))|(((
127 127  Enum
128 128  )))|(((
129 -Parents
193 +Nodes
130 130  )))|(((
131 -UNDEFINED
195 +
132 132  )))
133 133  |(% colspan="1" %)(% colspan="1" %)
134 134  (((
135 -Edge Label Placement
199 +Port Label Placement
136 136  )))|(% colspan="1" %)(% colspan="1" %)
137 137  (((
138 -de.cau.cs.kieler.edgeLabelPlacement
202 +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 -
208 +Nodes
145 145  )))|(% colspan="1" %)(% colspan="1" %)
146 146  (((
147 -UNDEFINED
211 +OUTSIDE
148 148  )))
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 +
228 +)))
149 149  |(((
150 -Edge Routing
230 +Position
151 151  )))|(((
152 -de.cau.cs.kieler.edgeRouting
232 +de.cau.cs.kieler.position
153 153  )))|(((
154 -Enum
234 +Object
155 155  )))|(((
156 -Parents
236 +Labels
237 +Nodes
238 +Ports
157 157  )))|(((
158 -UNDEFINED
240 +
159 159  )))
242 +|(((
243 +Priority
244 +)))|(((
245 +de.cau.cs.kieler.priority
246 +)))|(((
247 +Int
248 +)))|(((
249 +Edges
250 +Nodes
251 +)))|(((
252 +
253 +)))
160 160  |(% colspan="1" %)(% colspan="1" %)
161 161  (((
162 -Edge Type
256 +Randomization Seed
163 163  )))|(% colspan="1" %)(% colspan="1" %)
164 164  (((
165 -de.cau.cs.kieler.edgeType
259 +de.cau.cs.kieler.randomSeed
166 166  )))|(% colspan="1" %)(% colspan="1" %)
167 167  (((
168 -Enum
262 +Int
169 169  )))|(% colspan="1" %)(% colspan="1" %)
170 170  (((
171 -
265 +Parents
172 172  )))|(% colspan="1" %)(% colspan="1" %)
173 173  (((
174 -NONE
268 +
175 175  )))
176 -|(((
177 -Expand Nodes
178 -)))|(((
179 -de.cau.cs.kieler.expandNodes
180 -)))|(((
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 +(((
181 181  Boolean
182 -)))|(((
279 +)))|(% colspan="1" %)(% colspan="1" %)
280 +(((
183 183  Parents
184 -)))|(((
185 -false
282 +)))|(% colspan="1" %)(% colspan="1" %)
283 +(((
284 +
186 186  )))
187 187  |(% colspan="1" %)(% colspan="1" %)
188 188  (((
189 -Font Name
288 +Size Constraint
190 190  )))|(% colspan="1" %)(% colspan="1" %)
191 191  (((
192 -de.cau.cs.kieler.fontName
291 +de.cau.cs.kieler.sizeConstraint
193 193  )))|(% colspan="1" %)(% colspan="1" %)
194 194  (((
195 -String
294 +EnumSet
196 196  )))|(% colspan="1" %)(% colspan="1" %)
197 197  (((
198 -
297 +Nodes
199 199  )))|(% colspan="1" %)(% colspan="1" %)
200 200  (((
201 201  
... ... @@ -202,125 +202,182 @@
202 202  )))
203 203  |(% colspan="1" %)(% colspan="1" %)
204 204  (((
205 -Font Size
304 +Size Options
206 206  )))|(% colspan="1" %)(% colspan="1" %)
207 207  (((
208 -de.cau.cs.kieler.fontSize
307 +de.cau.cs.kieler.sizeOptions
209 209  )))|(% colspan="1" %)(% colspan="1" %)
210 210  (((
211 -Int
310 +EnumSet
212 212  )))|(% colspan="1" %)(% colspan="1" %)
213 213  (((
214 -
313 +Nodes
215 215  )))|(% colspan="1" %)(% colspan="1" %)
216 216  (((
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 +(((
217 217  
218 218  )))
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 +)))
219 219  |(% colspan="1" %)(% colspan="1" %)
220 220  (((
221 -Hypernode
352 +Animate
222 222  )))|(% colspan="1" %)(% colspan="1" %)
223 223  (((
224 -de.cau.cs.kieler.hypernode
355 +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 -
361 +Parents
231 231  )))|(% colspan="1" %)(% colspan="1" %)
232 232  (((
233 -false
364 +true
234 234  )))
235 -|(((
236 -Interactive
237 -)))|(((
238 -de.cau.cs.kieler.interactive
239 -)))|(((
240 -Boolean
241 -)))|(((
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 +(((
242 242  Parents
243 -)))|(((
244 -false
378 +)))|(% colspan="1" %)(% colspan="1" %)
379 +(((
380 +100
245 245  )))
246 -|(((
247 -Label Spacing
248 -)))|(((
249 -de.cau.cs.kieler.labelSpacing
250 -)))|(((
251 -Float
252 -)))|(((
253 -Edges
382 +|(% colspan="1" %)(% colspan="1" %)
383 +(((
384 +Comment Box
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 +(((
254 254  Nodes
255 -)))|(((
256 --1.0
394 +)))|(% colspan="1" %)(% colspan="1" %)
395 +(((
396 +false
257 257  )))
258 258  |(((
259 -Layout Hierarchy
399 +[[Diagram Type>>doc:||anchor="diagramType"]]
260 260  )))|(((
261 -de.cau.cs.kieler.layoutHierarchy
401 +de.cau.cs.kieler.diagramType
262 262  )))|(((
263 -Boolean
403 +String
264 264  )))|(((
265 265  Parents
266 266  )))|(((
267 -false
407 +
268 268  )))
269 269  |(((
270 -Layout Algorithm
410 +Edge Label Placement
271 271  )))|(((
272 -de.cau.cs.kieler.algorithm
412 +de.cau.cs.kieler.edgeLabelPlacement
273 273  )))|(((
274 -String
414 +Enum
275 275  )))|(((
276 -Parents
416 +Labels
277 277  )))|(((
278 278  
279 279  )))
280 280  |(% colspan="1" %)(% colspan="1" %)
281 281  (((
282 -Minimal Height
422 +Edge Type
283 283  )))|(% colspan="1" %)(% colspan="1" %)
284 284  (((
285 -de.cau.cs.kieler.minHeight
425 +de.cau.cs.kieler.edgeType
286 286  )))|(% colspan="1" %)(% colspan="1" %)
287 287  (((
288 -Float
428 +Enum
289 289  )))|(% colspan="1" %)(% colspan="1" %)
290 290  (((
291 -
431 +Edges
292 292  )))|(% colspan="1" %)(% colspan="1" %)
293 293  (((
294 -0.0
434 +NONE
295 295  )))
296 296  |(% colspan="1" %)(% colspan="1" %)
297 297  (((
298 -Minimal Width
438 +Font Name
299 299  )))|(% colspan="1" %)(% colspan="1" %)
300 300  (((
301 -de.cau.cs.kieler.minWidth
441 +de.cau.cs.kieler.fontName
302 302  )))|(% colspan="1" %)(% colspan="1" %)
303 303  (((
304 -Float
444 +String
305 305  )))|(% colspan="1" %)(% colspan="1" %)
306 306  (((
447 +Labels
448 +)))|(% colspan="1" %)(% colspan="1" %)
449 +(((
307 307  
451 +)))
452 +|(% colspan="1" %)(% colspan="1" %)
453 +(((
454 +Font Size
308 308  )))|(% colspan="1" %)(% colspan="1" %)
309 309  (((
310 -0.0
457 +de.cau.cs.kieler.fontSize
458 +)))|(% colspan="1" %)(% colspan="1" %)
459 +(((
460 +Int
461 +)))|(% colspan="1" %)(% colspan="1" %)
462 +(((
463 +Labels
464 +)))|(% colspan="1" %)(% colspan="1" %)
465 +(((
466 +
311 311  )))
312 312  |(% colspan="1" %)(% colspan="1" %)
313 313  (((
314 -No Layout
470 +Hypernode
315 315  )))|(% colspan="1" %)(% colspan="1" %)
316 316  (((
317 -de.cau.cs.kieler.noLayout
473 +de.cau.cs.kieler.hypernode
318 318  )))|(% colspan="1" %)(% colspan="1" %)
319 319  (((
320 320  Boolean
321 321  )))|(% colspan="1" %)(% colspan="1" %)
322 322  (((
323 -
479 +Nodes
324 324  )))|(% colspan="1" %)(% colspan="1" %)
325 325  (((
326 326  false
... ... @@ -327,116 +327,130 @@
327 327  )))
328 328  |(% colspan="1" %)(% colspan="1" %)
329 329  (((
330 -Node Label Placement
486 +Layout Ancestors
331 331  )))|(% colspan="1" %)(% colspan="1" %)
332 332  (((
333 -de.cau.cs.kieler.nodeLabelPlacement
489 +de.cau.cs.kieler.layoutAncestors
334 334  )))|(% colspan="1" %)(% colspan="1" %)
335 335  (((
336 -EnumSet
492 +Boolean
337 337  )))|(% colspan="1" %)(% colspan="1" %)
338 338  (((
339 -Nodes
495 +Parents
340 340  )))|(% colspan="1" %)(% colspan="1" %)
341 341  (((
342 -
498 +false
343 343  )))
344 -|(((
345 -Port Constraints
346 -)))|(((
347 -de.cau.cs.kieler.portConstraints
348 -)))|(((
349 -Enum
350 -)))|(((
351 -Nodes
352 -)))|(((
353 -UNDEFINED
500 +|(% colspan="1" %)(% colspan="1" %)
501 +(((
502 +Maximal Animation Time
503 +)))|(% colspan="1" %)(% colspan="1" %)
504 +(((
505 +de.cau.cs.kieler.maxAnimTim
506 +)))|(% colspan="1" %)(% colspan="1" %)
507 +(((
508 +Int
509 +)))|(% colspan="1" %)(% colspan="1" %)
510 +(((
511 +Parents
512 +)))|(% colspan="1" %)(% colspan="1" %)
513 +(((
514 +4000
354 354  )))
355 355  |(% colspan="1" %)(% colspan="1" %)
356 356  (((
357 -Port Label Placement
518 +Minimal Animation Time
358 358  )))|(% colspan="1" %)(% colspan="1" %)
359 359  (((
360 -de.cau.cs.kieler.portLabelPlacement
521 +de.cau.cs.kieler.minAnimTim
361 361  )))|(% colspan="1" %)(% colspan="1" %)
362 362  (((
363 -Enum
524 +Int
364 364  )))|(% colspan="1" %)(% colspan="1" %)
365 365  (((
527 +Parents
528 +)))|(% colspan="1" %)(% colspan="1" %)
529 +(((
530 +400
531 +)))
532 +|(% colspan="1" %)(% colspan="1" %)
533 +(((
534 +Minimal Height
535 +)))|(% colspan="1" %)(% colspan="1" %)
536 +(((
537 +de.cau.cs.kieler.minHeight
538 +)))|(% colspan="1" %)(% colspan="1" %)
539 +(((
540 +Float
541 +)))|(% colspan="1" %)(% colspan="1" %)
542 +(((
366 366  Nodes
544 +Parents
367 367  )))|(% colspan="1" %)(% colspan="1" %)
368 368  (((
369 -OUTSIDE
547 +0.0
370 370  )))
371 371  |(% colspan="1" %)(% colspan="1" %)
372 372  (((
373 -Port Offset
551 +Minimal Width
374 374  )))|(% colspan="1" %)(% colspan="1" %)
375 375  (((
376 -de.cau.cs.kieler.offset
554 +de.cau.cs.kieler.minWidth
377 377  )))|(% colspan="1" %)(% colspan="1" %)
378 378  (((
379 379  Float
380 380  )))|(% colspan="1" %)(% colspan="1" %)
381 381  (((
382 -
560 +Nodes
561 +Parents
383 383  )))|(% colspan="1" %)(% colspan="1" %)
384 384  (((
385 -
564 +0.0
386 386  )))
387 387  |(% colspan="1" %)(% colspan="1" %)
388 388  (((
389 -Port Side
568 +No Layout
390 390  )))|(% colspan="1" %)(% colspan="1" %)
391 391  (((
392 -de.cau.cs.kieler.portSide
571 +de.cau.cs.kieler.noLayout
393 393  )))|(% colspan="1" %)(% colspan="1" %)
394 394  (((
395 -Enum
574 +Boolean
396 396  )))|(% colspan="1" %)(% colspan="1" %)
397 397  (((
398 398  
399 399  )))|(% colspan="1" %)(% colspan="1" %)
400 400  (((
401 -UNDEFINED
580 +false
402 402  )))
403 -|(((
404 -Position
405 -)))|(((
406 -de.cau.cs.kieler.position
407 -)))|(((
408 -Object
409 -)))|(((
410 -Labels
411 -Nodes
582 +|(% colspan="1" %)(% colspan="1" %)
583 +(((
584 +Port Index
585 +)))|(% colspan="1" %)(% colspan="1" %)
586 +(((
587 +de.cau.cs.kieler.portIndex
588 +)))|(% colspan="1" %)(% colspan="1" %)
589 +(((
590 +Int
591 +)))|(% colspan="1" %)(% colspan="1" %)
592 +(((
412 412  Ports
413 -)))|(((
594 +)))|(% colspan="1" %)(% colspan="1" %)
595 +(((
414 414  
415 415  )))
416 -|(((
417 -Priority
418 -)))|(((
419 -de.cau.cs.kieler.priority
420 -)))|(((
421 -Int
422 -)))|(((
423 -Edges
424 -Nodes
425 -)))|(((
426 -
427 -)))
428 428  |(% colspan="1" %)(% colspan="1" %)
429 429  (((
430 -Randomization Seed
600 +[[Port Offset>>doc:||anchor="portOffset"]]
431 431  )))|(% colspan="1" %)(% colspan="1" %)
432 432  (((
433 -de.cau.cs.kieler.randomSeed
603 +de.cau.cs.kieler.offset
434 434  )))|(% colspan="1" %)(% colspan="1" %)
435 435  (((
436 -Int
606 +Float
437 437  )))|(% colspan="1" %)(% colspan="1" %)
438 438  (((
439 -Parents
609 +Ports
440 440  )))|(% colspan="1" %)(% colspan="1" %)
441 441  (((
442 442  
... ... @@ -443,16 +443,16 @@
443 443  )))
444 444  |(% colspan="1" %)(% colspan="1" %)
445 445  (((
446 -Separate Connected Components
616 +Port Side
447 447  )))|(% colspan="1" %)(% colspan="1" %)
448 448  (((
449 -de.cau.cs.kieler.separateConnComp
619 +de.cau.cs.kieler.portSide
450 450  )))|(% colspan="1" %)(% colspan="1" %)
451 451  (((
452 -Boolean
622 +Enum
453 453  )))|(% colspan="1" %)(% colspan="1" %)
454 454  (((
455 -Parents
625 +Ports
456 456  )))|(% colspan="1" %)(% colspan="1" %)
457 457  (((
458 458  
... ... @@ -459,61 +459,170 @@
459 459  )))
460 460  |(% colspan="1" %)(% colspan="1" %)
461 461  (((
462 -Size Constraint
632 +Progress Bar
463 463  )))|(% colspan="1" %)(% colspan="1" %)
464 464  (((
465 -de.cau.cs.kieler.sizeConstraint
635 +de.cau.cs.kieler.progressBar
466 466  )))|(% colspan="1" %)(% colspan="1" %)
467 467  (((
468 -EnumSet
638 +Boolean
469 469  )))|(% colspan="1" %)(% colspan="1" %)
470 470  (((
471 -Nodes
641 +Parents
472 472  )))|(% colspan="1" %)(% colspan="1" %)
473 473  (((
474 -
644 +false
475 475  )))
476 476  |(% colspan="1" %)(% colspan="1" %)
477 477  (((
478 -Size Options
648 +Scale Factor
479 479  )))|(% colspan="1" %)(% colspan="1" %)
480 480  (((
481 -de.cau.cs.kieler.sizeOptions
651 +de.cau.cs.kieler.scaleFactor
482 482  )))|(% colspan="1" %)(% colspan="1" %)
483 483  (((
484 -EnumSet
654 +Float
485 485  )))|(% colspan="1" %)(% colspan="1" %)
486 486  (((
487 487  Nodes
488 488  )))|(% colspan="1" %)(% colspan="1" %)
489 489  (((
490 -DEFAULT_MINIMUM_SIZE
660 +1.0
491 491  )))
492 492  |(% colspan="1" %)(% colspan="1" %)
493 493  (((
494 -Spacing
664 +Zoom to Fit
495 495  )))|(% colspan="1" %)(% colspan="1" %)
496 496  (((
497 -de.cau.cs.kieler.spacing
667 +de.cau.cs.kieler.zoomToFit
498 498  )))|(% colspan="1" %)(% colspan="1" %)
499 499  (((
500 -Float
670 +Boolean
501 501  )))|(% colspan="1" %)(% colspan="1" %)
502 502  (((
503 503  Parents
504 504  )))|(% colspan="1" %)(% colspan="1" %)
505 505  (((
506 --1.0
676 +false
507 507  )))
508 508  
509 -= The Most Important Options =
679 +=== Layout Output Properties ===
510 510  
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.
681 +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
512 512  
683 +|=(((
684 +Property
685 +)))|=(((
686 +ID
687 +)))|=(((
688 +Type
689 +)))|=(((
690 +Applies to
691 +)))
692 +|(((
693 +[[Edge Routing>>doc:||anchor="edgeRouting"]]
694 +)))|(((
695 +de.cau.cs.kieler.edgeRouting
696 +)))|(((
697 +Enum
698 +)))|(((
699 +Edges
700 +)))
701 +|(((
702 +Junction Points
703 +)))|(((
704 +de.cau.cs.kieler.junctionPoints
705 +)))|(((
706 +Object
707 +)))|(((
708 +Edges
709 +)))
710 +
711 +
712 +
513 513  = Detailed Documentation =
514 514  
715 +== The Most Important Options ==
716 +
717 +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.
718 +
719 +=== Layout Algorithm ===
720 +
721 +{{id name="layoutAlgorithm"/}}
722 +
723 +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 option is active.
724 +
725 +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.
726 +
727 +[[image:attach:layout_algorithm.png]]
728 +
729 +=== Available Algorithms and Libraries ===
730 +
731 +* **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.
732 +* **Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
733 +* (((
734 +**Box Layout** - Ignores edges, places all nodes in rows. Can be used to layout collections of unconnected boxes, such as Statechart regions.
735 +)))
736 +* **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.
737 +* **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.
738 +* **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.
739 +
740 +=== Predefined Layout Types ===
741 +
742 +* **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.
743 +* **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.
744 +* **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
745 +* **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.
746 +* **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.
747 +
748 +=== Diagram Type ===
749 +
750 +{{id name="diagramType"/}}
751 +
752 +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.
753 +
754 +The following diagram types are predefined:
755 +
756 +* **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.
757 +* **State Machine** - All kinds of state machines, automata, and activity diagrams. Examples: [[doc:SCCharts SyncCharts]], UML Activity diagrams.
758 +* **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)]].
759 +* **Class Diagram** - Class diagrams such as Ecore diagrams for the [[EMF>>url:http://www.eclipse.org/modeling/emf/||shape="rect"]] or UML Class diagrams.
760 +* **Use Case Diagram** - Use case diagrams as defined by the UML.
761 +* **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]].
762 +
763 +== Other Options ==
764 +
765 +* **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.
766 +* **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.
767 +* **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.
768 +* **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.
769 +
515 515  This section explains every layout option in more detail.
516 516  
517 -== Port Offset ==
772 +=== Edge Routing ===
518 518  
774 +{{id name="edgeRouting"/}}
775 +
776 +This option influences the way in which edges are routed between the nodes they connect. The following settings are available:
777 +
778 +* POLYLINE
779 +Edges consist of one or more segments defined by a list of bend points.
780 +* ORTHOGONAL
781 +Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically, but never at an angle.
782 +* SPLINE
783 +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.
784 +* UNDEFINED
785 +No particular edge routing style is selected. The result produced by the layout algorithm may be undefined.
786 +
787 +(% style="color: rgb(153,51,0);" %)**TODO:** Add an image illustrating the different routing styles.
788 +
789 +=== Port Offset ===
790 +
791 +{{id name="portOffset"/}}
792 +
519 519  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.
794 +
795 +Set this property if one of the following cases applies:
796 +
797 +* The port constraints on a node are set to FREE, FIXED_SIDES or FIXED_ORDER.
798 +* The port constraints on a node are set to FIXED_RATIO or FIXED_POS, and the size of the node is not fixed. (Note that this is especially true for ports of compound nodes.)
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -7111096
1 +9470014
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/7111096/Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470014/KIML Layout Options