Skip to Content

Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
From version 15.1
edited by cds
on 2013/06/03 12:41
Change comment: Migrated to Confluence 5.3
To version 30.1
edited by csp
on 2015/02/18 12:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cds
1 +XWiki.csp
Content
... ... @@ -1,26 +1,28 @@
1 -{{warning}}
2 -This is preliminary and incomplete 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. 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.
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 -* 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.
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  )))|=(((
... ... @@ -33,7 +33,7 @@
33 33  Default
34 34  )))
35 35  |(((
36 -Alignment
38 +[[Alignment>>doc:||anchor="alignment"]]
37 37  )))|(((
38 38  de.cau.cs.kieler.alignment
39 39  )))|(((
... ... @@ -44,7 +44,7 @@
44 44  AUTOMATIC
45 45  )))
46 46  |(((
47 -Aspect Ratio
49 +[[Aspect Ratio>>doc:||anchor="aspectRatio"]]
48 48  )))|(((
49 49  de.cau.cs.kieler.aspectRatio
50 50  )))|(((
... ... @@ -74,128 +74,279 @@
74 74  )))|(((
75 75  Parents
76 76  )))|(((
77 --1.0
79 +
78 78  )))
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 +|(((
137 +Label Spacing
138 +)))|(((
139 +de.cau.cs.kieler.labelSpacing
140 +)))|(((
141 +Float
142 +)))|(((
143 +Edges
144 +Nodes
145 +)))|(((
146 +
147 +)))
148 +|(((
149 +[[Layout Hierarchy>>doc:||anchor="layoutHierarchy"]]
150 +)))|(((
151 +de.cau.cs.kieler.layoutHierarchy
152 +)))|(((
153 +Boolean
154 +)))|(((
155 +Parents
156 +)))|(((
157 +false
158 +)))
159 +|(((
160 +[[Layout Algorithm>>doc:||anchor="layoutAlgorithm"]]
161 +)))|(((
162 +de.cau.cs.kieler.algorithm
163 +)))|(((
164 +String
165 +)))|(((
166 +Parents
167 +)))|(((
168 +
169 +)))
79 79  |(% colspan="1" %)(% colspan="1" %)
80 80  (((
81 -Comment Box
172 +Node Label Placement
82 82  )))|(% colspan="1" %)(% colspan="1" %)
83 83  (((
84 -de.cau.cs.kieler.commentBox
175 +de.cau.cs.kieler.nodeLabelPlacement
85 85  )))|(% colspan="1" %)(% colspan="1" %)
86 86  (((
87 -Boolean
178 +EnumSet
88 88  )))|(% colspan="1" %)(% colspan="1" %)
89 89  (((
90 90  Nodes
182 +Labels
91 91  )))|(% colspan="1" %)(% colspan="1" %)
92 92  (((
93 -false
185 +
94 94  )))
95 95  |(((
96 -Debug Mode
188 +Port Constraints
97 97  )))|(((
98 -de.cau.cs.kieler.debugMode
190 +de.cau.cs.kieler.portConstraints
99 99  )))|(((
100 -Boolean
192 +Enum
101 101  )))|(((
102 -Parents
194 +Nodes
103 103  )))|(((
104 -false
196 +
105 105  )))
106 106  |(% colspan="1" %)(% colspan="1" %)
107 107  (((
108 -Diagram Type
200 +Port Label Placement
109 109  )))|(% colspan="1" %)(% colspan="1" %)
110 110  (((
111 -de.cau.cs.kieler.diagramType
203 +de.cau.cs.kieler.portLabelPlacement
112 112  )))|(% colspan="1" %)(% colspan="1" %)
113 113  (((
114 -String
206 +Enum
115 115  )))|(% colspan="1" %)(% colspan="1" %)
116 116  (((
117 -
209 +Nodes
118 118  )))|(% colspan="1" %)(% colspan="1" %)
119 119  (((
212 +OUTSIDE
213 +)))
214 +|(% colspan="1" %)(% colspan="1" %)
215 +(((
216 +
217 +)))|(% colspan="1" %)(% colspan="1" %)
218 +(((
219 +de.cau.cs.kieler.portSpacing
220 +)))|(% colspan="1" %)(% colspan="1" %)
221 +(((
222 +Float
223 +)))|(% colspan="1" %)(% colspan="1" %)
224 +(((
225 +Nodes
226 +)))|(% colspan="1" %)(% colspan="1" %)
227 +(((
120 120  
121 121  )))
122 -|(((
123 -Direction
124 -)))|(((
125 -de.cau.cs.kieler.direction
126 -)))|(((
230 +|(% colspan="1" %)(% colspan="1" %)
231 +(((
232 +Port Alignment
233 +)))|(% colspan="1" %)(% colspan="1" %)
234 +(((
235 +de.cau.cs.kieler.portAlignment
236 +)))|(% colspan="1" %)(% colspan="1" %)
237 +(((
127 127  Enum
128 -)))|(((
239 +)))|(% colspan="1" %)(% colspan="1" %)
240 +(((
241 +Nodes
129 129  Parents
130 -)))|(((
243 +)))|(% colspan="1" %)(% colspan="1" %)
244 +(((
245 +JUSTIFIED
246 +)))
247 +|(% colspan="1" %)(% colspan="1" %)
248 +(((
249 +Port Alignment for Northern Ports
250 +)))|(% colspan="1" %)(% colspan="1" %)
251 +(((
252 +de.cau.cs.kieler.portAlignment.north
253 +)))|(% colspan="1" %)(% colspan="1" %)
254 +(((
255 +Enum
256 +)))|(% colspan="1" %)(% colspan="1" %)
257 +(((
258 +Nodes
259 +Parents
260 +)))|(% colspan="1" %)(% colspan="1" %)
261 +(((
131 131  UNDEFINED
132 132  )))
133 133  |(% colspan="1" %)(% colspan="1" %)
134 134  (((
135 -Edge Label Placement
266 +Port Alignment for Souther Ports
136 136  )))|(% colspan="1" %)(% colspan="1" %)
137 137  (((
138 -de.cau.cs.kieler.edgeLabelPlacement
269 +de.cau.cs.kieler.portAlignment.south
139 139  )))|(% colspan="1" %)(% colspan="1" %)
140 140  (((
141 141  Enum
142 142  )))|(% colspan="1" %)(% colspan="1" %)
143 143  (((
144 -Labels
275 +Nodes
276 +Parents
145 145  )))|(% colspan="1" %)(% colspan="1" %)
146 146  (((
147 147  UNDEFINED
148 148  )))
149 -|(((
150 -[[Edge Routing>>doc:||anchor="edgeRouting"]]
151 -)))|(((
152 -de.cau.cs.kieler.edgeRouting
153 -)))|(((
281 +|(% colspan="1" %)(% colspan="1" %)
282 +(((
283 +Port Alignment for Eastern Ports
284 +)))|(% colspan="1" %)(% colspan="1" %)
285 +(((
286 +de.cau.cs.kieler.portAlignment.east
287 +)))|(% colspan="1" %)(% colspan="1" %)
288 +(((
154 154  Enum
155 -)))|(((
290 +)))|(% colspan="1" %)(% colspan="1" %)
291 +(((
292 +Nodes
156 156  Parents
157 -)))|(((
294 +)))|(% colspan="1" %)(% colspan="1" %)
295 +(((
158 158  UNDEFINED
159 159  )))
160 160  |(% colspan="1" %)(% colspan="1" %)
161 161  (((
162 -Edge Type
300 +Port Alignment for Western Ports
163 163  )))|(% colspan="1" %)(% colspan="1" %)
164 164  (((
165 -de.cau.cs.kieler.edgeType
303 +de.cau.cs.kieler.portAlignment.west
166 166  )))|(% colspan="1" %)(% colspan="1" %)
167 167  (((
168 168  Enum
169 169  )))|(% colspan="1" %)(% colspan="1" %)
170 170  (((
171 -Edges
309 +Nodes
310 +Parents
172 172  )))|(% colspan="1" %)(% colspan="1" %)
173 173  (((
174 -NONE
313 +UNDEFINED
175 175  )))
176 176  |(((
177 -Expand Nodes
316 +Position
178 178  )))|(((
179 -de.cau.cs.kieler.expandNodes
318 +de.cau.cs.kieler.position
180 180  )))|(((
181 -Boolean
320 +Object
182 182  )))|(((
183 -Parents
322 +Labels
323 +Nodes
324 +Ports
184 184  )))|(((
185 -false
326 +
186 186  )))
328 +|(((
329 +Priority
330 +)))|(((
331 +de.cau.cs.kieler.priority
332 +)))|(((
333 +Int
334 +)))|(((
335 +Edges
336 +Nodes
337 +)))|(((
338 +
339 +)))
187 187  |(% colspan="1" %)(% colspan="1" %)
188 188  (((
189 -Font Name
342 +Randomization Seed
190 190  )))|(% colspan="1" %)(% colspan="1" %)
191 191  (((
192 -de.cau.cs.kieler.fontName
345 +de.cau.cs.kieler.randomSeed
193 193  )))|(% colspan="1" %)(% colspan="1" %)
194 194  (((
195 -String
348 +Int
196 196  )))|(% colspan="1" %)(% colspan="1" %)
197 197  (((
198 -Labels
351 +Parents
199 199  )))|(% colspan="1" %)(% colspan="1" %)
200 200  (((
201 201  
... ... @@ -202,16 +202,16 @@
202 202  )))
203 203  |(% colspan="1" %)(% colspan="1" %)
204 204  (((
205 -Font Size
358 +Separate Connected Components
206 206  )))|(% colspan="1" %)(% colspan="1" %)
207 207  (((
208 -de.cau.cs.kieler.fontSize
361 +de.cau.cs.kieler.separateConnComp
209 209  )))|(% colspan="1" %)(% colspan="1" %)
210 210  (((
211 -Int
364 +Boolean
212 212  )))|(% colspan="1" %)(% colspan="1" %)
213 213  (((
214 -Labels
367 +Parents
215 215  )))|(% colspan="1" %)(% colspan="1" %)
216 216  (((
217 217  
... ... @@ -218,15 +218,127 @@
218 218  )))
219 219  |(% colspan="1" %)(% colspan="1" %)
220 220  (((
221 -Hypernode
374 +Size Constraint
222 222  )))|(% colspan="1" %)(% colspan="1" %)
223 223  (((
224 -de.cau.cs.kieler.hypernode
377 +de.cau.cs.kieler.sizeConstraint
225 225  )))|(% colspan="1" %)(% colspan="1" %)
226 226  (((
380 +EnumSet
381 +)))|(% colspan="1" %)(% colspan="1" %)
382 +(((
383 +Nodes
384 +)))|(% colspan="1" %)(% colspan="1" %)
385 +(((
386 +
387 +)))
388 +|(% colspan="1" %)(% colspan="1" %)
389 +(((
390 +Size Options
391 +)))|(% colspan="1" %)(% colspan="1" %)
392 +(((
393 +de.cau.cs.kieler.sizeOptions
394 +)))|(% colspan="1" %)(% colspan="1" %)
395 +(((
396 +EnumSet
397 +)))|(% colspan="1" %)(% colspan="1" %)
398 +(((
399 +Nodes
400 +)))|(% colspan="1" %)(% colspan="1" %)
401 +(((
402 +DEFAULT_MINIMUM_SIZE
403 +)))
404 +|(% colspan="1" %)(% colspan="1" %)
405 +(((
406 +Spacing
407 +)))|(% colspan="1" %)(% colspan="1" %)
408 +(((
409 +de.cau.cs.kieler.spacing
410 +)))|(% colspan="1" %)(% colspan="1" %)
411 +(((
412 +Float
413 +)))|(% colspan="1" %)(% colspan="1" %)
414 +(((
415 +Parents
416 +)))|(% colspan="1" %)(% colspan="1" %)
417 +(((
418 +
419 +)))
420 +
421 +== Programmatic Options ==
422 +
423 +Programmatic options are such that are meant to be configured exclusively through the KIML API. They should not be visible in the user interface.
424 +
425 +|=(((
426 +Option
427 +)))|=(((
428 +ID
429 +)))|=(((
430 +Type
431 +)))|=(((
432 +Applies to
433 +)))|=(((
434 +Default
435 +)))
436 +|(% colspan="1" %)(% colspan="1" %)
437 +(((
438 +[[Additional Port Space>>doc:||anchor="addPortSpace"]]
439 +)))|(% colspan="1" %)(% colspan="1" %)
440 +(((
441 +de.cau.cs.kieler.additionalPortSpace
442 +)))|(% colspan="1" %)(% colspan="1" %)
443 +(((
444 +Margins
445 +)))|(% colspan="1" %)(% colspan="1" %)
446 +(((
447 +Nodes
448 +)))|(% colspan="1" %)(% colspan="1" %)
449 +(((
450 +0, 0, 0, 0
451 +)))
452 +|(% colspan="1" %)(% colspan="1" %)
453 +(((
454 +Animate
455 +)))|(% colspan="1" %)(% colspan="1" %)
456 +(((
457 +de.cau.cs.kieler.animate
458 +)))|(% colspan="1" %)(% colspan="1" %)
459 +(((
227 227  Boolean
228 228  )))|(% colspan="1" %)(% colspan="1" %)
229 229  (((
463 +Parents
464 +)))|(% colspan="1" %)(% colspan="1" %)
465 +(((
466 +true
467 +)))
468 +|(% colspan="1" %)(% colspan="1" %)
469 +(((
470 +Animation Time Factor
471 +)))|(% colspan="1" %)(% colspan="1" %)
472 +(((
473 +de.cau.cs.kieler.animTimeFactor
474 +)))|(% colspan="1" %)(% colspan="1" %)
475 +(((
476 +Int
477 +)))|(% colspan="1" %)(% colspan="1" %)
478 +(((
479 +Parents
480 +)))|(% colspan="1" %)(% colspan="1" %)
481 +(((
482 +100
483 +)))
484 +|(% colspan="1" %)(% colspan="1" %)
485 +(((
486 +[[Comment Box>>doc:||anchor="commentBox"]]
487 +)))|(% colspan="1" %)(% colspan="1" %)
488 +(((
489 +de.cau.cs.kieler.commentBox
490 +)))|(% colspan="1" %)(% colspan="1" %)
491 +(((
492 +Boolean
493 +)))|(% colspan="1" %)(% colspan="1" %)
494 +(((
230 230  Nodes
231 231  )))|(% colspan="1" %)(% colspan="1" %)
232 232  (((
... ... @@ -233,52 +233,141 @@
233 233  false
234 234  )))
235 235  |(((
236 -Interactive
501 +[[Diagram Type>>doc:||anchor="diagramType"]]
237 237  )))|(((
238 -de.cau.cs.kieler.interactive
503 +de.cau.cs.kieler.diagramType
239 239  )))|(((
240 -Boolean
505 +String
241 241  )))|(((
242 242  Parents
243 243  )))|(((
244 -false
509 +
245 245  )))
246 246  |(((
247 -Label Spacing
512 +Edge Label Placement
248 248  )))|(((
249 -de.cau.cs.kieler.labelSpacing
514 +de.cau.cs.kieler.edgeLabelPlacement
250 250  )))|(((
251 -Float
516 +Enum
252 252  )))|(((
518 +Labels
519 +)))|(((
520 +
521 +)))
522 +|(% colspan="1" %)(% colspan="1" %)
523 +(((
524 +Edge Type
525 +)))|(% colspan="1" %)(% colspan="1" %)
526 +(((
527 +de.cau.cs.kieler.edgeType
528 +)))|(% colspan="1" %)(% colspan="1" %)
529 +(((
530 +Enum
531 +)))|(% colspan="1" %)(% colspan="1" %)
532 +(((
253 253  Edges
534 +)))|(% colspan="1" %)(% colspan="1" %)
535 +(((
536 +NONE
537 +)))
538 +|(% colspan="1" %)(% colspan="1" %)
539 +(((
540 +Font Name
541 +)))|(% colspan="1" %)(% colspan="1" %)
542 +(((
543 +de.cau.cs.kieler.fontName
544 +)))|(% colspan="1" %)(% colspan="1" %)
545 +(((
546 +String
547 +)))|(% colspan="1" %)(% colspan="1" %)
548 +(((
549 +Labels
550 +)))|(% colspan="1" %)(% colspan="1" %)
551 +(((
552 +
553 +)))
554 +|(% colspan="1" %)(% colspan="1" %)
555 +(((
556 +Font Size
557 +)))|(% colspan="1" %)(% colspan="1" %)
558 +(((
559 +de.cau.cs.kieler.fontSize
560 +)))|(% colspan="1" %)(% colspan="1" %)
561 +(((
562 +Int
563 +)))|(% colspan="1" %)(% colspan="1" %)
564 +(((
565 +Labels
566 +)))|(% colspan="1" %)(% colspan="1" %)
567 +(((
568 +
569 +)))
570 +|(% colspan="1" %)(% colspan="1" %)
571 +(((
572 +[[Hypernode>>doc:||anchor="hypernode"]]
573 +)))|(% colspan="1" %)(% colspan="1" %)
574 +(((
575 +de.cau.cs.kieler.hypernode
576 +)))|(% colspan="1" %)(% colspan="1" %)
577 +(((
578 +Boolean
579 +)))|(% colspan="1" %)(% colspan="1" %)
580 +(((
254 254  Nodes
255 -)))|(((
256 --1.0
582 +)))|(% colspan="1" %)(% colspan="1" %)
583 +(((
584 +false
257 257  )))
258 -|(((
259 -Layout Hierarchy
260 -)))|(((
261 -de.cau.cs.kieler.layoutHierarchy
262 -)))|(((
586 +|(% colspan="1" %)(% colspan="1" %)
587 +(((
588 +Layout Ancestors
589 +)))|(% colspan="1" %)(% colspan="1" %)
590 +(((
591 +de.cau.cs.kieler.layoutAncestors
592 +)))|(% colspan="1" %)(% colspan="1" %)
593 +(((
263 263  Boolean
264 -)))|(((
595 +)))|(% colspan="1" %)(% colspan="1" %)
596 +(((
265 265  Parents
266 -)))|(((
598 +)))|(% colspan="1" %)(% colspan="1" %)
599 +(((
267 267  false
268 268  )))
269 -|(((
270 -Layout Algorithm
271 -)))|(((
272 -de.cau.cs.kieler.algorithm
273 -)))|(((
274 -String
275 -)))|(((
602 +|(% colspan="1" %)(% colspan="1" %)
603 +(((
604 +Maximal Animation Time
605 +)))|(% colspan="1" %)(% colspan="1" %)
606 +(((
607 +de.cau.cs.kieler.maxAnimTim
608 +)))|(% colspan="1" %)(% colspan="1" %)
609 +(((
610 +Int
611 +)))|(% colspan="1" %)(% colspan="1" %)
612 +(((
276 276  Parents
277 -)))|(((
278 -
614 +)))|(% colspan="1" %)(% colspan="1" %)
615 +(((
616 +4000
279 279  )))
280 280  |(% colspan="1" %)(% colspan="1" %)
281 281  (((
620 +Minimal Animation Time
621 +)))|(% colspan="1" %)(% colspan="1" %)
622 +(((
623 +de.cau.cs.kieler.minAnimTim
624 +)))|(% colspan="1" %)(% colspan="1" %)
625 +(((
626 +Int
627 +)))|(% colspan="1" %)(% colspan="1" %)
628 +(((
629 +Parents
630 +)))|(% colspan="1" %)(% colspan="1" %)
631 +(((
632 +400
633 +)))
634 +|(% colspan="1" %)(% colspan="1" %)
635 +(((
282 282  Minimal Height
283 283  )))|(% colspan="1" %)(% colspan="1" %)
284 284  (((
... ... @@ -313,7 +313,7 @@
313 313  )))
314 314  |(% colspan="1" %)(% colspan="1" %)
315 315  (((
316 -No Layout
670 +[[No Layout>>doc:||anchor="noLayout"]]
317 317  )))|(% colspan="1" %)(% colspan="1" %)
318 318  (((
319 319  de.cau.cs.kieler.noLayout
... ... @@ -329,46 +329,35 @@
329 329  )))
330 330  |(% colspan="1" %)(% colspan="1" %)
331 331  (((
332 -Node Label Placement
686 +[[Port Anchor Offset>>doc:||anchor="portAnchor"]]
333 333  )))|(% colspan="1" %)(% colspan="1" %)
334 334  (((
335 -de.cau.cs.kieler.nodeLabelPlacement
689 +de.cau.cs.kieler.klay.layered.portAnchor
336 336  )))|(% colspan="1" %)(% colspan="1" %)
337 337  (((
338 -EnumSet
692 +Object
339 339  )))|(% colspan="1" %)(% colspan="1" %)
340 340  (((
341 -Nodes
695 +Ports
342 342  )))|(% colspan="1" %)(% colspan="1" %)
343 343  (((
344 344  
345 345  )))
346 -|(((
347 -Port Constraints
348 -)))|(((
349 -de.cau.cs.kieler.portConstraints
350 -)))|(((
351 -Enum
352 -)))|(((
353 -Nodes
354 -)))|(((
355 -UNDEFINED
356 -)))
357 357  |(% colspan="1" %)(% colspan="1" %)
358 358  (((
359 -Port Label Placement
702 +Port Index
360 360  )))|(% colspan="1" %)(% colspan="1" %)
361 361  (((
362 -de.cau.cs.kieler.portLabelPlacement
705 +de.cau.cs.kieler.portIndex
363 363  )))|(% colspan="1" %)(% colspan="1" %)
364 364  (((
365 -Enum
708 +Int
366 366  )))|(% colspan="1" %)(% colspan="1" %)
367 367  (((
368 -Nodes
711 +Ports
369 369  )))|(% colspan="1" %)(% colspan="1" %)
370 370  (((
371 -OUTSIDE
714 +
372 372  )))
373 373  |(% colspan="1" %)(% colspan="1" %)
374 374  (((
... ... @@ -400,57 +400,16 @@
400 400  Ports
401 401  )))|(% colspan="1" %)(% colspan="1" %)
402 402  (((
403 -UNDEFINED
404 -)))
405 -|(((
406 -Position
407 -)))|(((
408 -de.cau.cs.kieler.position
409 -)))|(((
410 -Object
411 -)))|(((
412 -Labels
413 -Nodes
414 -Ports
415 -)))|(((
416 416  
417 417  )))
418 -|(((
419 -Priority
420 -)))|(((
421 -de.cau.cs.kieler.priority
422 -)))|(((
423 -Int
424 -)))|(((
425 -Edges
426 -Nodes
427 -)))|(((
428 -
429 -)))
430 430  |(% colspan="1" %)(% colspan="1" %)
431 431  (((
432 -Randomization Seed
750 +Progress Bar
433 433  )))|(% colspan="1" %)(% colspan="1" %)
434 434  (((
435 -de.cau.cs.kieler.randomSeed
753 +de.cau.cs.kieler.progressBar
436 436  )))|(% colspan="1" %)(% colspan="1" %)
437 437  (((
438 -Int
439 -)))|(% colspan="1" %)(% colspan="1" %)
440 -(((
441 -Parents
442 -)))|(% colspan="1" %)(% colspan="1" %)
443 -(((
444 -
445 -)))
446 -|(% colspan="1" %)(% colspan="1" %)
447 -(((
448 -Separate Connected Components
449 -)))|(% colspan="1" %)(% colspan="1" %)
450 -(((
451 -de.cau.cs.kieler.separateConnComp
452 -)))|(% colspan="1" %)(% colspan="1" %)
453 -(((
454 454  Boolean
455 455  )))|(% colspan="1" %)(% colspan="1" %)
456 456  (((
... ... @@ -457,93 +457,219 @@
457 457  Parents
458 458  )))|(% colspan="1" %)(% colspan="1" %)
459 459  (((
460 -
762 +false
461 461  )))
462 462  |(% colspan="1" %)(% colspan="1" %)
463 463  (((
464 -Size Constraint
766 +Scale Factor
465 465  )))|(% colspan="1" %)(% colspan="1" %)
466 466  (((
467 -de.cau.cs.kieler.sizeConstraint
769 +de.cau.cs.kieler.scaleFactor
468 468  )))|(% colspan="1" %)(% colspan="1" %)
469 469  (((
470 -EnumSet
772 +Float
471 471  )))|(% colspan="1" %)(% colspan="1" %)
472 472  (((
473 473  Nodes
474 474  )))|(% colspan="1" %)(% colspan="1" %)
475 475  (((
476 -
778 +1.0
477 477  )))
478 478  |(% colspan="1" %)(% colspan="1" %)
479 479  (((
480 -Size Options
782 +Thickness
481 481  )))|(% colspan="1" %)(% colspan="1" %)
482 482  (((
483 -de.cau.cs.kieler.sizeOptions
785 +de.cau.cs.kieler.thickness
484 484  )))|(% colspan="1" %)(% colspan="1" %)
485 485  (((
486 -EnumSet
788 +Float
487 487  )))|(% colspan="1" %)(% colspan="1" %)
488 488  (((
489 -Nodes
791 +Edges
490 490  )))|(% colspan="1" %)(% colspan="1" %)
491 491  (((
492 -DEFAULT_MINIMUM_SIZE
794 +1.0
493 493  )))
494 494  |(% colspan="1" %)(% colspan="1" %)
495 495  (((
496 -Spacing
798 +Zoom to Fit
497 497  )))|(% colspan="1" %)(% colspan="1" %)
498 498  (((
499 -de.cau.cs.kieler.spacing
801 +de.cau.cs.kieler.zoomToFit
500 500  )))|(% colspan="1" %)(% colspan="1" %)
501 501  (((
502 -Float
804 +Boolean
503 503  )))|(% colspan="1" %)(% colspan="1" %)
504 504  (((
505 505  Parents
506 506  )))|(% colspan="1" %)(% colspan="1" %)
507 507  (((
508 --1.0
810 +false
509 509  )))
510 510  
511 -= The Most Important Options =
813 +=== Layout Output Properties ===
512 512  
513 -**TODO:** Write a bit of documentation about the most important layout options and how to use them, possibly with a simple example or something.
815 +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
514 514  
817 +|=(((
818 +Property
819 +)))|=(((
820 +ID
821 +)))|=(((
822 +Type
823 +)))|=(((
824 +Applies to
825 +)))
826 +|(((
827 +[[Edge Routing>>doc:||anchor="edgeRouting"]]
828 +)))|(((
829 +de.cau.cs.kieler.edgeRouting
830 +)))|(((
831 +Enum
832 +)))|(((
833 +Edges
834 +)))
835 +|(((
836 +Junction Points
837 +)))|(((
838 +de.cau.cs.kieler.junctionPoints
839 +)))|(((
840 +Object
841 +)))|(((
842 +Edges
843 +)))
844 +
845 +
846 +
515 515  = Detailed Documentation =
516 516  
517 517  This section explains every layout option in more detail.
518 518  
519 -== Edge Routing ==
851 +== The Most Important Options ==
520 520  
853 +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.
521 521  
855 +=== ===
522 522  
523 -{{id name="edgeRouting"/}}
857 +{{id name="layoutAlgorithm"/}}Layout AlgorithmThe 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.
524 524  
525 -This option influences the way in which edges are routed between the nodes they connect. The following settings are available:
859 +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.
526 526  
861 +[[image:attach:layout_algorithm.png]]
862 +
863 +==== Available Algorithms and Libraries ====
864 +
865 +* **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.
866 +* **Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
867 +* (((
868 +**Box Layout** - Ignores edges, places all nodes in rows. Can be used to layout collections of unconnected boxes, such as Statechart regions.
869 +)))
870 +* **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.
871 +* **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.
872 +* **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.
873 +
874 +==== Predefined Layout Types ====
875 +
876 +* **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.
877 +* **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.
878 +* **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
879 +* **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.
880 +* **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.
881 +
882 +=== ===
883 +
884 +{{id name="diagramType"/}}Diagram TypeDiagram 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.
885 +
886 +The following diagram types are predefined:
887 +
888 +* **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.
889 +* **State Machine** - All kinds of state machines, automata, and activity diagrams. Examples: [[doc:SCCharts SyncCharts]], UML Activity diagrams.
890 +* **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)]].
891 +* **Class Diagram** - Class diagrams such as Ecore diagrams for the [[EMF>>url:http://www.eclipse.org/modeling/emf/||shape="rect"]] or UML Class diagrams.
892 +* **Use Case Diagram** - Use case diagrams as defined by the UML.
893 +* **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]].
894 +
895 +=== ===
896 +
897 +{{id name="edgeRouting"/}}Edge RoutingThis option influences the way in which edges are routed between the nodes they connect. The following settings are available:
898 +
527 527  * POLYLINE
528 528  Edges consist of one or more segments defined by a list of bend points.
529 529  * ORTHOGONAL
530 -Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically, but never at an angle.
531 -* SPLINE
532 -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.
902 +Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically.
903 +* SPLINES
904 +Edges are routed as splines (smooth curves).
533 533  * UNDEFINED
534 -No particular edge routing style is selected. The result produced by the layout algorithm may be undefined.
906 +No particular edge routing style is selected. Usually this value points to the default setting of the selected layout algorithm.
535 535  
536 -(% style="color: rgb(153,51,0);" %)**TODO:** Add an image illustrating the different routing styles.
908 +[[image:attach:edge_routing.png]]
537 537  
538 -== Port Offset ==
910 +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:
539 539  
912 +1. Start at the source point of the edge.
913 +1. As long as there are at least three bend points left:
914 +11. Draw a cubic spline segment to the third bend point with the other two bend points as control points.
915 +11. Use the third bend point as start point for the next segment.
916 +11. Consume the three bend points and proceed to the next segment.
917 +1. Check the number of remaining bend points:
918 +11. Two bend points – draw a cubic spline segment to the target point of the edge.
919 +11. One bend point – draw a quadratic spline segment to the target point of the edge.
920 +11. No bend point – draw a straight line to the target point of the edge.
540 540  
922 +== Other Options ==
541 541  
542 -{{id name="portOffset"/}}
924 +=== ===
543 543  
544 -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.
926 +{{id name="addPortSpace"/}}Additional Port SpaceThis option controls additional port space left around the set of ports on each side:
545 545  
928 +[[image:attach:addPortSpace.png]]
929 +
930 +This option is only relevant if port constraints are {{code language="none"}}FREE{{/code}}, {{code language="none"}}FIXED_SIDE{{/code}}, or {{code language="none"}}FIXED_ORDER{{/code}}. If size constraints include {{code language="none"}}PORTS{{/code}}, the additional port space, together with the port spacing and the size of ports, determines a lower bound on the node size.
931 +
932 +=== ===
933 +
934 +{{id name="alignment"/}}AlignmentDetermines 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.
935 +
936 +=== ===
937 +
938 +{{id name="aspectRatio"/}}Aspect RatioThe 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.
939 +
940 +=== ===
941 +
942 +{{id name="commentBox"/}}Comment BoxA 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.
943 +
944 +[[image:attach:comment_box.png]]
945 +
946 +=== ===
947 +
948 +{{id name="hypernode"/}}HypernodeA 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.
949 +
950 +=== ===
951 +
952 +{{id name="layoutHierarchy"/}}Layout HierarchyIf 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.
953 +
954 +=== ===
955 +
956 +{{id name="noLayout"/}}No LayoutElements 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.
957 +
958 +=== ===
959 +
960 +{{id name="portAnchor"/}}Port Anchor OffsetSince ports have a size, we need a concrete point inside the port that edges should start or end in. In KLay Layered, this is referred to as the //port anchor//. By default, the center of each port is used as its port anchor, but this behavior can be overridden by setting an explicit port anchor.
961 +
962 +In the following example, the port anchor of the left port was moved upwards, while the port anchor of the second port was moved downwards:
963 +
964 +[[image:attach:KLay Layered Layout Options@port_anchors.png]]
965 +
966 +=== ===
967 +
968 +{{id name="portOffset"/}}Port OffsetThe 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.
969 +
546 546  Set this property if one of the following cases applies:
547 547  
548 548  * The port constraints on a node are set to FREE, FIXED_SIDES or FIXED_ORDER.
549 549  * 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.)
974 +
975 +=== ===
976 +
977 +{{id name="portSpacing"/}}Port SpacingThe port spacing determines how much space KLay Layered should leave between the ports of each side. This option is only relevant if the node size depends on the ports, that is, if the size constraints include {{code language="none"}}SizeConstraint.PORTS{{/code}}.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9469964
1 +10751222
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9469964/KIML Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751222/KIML Layout Options