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 2.1
edited by cds
on 2013/05/31 20:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -KIML Layout Options
1 +Layout Options
Content
... ... @@ -1,8 +1,8 @@
1 1  {{warning}}
2 -This is preliminary and incomplete documentation. You've been warned.
2 +This is preliminary documentation. You've been warned.
3 3  {{/warning}}
4 4  
5 -KIML defines a whole set of standard layout options that many layout algorithms support. Whether an algorithm supports a layout option depends on the option and on the algorithm. When an option is supported by an algorithm, it may change the option's default value. Algorithms may also provide more specialized documentation for a given layout option.
5 +KIML defines a whole set of standard layout options that many layout algorithms support. Whether an algorithm supports a layout option depends on the option and on the algorithm. Algorithms may provide more specialized documentation for a given layout option.
6 6  
7 7  **Contents**
8 8  
... ... @@ -16,7 +16,7 @@
16 16  
17 17  * An ID to identify them.
18 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.
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 20  * An optional default value. If an option is not set on an object and if the option does not have a default value, {{code language="none"}}null{{/code}} is returned when it is accessed.
21 21  
22 22  KIML defines the following set of layout options:
... ... @@ -87,7 +87,7 @@
87 87  Boolean
88 88  )))|(% colspan="1" %)(% colspan="1" %)
89 89  (((
90 -Nodes
90 +
91 91  )))|(% colspan="1" %)(% colspan="1" %)
92 92  (((
93 93  false
... ... @@ -141,13 +141,13 @@
141 141  Enum
142 142  )))|(% colspan="1" %)(% colspan="1" %)
143 143  (((
144 -Labels
144 +
145 145  )))|(% colspan="1" %)(% colspan="1" %)
146 146  (((
147 147  UNDEFINED
148 148  )))
149 149  |(((
150 -[[Edge Routing>>doc:||anchor="edgeRouting"]]
150 +Edge Routing
151 151  )))|(((
152 152  de.cau.cs.kieler.edgeRouting
153 153  )))|(((
... ... @@ -168,7 +168,7 @@
168 168  Enum
169 169  )))|(% colspan="1" %)(% colspan="1" %)
170 170  (((
171 -Edges
171 +
172 172  )))|(% colspan="1" %)(% colspan="1" %)
173 173  (((
174 174  NONE
... ... @@ -195,7 +195,7 @@
195 195  String
196 196  )))|(% colspan="1" %)(% colspan="1" %)
197 197  (((
198 -Labels
198 +
199 199  )))|(% colspan="1" %)(% colspan="1" %)
200 200  (((
201 201  
... ... @@ -211,7 +211,7 @@
211 211  Int
212 212  )))|(% colspan="1" %)(% colspan="1" %)
213 213  (((
214 -Labels
214 +
215 215  )))|(% colspan="1" %)(% colspan="1" %)
216 216  (((
217 217  
... ... @@ -227,7 +227,7 @@
227 227  Boolean
228 228  )))|(% colspan="1" %)(% colspan="1" %)
229 229  (((
230 -Nodes
230 +
231 231  )))|(% colspan="1" %)(% colspan="1" %)
232 232  (((
233 233  false
... ... @@ -288,8 +288,7 @@
288 288  Float
289 289  )))|(% colspan="1" %)(% colspan="1" %)
290 290  (((
291 -Nodes
292 -Parents
291 +
293 293  )))|(% colspan="1" %)(% colspan="1" %)
294 294  (((
295 295  0.0
... ... @@ -305,8 +305,7 @@
305 305  Float
306 306  )))|(% colspan="1" %)(% colspan="1" %)
307 307  (((
308 -Nodes
309 -Parents
307 +
310 310  )))|(% colspan="1" %)(% colspan="1" %)
311 311  (((
312 312  0.0
... ... @@ -372,7 +372,7 @@
372 372  )))
373 373  |(% colspan="1" %)(% colspan="1" %)
374 374  (((
375 -[[Port Offset>>doc:||anchor="portOffset"]]
373 +Port Offset
376 376  )))|(% colspan="1" %)(% colspan="1" %)
377 377  (((
378 378  de.cau.cs.kieler.offset
... ... @@ -381,7 +381,7 @@
381 381  Float
382 382  )))|(% colspan="1" %)(% colspan="1" %)
383 383  (((
384 -Ports
382 +
385 385  )))|(% colspan="1" %)(% colspan="1" %)
386 386  (((
387 387  
... ... @@ -397,7 +397,7 @@
397 397  Enum
398 398  )))|(% colspan="1" %)(% colspan="1" %)
399 399  (((
400 -Ports
398 +
401 401  )))|(% colspan="1" %)(% colspan="1" %)
402 402  (((
403 403  UNDEFINED
... ... @@ -516,34 +516,6 @@
516 516  
517 517  This section explains every layout option in more detail.
518 518  
519 -== Edge Routing ==
520 -
521 -
522 -
523 -{{id name="edgeRouting"/}}
524 -
525 -This option influences the way in which edges are routed between the nodes they connect. The following settings are available:
526 -
527 -* POLYLINE
528 -Edges consist of one or more segments defined by a list of bend points.
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.
533 -* UNDEFINED
534 -No particular edge routing style is selected. The result produced by the layout algorithm may be undefined.
535 -
536 -(% style="color: rgb(153,51,0);" %)**TODO:** Add an image illustrating the different routing styles.
537 -
538 538  == Port Offset ==
539 539  
540 -
541 -
542 -{{id name="portOffset"/}}
543 -
544 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.
545 -
546 -Set this property if one of the following cases applies:
547 -
548 -* The port constraints on a node are set to FREE, FIXED_SIDES or FIXED_ORDER.
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.)
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9469964
1 +7111096
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/7111096/Layout Options