Skip to Content

Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
From version 6.1
edited by cds
on 2013/06/03 10:42
Change comment: There is no comment for this version
To version 32.3
edited by csp
on 2023/07/06 14:35
Change comment: Updated the relative links.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +KIELER.Home.Discontinued Projects.Infrastructure for Meta Layout (KIML).WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cds
1 +XWiki.csp
Content
... ... @@ -1,24 +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. 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 -
10 10  
8 +
9 +{{toc maxLevel="2"/}}
10 +
11 11  = Overview =
12 12  
13 -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:
14 14  
15 15  * An ID to identify them.
16 -* A type. One of Boolean, String, Int, Float, Enum, EnumSet (a {{code language="none"}}Set{{/code}} over a given enumeration), or Object. The types Enum and EnumSet have to be further defined by an enumeration class. The Object type can be constricted to a certain class.
17 -* The kinds of graph objects the option applies to. At least one of Parents (nodes that have children, including the diagram root node), Nodes, Edges, Ports, and Labels.
18 -* An optional default value. If an option is not set on an object and if the option does not have a default value, {{code language="none"}}null{{/code}} is returned when it is accessed.
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.
19 19  
20 -KIML defines the following set of layout options:
20 +Layout options can be assigned to two main categories: user options and programmatic options.
21 21  
22 +== User Options ==
23 +
24 +User options are those that you can see in the "//Layout View//" available in Eclipse if the KIML user interface is installed. That view is restricted to layout options that are supported by the currently active layout algorithm. Furthermore, some options are visible only when the //Show Advanced Properties// button is active in the view.
25 +
22 22  |=(((
23 23  Option
24 24  )))|=(((
... ... @@ -31,7 +31,7 @@
31 31  Default
32 32  )))
33 33  |(((
34 -Alignment
38 +[[Alignment>>doc:||anchor="alignment"]]
35 35  )))|(((
36 36  de.cau.cs.kieler.alignment
37 37  )))|(((
... ... @@ -42,7 +42,7 @@
42 42  AUTOMATIC
43 43  )))
44 44  |(((
45 -Aspect Ratio
49 +[[Aspect Ratio>>doc:||anchor="aspectRatio"]]
46 46  )))|(((
47 47  de.cau.cs.kieler.aspectRatio
48 48  )))|(((
... ... @@ -72,128 +72,279 @@
72 72  )))|(((
73 73  Parents
74 74  )))|(((
75 --1.0
79 +
76 76  )))
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 +)))
77 77  |(% colspan="1" %)(% colspan="1" %)
78 78  (((
79 -Comment Box
172 +Node Label Placement
80 80  )))|(% colspan="1" %)(% colspan="1" %)
81 81  (((
82 -de.cau.cs.kieler.commentBox
175 +de.cau.cs.kieler.nodeLabelPlacement
83 83  )))|(% colspan="1" %)(% colspan="1" %)
84 84  (((
85 -Boolean
178 +EnumSet
86 86  )))|(% colspan="1" %)(% colspan="1" %)
87 87  (((
88 88  Nodes
182 +Labels
89 89  )))|(% colspan="1" %)(% colspan="1" %)
90 90  (((
91 -false
185 +
92 92  )))
93 93  |(((
94 -Debug Mode
188 +Port Constraints
95 95  )))|(((
96 -de.cau.cs.kieler.debugMode
190 +de.cau.cs.kieler.portConstraints
97 97  )))|(((
98 -Boolean
192 +Enum
99 99  )))|(((
100 -Parents
194 +Nodes
101 101  )))|(((
102 -false
196 +
103 103  )))
104 104  |(% colspan="1" %)(% colspan="1" %)
105 105  (((
106 -Diagram Type
200 +Port Label Placement
107 107  )))|(% colspan="1" %)(% colspan="1" %)
108 108  (((
109 -de.cau.cs.kieler.diagramType
203 +de.cau.cs.kieler.portLabelPlacement
110 110  )))|(% colspan="1" %)(% colspan="1" %)
111 111  (((
112 -String
206 +Enum
113 113  )))|(% colspan="1" %)(% colspan="1" %)
114 114  (((
115 -
209 +Nodes
116 116  )))|(% colspan="1" %)(% colspan="1" %)
117 117  (((
212 +OUTSIDE
213 +)))
214 +|(% colspan="1" %)(% colspan="1" %)
215 +(((
216 +[[Port Spacing>>doc:||anchor="portSpacing"]]
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 +(((
118 118  
119 119  )))
120 -|(((
121 -Direction
122 -)))|(((
123 -de.cau.cs.kieler.direction
124 -)))|(((
230 +|(% colspan="1" %)(% colspan="1" %)
231 +(((
232 +[[Port Alignment>>doc:||anchor="portAlignment"]]
233 +)))|(% colspan="1" %)(% colspan="1" %)
234 +(((
235 +de.cau.cs.kieler.portAlignment
236 +)))|(% colspan="1" %)(% colspan="1" %)
237 +(((
125 125  Enum
126 -)))|(((
239 +)))|(% colspan="1" %)(% colspan="1" %)
240 +(((
241 +Nodes
127 127  Parents
128 -)))|(((
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 +(((
129 129  UNDEFINED
130 130  )))
131 131  |(% colspan="1" %)(% colspan="1" %)
132 132  (((
133 -Edge Label Placement
266 +Port Alignment for Souther Ports
134 134  )))|(% colspan="1" %)(% colspan="1" %)
135 135  (((
136 -de.cau.cs.kieler.edgeLabelPlacement
269 +de.cau.cs.kieler.portAlignment.south
137 137  )))|(% colspan="1" %)(% colspan="1" %)
138 138  (((
139 139  Enum
140 140  )))|(% colspan="1" %)(% colspan="1" %)
141 141  (((
142 -Labels
275 +Nodes
276 +Parents
143 143  )))|(% colspan="1" %)(% colspan="1" %)
144 144  (((
145 145  UNDEFINED
146 146  )))
147 -|(((
148 -Edge Routing
149 -)))|(((
150 -de.cau.cs.kieler.edgeRouting
151 -)))|(((
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 +(((
152 152  Enum
153 -)))|(((
290 +)))|(% colspan="1" %)(% colspan="1" %)
291 +(((
292 +Nodes
154 154  Parents
155 -)))|(((
294 +)))|(% colspan="1" %)(% colspan="1" %)
295 +(((
156 156  UNDEFINED
157 157  )))
158 158  |(% colspan="1" %)(% colspan="1" %)
159 159  (((
160 -Edge Type
300 +Port Alignment for Western Ports
161 161  )))|(% colspan="1" %)(% colspan="1" %)
162 162  (((
163 -de.cau.cs.kieler.edgeType
303 +de.cau.cs.kieler.portAlignment.west
164 164  )))|(% colspan="1" %)(% colspan="1" %)
165 165  (((
166 166  Enum
167 167  )))|(% colspan="1" %)(% colspan="1" %)
168 168  (((
169 -Edges
309 +Nodes
310 +Parents
170 170  )))|(% colspan="1" %)(% colspan="1" %)
171 171  (((
172 -NONE
313 +UNDEFINED
173 173  )))
174 174  |(((
175 -Expand Nodes
316 +Position
176 176  )))|(((
177 -de.cau.cs.kieler.expandNodes
318 +de.cau.cs.kieler.position
178 178  )))|(((
179 -Boolean
320 +Object
180 180  )))|(((
181 -Parents
322 +Labels
323 +Nodes
324 +Ports
182 182  )))|(((
183 -false
326 +
184 184  )))
328 +|(((
329 +Priority
330 +)))|(((
331 +de.cau.cs.kieler.priority
332 +)))|(((
333 +Int
334 +)))|(((
335 +Edges
336 +Nodes
337 +)))|(((
338 +
339 +)))
185 185  |(% colspan="1" %)(% colspan="1" %)
186 186  (((
187 -Font Name
342 +Randomization Seed
188 188  )))|(% colspan="1" %)(% colspan="1" %)
189 189  (((
190 -de.cau.cs.kieler.fontName
345 +de.cau.cs.kieler.randomSeed
191 191  )))|(% colspan="1" %)(% colspan="1" %)
192 192  (((
193 -String
348 +Int
194 194  )))|(% colspan="1" %)(% colspan="1" %)
195 195  (((
196 -Labels
351 +Parents
197 197  )))|(% colspan="1" %)(% colspan="1" %)
198 198  (((
199 199  
... ... @@ -200,16 +200,16 @@
200 200  )))
201 201  |(% colspan="1" %)(% colspan="1" %)
202 202  (((
203 -Font Size
358 +Separate Connected Components
204 204  )))|(% colspan="1" %)(% colspan="1" %)
205 205  (((
206 -de.cau.cs.kieler.fontSize
361 +de.cau.cs.kieler.separateConnComp
207 207  )))|(% colspan="1" %)(% colspan="1" %)
208 208  (((
209 -Int
364 +Boolean
210 210  )))|(% colspan="1" %)(% colspan="1" %)
211 211  (((
212 -Labels
367 +Parents
213 213  )))|(% colspan="1" %)(% colspan="1" %)
214 214  (((
215 215  
... ... @@ -216,15 +216,127 @@
216 216  )))
217 217  |(% colspan="1" %)(% colspan="1" %)
218 218  (((
219 -Hypernode
374 +Size Constraint
220 220  )))|(% colspan="1" %)(% colspan="1" %)
221 221  (((
222 -de.cau.cs.kieler.hypernode
377 +de.cau.cs.kieler.sizeConstraint
223 223  )))|(% colspan="1" %)(% colspan="1" %)
224 224  (((
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 +(((
225 225  Boolean
226 226  )))|(% colspan="1" %)(% colspan="1" %)
227 227  (((
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 +(((
228 228  Nodes
229 229  )))|(% colspan="1" %)(% colspan="1" %)
230 230  (((
... ... @@ -231,52 +231,141 @@
231 231  false
232 232  )))
233 233  |(((
234 -Interactive
501 +[[Diagram Type>>doc:||anchor="diagramType"]]
235 235  )))|(((
236 -de.cau.cs.kieler.interactive
503 +de.cau.cs.kieler.diagramType
237 237  )))|(((
238 -Boolean
505 +String
239 239  )))|(((
240 240  Parents
241 241  )))|(((
242 -false
509 +
243 243  )))
244 244  |(((
245 -Label Spacing
512 +Edge Label Placement
246 246  )))|(((
247 -de.cau.cs.kieler.labelSpacing
514 +de.cau.cs.kieler.edgeLabelPlacement
248 248  )))|(((
249 -Float
516 +Enum
250 250  )))|(((
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 +(((
251 251  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 +(((
252 252  Nodes
253 -)))|(((
254 --1.0
582 +)))|(% colspan="1" %)(% colspan="1" %)
583 +(((
584 +false
255 255  )))
256 -|(((
257 -Layout Hierarchy
258 -)))|(((
259 -de.cau.cs.kieler.layoutHierarchy
260 -)))|(((
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 +(((
261 261  Boolean
262 -)))|(((
595 +)))|(% colspan="1" %)(% colspan="1" %)
596 +(((
263 263  Parents
264 -)))|(((
598 +)))|(% colspan="1" %)(% colspan="1" %)
599 +(((
265 265  false
266 266  )))
267 -|(((
268 -Layout Algorithm
269 -)))|(((
270 -de.cau.cs.kieler.algorithm
271 -)))|(((
272 -String
273 -)))|(((
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 +(((
274 274  Parents
275 -)))|(((
276 -
614 +)))|(% colspan="1" %)(% colspan="1" %)
615 +(((
616 +4000
277 277  )))
278 278  |(% colspan="1" %)(% colspan="1" %)
279 279  (((
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 +(((
280 280  Minimal Height
281 281  )))|(% colspan="1" %)(% colspan="1" %)
282 282  (((
... ... @@ -311,7 +311,7 @@
311 311  )))
312 312  |(% colspan="1" %)(% colspan="1" %)
313 313  (((
314 -No Layout
670 +[[No Layout>>doc:||anchor="noLayout"]]
315 315  )))|(% colspan="1" %)(% colspan="1" %)
316 316  (((
317 317  de.cau.cs.kieler.noLayout
... ... @@ -327,46 +327,35 @@
327 327  )))
328 328  |(% colspan="1" %)(% colspan="1" %)
329 329  (((
330 -Node Label Placement
686 +[[Port Anchor Offset>>doc:||anchor="portAnchor"]]
331 331  )))|(% colspan="1" %)(% colspan="1" %)
332 332  (((
333 -de.cau.cs.kieler.nodeLabelPlacement
689 +de.cau.cs.kieler.klay.layered.portAnchor
334 334  )))|(% colspan="1" %)(% colspan="1" %)
335 335  (((
336 -EnumSet
692 +Object
337 337  )))|(% colspan="1" %)(% colspan="1" %)
338 338  (((
339 -Nodes
695 +Ports
340 340  )))|(% colspan="1" %)(% colspan="1" %)
341 341  (((
342 342  
343 343  )))
344 -|(((
345 -Port Constraints
346 -)))|(((
347 -de.cau.cs.kieler.portConstraints
348 -)))|(((
349 -Enum
350 -)))|(((
351 -Nodes
352 -)))|(((
353 -UNDEFINED
354 -)))
355 355  |(% colspan="1" %)(% colspan="1" %)
356 356  (((
357 -Port Label Placement
702 +Port Index
358 358  )))|(% colspan="1" %)(% colspan="1" %)
359 359  (((
360 -de.cau.cs.kieler.portLabelPlacement
705 +de.cau.cs.kieler.portIndex
361 361  )))|(% colspan="1" %)(% colspan="1" %)
362 362  (((
363 -Enum
708 +Int
364 364  )))|(% colspan="1" %)(% colspan="1" %)
365 365  (((
366 -Nodes
711 +Ports
367 367  )))|(% colspan="1" %)(% colspan="1" %)
368 368  (((
369 -OUTSIDE
714 +
370 370  )))
371 371  |(% colspan="1" %)(% colspan="1" %)
372 372  (((
... ... @@ -398,57 +398,16 @@
398 398  Ports
399 399  )))|(% colspan="1" %)(% colspan="1" %)
400 400  (((
401 -UNDEFINED
402 -)))
403 -|(((
404 -Position
405 -)))|(((
406 -de.cau.cs.kieler.position
407 -)))|(((
408 -Object
409 -)))|(((
410 -Labels
411 -Nodes
412 -Ports
413 -)))|(((
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
750 +Progress Bar
431 431  )))|(% colspan="1" %)(% colspan="1" %)
432 432  (((
433 -de.cau.cs.kieler.randomSeed
753 +de.cau.cs.kieler.progressBar
434 434  )))|(% colspan="1" %)(% colspan="1" %)
435 435  (((
436 -Int
437 -)))|(% colspan="1" %)(% colspan="1" %)
438 -(((
439 -Parents
440 -)))|(% colspan="1" %)(% colspan="1" %)
441 -(((
442 -
443 -)))
444 -|(% colspan="1" %)(% colspan="1" %)
445 -(((
446 -Separate Connected Components
447 -)))|(% colspan="1" %)(% colspan="1" %)
448 -(((
449 -de.cau.cs.kieler.separateConnComp
450 -)))|(% colspan="1" %)(% colspan="1" %)
451 -(((
452 452  Boolean
453 453  )))|(% colspan="1" %)(% colspan="1" %)
454 454  (((
... ... @@ -455,72 +455,242 @@
455 455  Parents
456 456  )))|(% colspan="1" %)(% colspan="1" %)
457 457  (((
458 -
762 +false
459 459  )))
460 460  |(% colspan="1" %)(% colspan="1" %)
461 461  (((
462 -Size Constraint
766 +Scale Factor
463 463  )))|(% colspan="1" %)(% colspan="1" %)
464 464  (((
465 -de.cau.cs.kieler.sizeConstraint
769 +de.cau.cs.kieler.scaleFactor
466 466  )))|(% colspan="1" %)(% colspan="1" %)
467 467  (((
468 -EnumSet
772 +Float
469 469  )))|(% colspan="1" %)(% colspan="1" %)
470 470  (((
471 471  Nodes
472 472  )))|(% colspan="1" %)(% colspan="1" %)
473 473  (((
474 -
778 +1.0
475 475  )))
476 476  |(% colspan="1" %)(% colspan="1" %)
477 477  (((
478 -Size Options
782 +Thickness
479 479  )))|(% colspan="1" %)(% colspan="1" %)
480 480  (((
481 -de.cau.cs.kieler.sizeOptions
785 +de.cau.cs.kieler.thickness
482 482  )))|(% colspan="1" %)(% colspan="1" %)
483 483  (((
484 -EnumSet
788 +Float
485 485  )))|(% colspan="1" %)(% colspan="1" %)
486 486  (((
487 -Nodes
791 +Edges
488 488  )))|(% colspan="1" %)(% colspan="1" %)
489 489  (((
490 -DEFAULT_MINIMUM_SIZE
794 +1.0
491 491  )))
492 492  |(% colspan="1" %)(% colspan="1" %)
493 493  (((
494 -Spacing
798 +Zoom to Fit
495 495  )))|(% colspan="1" %)(% colspan="1" %)
496 496  (((
497 -de.cau.cs.kieler.spacing
801 +de.cau.cs.kieler.zoomToFit
498 498  )))|(% colspan="1" %)(% colspan="1" %)
499 499  (((
500 -Float
804 +Boolean
501 501  )))|(% colspan="1" %)(% colspan="1" %)
502 502  (((
503 503  Parents
504 504  )))|(% colspan="1" %)(% colspan="1" %)
505 505  (((
506 --1.0
810 +false
507 507  )))
508 508  
509 -= The Most Important Options =
813 +=== 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.
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
512 512  
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 +
513 513  = Detailed Documentation =
514 514  
515 515  This section explains every layout option in more detail.
516 516  
517 -== Port Offset ==
851 +== The Most Important Options ==
518 518  
519 -{{id name="portOffset"/}}
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.
520 520  
521 -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.
855 +=== ===
522 522  
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.
858 +
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.
860 +
861 +[[image:attach:layout_algorithm.png]]
862 +
863 +==== Available Algorithms and Libraries ====
864 +
865 +* **The [[KLay Project>>doc:KIELER.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:KIELER.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:KIELER.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:KIELER.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 +
899 +* POLYLINE
900 +Edges consist of one or more segments defined by a list of bend points.
901 +* ORTHOGONAL
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).
905 +* UNDEFINED
906 +No particular edge routing style is selected. Usually this value points to the default setting of the selected layout algorithm.
907 +
908 +[[image:attach:edge_routing.png]]
909 +
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:
911 +
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.
921 +
922 +== Other Options ==
923 +
924 +=== ===
925 +
926 +{{id name="addPortSpace"/}}Additional Port SpaceThis option controls the usable space for ports on each side:
927 +
928 +[[image:attach:addPortSpace.png]]
929 +
930 +If the option is not set, the value of [[Port Spacing>>doc:||anchor="portSpacing"]] is used instead for all four components.
931 +
932 +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.
933 +
934 +=== ===
935 +
936 +{{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.
937 +
938 +=== ===
939 +
940 +{{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.
941 +
942 +=== ===
943 +
944 +{{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.
945 +
946 +[[image:attach:comment_box.png]]
947 +
948 +=== ===
949 +
950 +{{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.
951 +
952 +=== ===
953 +
954 +{{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.
955 +
956 +=== ===
957 +
958 +{{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.
959 +
960 +=== ===
961 +
962 +{{id name="portAlignment"/}}Port AlignmentThe port alignment controls how ports are distributed over their respective edge.
963 +
964 +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}}.
965 +
966 +The following settings are possible:
967 +
968 +* {{code language="none"}}UNDEFINED{{/code}}
969 +Defaults to {{code language="none"}}JUSTIFIED{{/code}}.
970 +* {{code language="none"}}JUSTIFIED{{/code}}
971 +Distributes the ports evenly over the whole usable space (for usable space, see [[additional port space>>doc:||anchor="addPortSpace"]]).
972 +* {{code language="none"}}BEGIN{{/code}}
973 +Places the ports at top-/leftmost position with [[port spacing>>doc:||anchor="portSpacing"]] between them.
974 +* {{code language="none"}}CENTER{{/code}}
975 +Places the ports centered in the usable space with port spacing between them.
976 +* {{code language="none"}}END{{/code}}
977 +Places the ports at bottom-/rightmost position with port spacing between them.
978 +
979 +Port alignment can also be set as specialized options {{code language="none"}}portAlignment.{north|south|east|west{{/code}}}. These options overwrite the general policy for the respective side. Setting one of these to {{code language="none"}}UNDEFINED{{/code}} defaults it to the general port alignment.
980 +
981 +=== ===
982 +
983 +{{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.
984 +
985 +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:
986 +
987 +[[image:attach:KIELER.KLay Layered Layout Options@port_anchors.png]]
988 +
989 +=== ===
990 +
991 +{{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.
992 +
523 523  Set this property if one of the following cases applies:
524 524  
525 525  * The port constraints on a node are set to FREE, FIXED_SIDES or FIXED_ORDER.
526 526  * 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.)
997 +
998 +=== ===
999 +
1000 +{{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}}.
addPortSpace.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +20.2 KB
Content
comment_box.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +5.5 KB
Content
edge_routing.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +57.8 KB
Content
layout_algorithm.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +20.0 KB
Content
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -7111110
1 +7111094
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/7111110/KIML Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/7111094/KIML Layout Options