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 1.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
... ... @@ -2,12 +2,14 @@
2 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  
9 -
10 10  
10 +
11 +{{toc/}}
12 +
11 11  = Overview =
12 12  
13 13  Beside a human-readable name, layout options are defined by the following properties:
... ... @@ -14,7 +14,7 @@
14 14  
15 15  * An ID to identify them.
16 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.
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.
18 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.
19 19  
20 20  KIML defines the following set of layout options:
... ... @@ -85,7 +85,7 @@
85 85  Boolean
86 86  )))|(% colspan="1" %)(% colspan="1" %)
87 87  (((
88 -Nodes
90 +
89 89  )))|(% colspan="1" %)(% colspan="1" %)
90 90  (((
91 91  false
... ... @@ -139,7 +139,7 @@
139 139  Enum
140 140  )))|(% colspan="1" %)(% colspan="1" %)
141 141  (((
142 -Labels
144 +
143 143  )))|(% colspan="1" %)(% colspan="1" %)
144 144  (((
145 145  UNDEFINED
... ... @@ -166,7 +166,7 @@
166 166  Enum
167 167  )))|(% colspan="1" %)(% colspan="1" %)
168 168  (((
169 -Edges
171 +
170 170  )))|(% colspan="1" %)(% colspan="1" %)
171 171  (((
172 172  NONE
... ... @@ -193,7 +193,7 @@
193 193  String
194 194  )))|(% colspan="1" %)(% colspan="1" %)
195 195  (((
196 -Labels
198 +
197 197  )))|(% colspan="1" %)(% colspan="1" %)
198 198  (((
199 199  
... ... @@ -209,7 +209,7 @@
209 209  Int
210 210  )))|(% colspan="1" %)(% colspan="1" %)
211 211  (((
212 -Labels
214 +
213 213  )))|(% colspan="1" %)(% colspan="1" %)
214 214  (((
215 215  
... ... @@ -225,7 +225,7 @@
225 225  Boolean
226 226  )))|(% colspan="1" %)(% colspan="1" %)
227 227  (((
228 -Nodes
230 +
229 229  )))|(% colspan="1" %)(% colspan="1" %)
230 230  (((
231 231  false
... ... @@ -286,8 +286,7 @@
286 286  Float
287 287  )))|(% colspan="1" %)(% colspan="1" %)
288 288  (((
289 -Nodes
290 -Parents
291 +
291 291  )))|(% colspan="1" %)(% colspan="1" %)
292 292  (((
293 293  0.0
... ... @@ -303,8 +303,7 @@
303 303  Float
304 304  )))|(% colspan="1" %)(% colspan="1" %)
305 305  (((
306 -Nodes
307 -Parents
307 +
308 308  )))|(% colspan="1" %)(% colspan="1" %)
309 309  (((
310 310  0.0
... ... @@ -370,7 +370,7 @@
370 370  )))
371 371  |(% colspan="1" %)(% colspan="1" %)
372 372  (((
373 -[[Port Offset>>doc:||anchor="portOffset"]]
373 +Port Offset
374 374  )))|(% colspan="1" %)(% colspan="1" %)
375 375  (((
376 376  de.cau.cs.kieler.offset
... ... @@ -379,7 +379,7 @@
379 379  Float
380 380  )))|(% colspan="1" %)(% colspan="1" %)
381 381  (((
382 -Ports
382 +
383 383  )))|(% colspan="1" %)(% colspan="1" %)
384 384  (((
385 385  
... ... @@ -395,7 +395,7 @@
395 395  Enum
396 396  )))|(% colspan="1" %)(% colspan="1" %)
397 397  (((
398 -Ports
398 +
399 399  )))|(% colspan="1" %)(% colspan="1" %)
400 400  (((
401 401  UNDEFINED
... ... @@ -514,13 +514,6 @@
514 514  
515 515  This section explains every layout option in more detail.
516 516  
517 -== Port Offset ==
517 +== Port Offset ==
518 518  
519 -{{id name="portOffset"/}}
520 -
521 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.
522 -
523 -Set this property if one of the following cases applies:
524 -
525 -* The port constraints on a node are set to FREE, FIXED_SIDES or FIXED_ORDER.
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.)
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -7111110
1 +7111096
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/7111096/Layout Options