Changes for page KIML Layout Options
Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -2,25 +2,29 @@ 2 2 This is preliminary and incomplete 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 fora givenlayout 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. 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/}} 11 +{{toc maxLevel="2"/}} 12 12 13 13 = Overview = 14 14 15 -Beside a human-readablename, layout options are defined by the following properties:15 +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,andLabels.20 -* An optional default value. If anoptionisnotset onanobjectandifthe optiondoesnothaveadefaultvalue, {{code language="none"}}null{{/code}}isreturnedwhenitisaccessed.18 +* 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. 19 +* 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. 20 +* 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 - KIMLdefinesthefollowing setoflayout options:22 +Layout options can be assigned to two main categories: user options and programmatic options. 23 23 24 +== User Options == 25 + 26 +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. 27 + 24 24 |=((( 25 25 Option 26 26 )))|=((( ... ... @@ -74,29 +74,46 @@ 74 74 )))|((( 75 75 Parents 76 76 )))|((( 77 - -1.081 + 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 -((( 83 +|((( 84 +Debug Mode 85 +)))|((( 86 +de.cau.cs.kieler.debugMode 87 +)))|((( 87 87 Boolean 88 -)))|(% colspan="1" %)(% colspan="1" %) 89 -((( 90 -Nodes 91 -)))|(% colspan="1" %)(% colspan="1" %) 92 -((( 89 +)))|((( 90 +Parents 91 +)))|((( 93 93 false 94 94 ))) 95 95 |((( 96 -De bug Mode95 +Direction 97 97 )))|((( 98 -de.cau.cs.kieler.de bugMode97 +de.cau.cs.kieler.direction 99 99 )))|((( 99 +Enum 100 +)))|((( 101 +Parents 102 +)))|((( 103 + 104 +))) 105 +|((( 106 +[[Edge Routing>>doc:||anchor="edgeRouting"]] 107 +)))|((( 108 +de.cau.cs.kieler.edgeRouting 109 +)))|((( 110 +Enum 111 +)))|((( 112 +Parents 113 +)))|((( 114 + 115 +))) 116 +|((( 117 +Expand Nodes 118 +)))|((( 119 +de.cau.cs.kieler.expandNodes 120 +)))|((( 100 100 Boolean 101 101 )))|((( 102 102 Parents ... ... @@ -103,99 +103,179 @@ 103 103 )))|((( 104 104 false 105 105 ))) 127 +|((( 128 +Interactive 129 +)))|((( 130 +de.cau.cs.kieler.interactive 131 +)))|((( 132 +Boolean 133 +)))|((( 134 +Parents 135 +)))|((( 136 +false 137 +))) 138 +|((( 139 +Label Spacing 140 +)))|((( 141 +de.cau.cs.kieler.labelSpacing 142 +)))|((( 143 +Float 144 +)))|((( 145 +Edges 146 +Nodes 147 +)))|((( 148 + 149 +))) 150 +|((( 151 +Layout Hierarchy 152 +)))|((( 153 +de.cau.cs.kieler.layoutHierarchy 154 +)))|((( 155 +Boolean 156 +)))|((( 157 +Parents 158 +)))|((( 159 +false 160 +))) 161 +|((( 162 +[[Layout Algorithm>>doc:||anchor="layoutAlgorithm"]] 163 +)))|((( 164 +de.cau.cs.kieler.algorithm 165 +)))|((( 166 +String 167 +)))|((( 168 +Parents 169 +)))|((( 170 + 171 +))) 106 106 |(% colspan="1" %)(% colspan="1" %) 107 107 ((( 108 - [[Diagram Type>>doc:||anchor="diagramType"]]174 +Node Label Placement 109 109 )))|(% colspan="1" %)(% colspan="1" %) 110 110 ((( 111 -de.cau.cs.kieler.d iagramType177 +de.cau.cs.kieler.nodeLabelPlacement 112 112 )))|(% colspan="1" %)(% colspan="1" %) 113 113 ((( 114 -St ring180 +EnumSet 115 115 )))|(% colspan="1" %)(% colspan="1" %) 116 116 ((( 117 - 183 +Nodes 118 118 )))|(% colspan="1" %)(% colspan="1" %) 119 119 ((( 120 120 121 121 ))) 122 122 |((( 123 - Direction189 +Port Constraints 124 124 )))|((( 125 -de.cau.cs.kieler. direction191 +de.cau.cs.kieler.portConstraints 126 126 )))|((( 127 127 Enum 128 128 )))|((( 129 - Parents195 +Nodes 130 130 )))|((( 131 - UNDEFINED197 + 132 132 ))) 133 133 |(% colspan="1" %)(% colspan="1" %) 134 134 ((( 135 - EdgeLabel Placement201 +Port Label Placement 136 136 )))|(% colspan="1" %)(% colspan="1" %) 137 137 ((( 138 -de.cau.cs.kieler. edgeLabelPlacement204 +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 - Labels210 +Nodes 145 145 )))|(% colspan="1" %)(% colspan="1" %) 146 146 ((( 147 -U NDEFINED213 +OUTSIDE 148 148 ))) 215 +|(% colspan="1" %)(% colspan="1" %) 216 +((( 217 +Port Spacing 218 +)))|(% colspan="1" %)(% colspan="1" %) 219 +((( 220 +de.cau.cs.kieler.portSpacing 221 +)))|(% colspan="1" %)(% colspan="1" %) 222 +((( 223 +Float 224 +)))|(% colspan="1" %)(% colspan="1" %) 225 +((( 226 +Nodes 227 +)))|(% colspan="1" %)(% colspan="1" %) 228 +((( 229 + 230 +))) 149 149 |((( 150 - [[Edge Routing>>doc:||anchor="edgeRouting"]]232 +Position 151 151 )))|((( 152 -de.cau.cs.kieler. edgeRouting234 +de.cau.cs.kieler.position 153 153 )))|((( 154 - Enum236 +Object 155 155 )))|((( 156 -Parents 238 +Labels 239 +Nodes 240 +Ports 157 157 )))|((( 158 - UNDEFINED242 + 159 159 ))) 244 +|((( 245 +Priority 246 +)))|((( 247 +de.cau.cs.kieler.priority 248 +)))|((( 249 +Int 250 +)))|((( 251 +Edges 252 +Nodes 253 +)))|((( 254 + 255 +))) 160 160 |(% colspan="1" %)(% colspan="1" %) 161 161 ((( 162 - EdgeType258 +Randomization Seed 163 163 )))|(% colspan="1" %)(% colspan="1" %) 164 164 ((( 165 -de.cau.cs.kieler. edgeType261 +de.cau.cs.kieler.randomSeed 166 166 )))|(% colspan="1" %)(% colspan="1" %) 167 167 ((( 168 - Enum264 +Int 169 169 )))|(% colspan="1" %)(% colspan="1" %) 170 170 ((( 171 - Edges267 +Parents 172 172 )))|(% colspan="1" %)(% colspan="1" %) 173 173 ((( 174 - NONE270 + 175 175 ))) 176 -|((( 177 -Expand Nodes 178 -)))|((( 179 -de.cau.cs.kieler.expandNodes 180 -)))|((( 272 +|(% colspan="1" %)(% colspan="1" %) 273 +((( 274 +Separate Connected Components 275 +)))|(% colspan="1" %)(% colspan="1" %) 276 +((( 277 +de.cau.cs.kieler.separateConnComp 278 +)))|(% colspan="1" %)(% colspan="1" %) 279 +((( 181 181 Boolean 182 -)))|((( 281 +)))|(% colspan="1" %)(% colspan="1" %) 282 +((( 183 183 Parents 184 -)))|((( 185 -false 284 +)))|(% colspan="1" %)(% colspan="1" %) 285 +((( 286 + 186 186 ))) 187 187 |(% colspan="1" %)(% colspan="1" %) 188 188 ((( 189 - FontName290 +Size Constraint 190 190 )))|(% colspan="1" %)(% colspan="1" %) 191 191 ((( 192 -de.cau.cs.kieler. fontName293 +de.cau.cs.kieler.sizeConstraint 193 193 )))|(% colspan="1" %)(% colspan="1" %) 194 194 ((( 195 -St ring296 +EnumSet 196 196 )))|(% colspan="1" %)(% colspan="1" %) 197 197 ((( 198 - Labels299 +Nodes 199 199 )))|(% colspan="1" %)(% colspan="1" %) 200 200 ((( 201 201 ... ... @@ -202,31 +202,95 @@ 202 202 ))) 203 203 |(% colspan="1" %)(% colspan="1" %) 204 204 ((( 205 - FontSize306 +Size Options 206 206 )))|(% colspan="1" %)(% colspan="1" %) 207 207 ((( 208 -de.cau.cs.kieler. fontSize309 +de.cau.cs.kieler.sizeOptions 209 209 )))|(% colspan="1" %)(% colspan="1" %) 210 210 ((( 211 - Int312 +EnumSet 212 212 )))|(% colspan="1" %)(% colspan="1" %) 213 213 ((( 214 - Labels315 +Nodes 215 215 )))|(% colspan="1" %)(% colspan="1" %) 216 216 ((( 318 +DEFAULT_MINIMUM_SIZE 319 +))) 320 +|(% colspan="1" %)(% colspan="1" %) 321 +((( 322 +Spacing 323 +)))|(% colspan="1" %)(% colspan="1" %) 324 +((( 325 +de.cau.cs.kieler.spacing 326 +)))|(% colspan="1" %)(% colspan="1" %) 327 +((( 328 +Float 329 +)))|(% colspan="1" %)(% colspan="1" %) 330 +((( 331 +Parents 332 +)))|(% colspan="1" %)(% colspan="1" %) 333 +((( 217 217 218 218 ))) 336 + 337 +== Programmatic Options == 338 + 339 +Programmatic options are such that are meant to be configured exclusively through the KIML API. They should not be visible in the user interface. 340 + 341 +|=((( 342 +Option 343 +)))|=((( 344 +ID 345 +)))|=((( 346 +Type 347 +)))|=((( 348 +Applies to 349 +)))|=((( 350 +Default 351 +))) 219 219 |(% colspan="1" %)(% colspan="1" %) 220 220 ((( 221 - Hypernode354 +Animate 222 222 )))|(% colspan="1" %)(% colspan="1" %) 223 223 ((( 224 -de.cau.cs.kieler. hypernode357 +de.cau.cs.kieler.animate 225 225 )))|(% colspan="1" %)(% colspan="1" %) 226 226 ((( 227 227 Boolean 228 228 )))|(% colspan="1" %)(% colspan="1" %) 229 229 ((( 363 +Parents 364 +)))|(% colspan="1" %)(% colspan="1" %) 365 +((( 366 +true 367 +))) 368 +|(% colspan="1" %)(% colspan="1" %) 369 +((( 370 +Animation Time Factor 371 +)))|(% colspan="1" %)(% colspan="1" %) 372 +((( 373 +de.cau.cs.kieler.animTimeFactor 374 +)))|(% colspan="1" %)(% colspan="1" %) 375 +((( 376 +Int 377 +)))|(% colspan="1" %)(% colspan="1" %) 378 +((( 379 +Parents 380 +)))|(% colspan="1" %)(% colspan="1" %) 381 +((( 382 +100 383 +))) 384 +|(% colspan="1" %)(% colspan="1" %) 385 +((( 386 +Comment Box 387 +)))|(% colspan="1" %)(% colspan="1" %) 388 +((( 389 +de.cau.cs.kieler.commentBox 390 +)))|(% colspan="1" %)(% colspan="1" %) 391 +((( 392 +Boolean 393 +)))|(% colspan="1" %)(% colspan="1" %) 394 +((( 230 230 Nodes 231 231 )))|(% colspan="1" %)(% colspan="1" %) 232 232 ((( ... ... @@ -233,96 +233,103 @@ 233 233 false 234 234 ))) 235 235 |((( 236 - Interactive401 +[[Diagram Type>>doc:||anchor="diagramType"]] 237 237 )))|((( 238 -de.cau.cs.kieler.i nteractive403 +de.cau.cs.kieler.diagramType 239 239 )))|((( 240 - Boolean405 +String 241 241 )))|((( 242 242 Parents 243 243 )))|((( 244 - false409 + 245 245 ))) 246 246 |((( 247 -Label Spacing412 +Edge Label Placement 248 248 )))|((( 249 -de.cau.cs.kieler. labelSpacing414 +de.cau.cs.kieler.edgeLabelPlacement 250 250 )))|((( 251 - Float416 +Enum 252 252 )))|((( 253 -Edges 254 -Nodes 418 +Labels 255 255 )))|((( 256 - -1.0420 + 257 257 ))) 258 -|((( 259 -Layout Hierarchy 260 -)))|((( 261 -de.cau.cs.kieler.layoutHierarchy 262 -)))|((( 263 -Boolean 264 -)))|((( 265 -Parents 266 -)))|((( 267 -false 422 +|(% colspan="1" %)(% colspan="1" %) 423 +((( 424 +Edge Type 425 +)))|(% colspan="1" %)(% colspan="1" %) 426 +((( 427 +de.cau.cs.kieler.edgeType 428 +)))|(% colspan="1" %)(% colspan="1" %) 429 +((( 430 +Enum 431 +)))|(% colspan="1" %)(% colspan="1" %) 432 +((( 433 +Edges 434 +)))|(% colspan="1" %)(% colspan="1" %) 435 +((( 436 +NONE 268 268 ))) 269 -|((( 270 -[[Layout Algorithm>>doc:||anchor="layoutAlgorithm"]] 271 -)))|((( 272 -de.cau.cs.kieler.algorithm 273 -)))|((( 438 +|(% colspan="1" %)(% colspan="1" %) 439 +((( 440 +Font Name 441 +)))|(% colspan="1" %)(% colspan="1" %) 442 +((( 443 +de.cau.cs.kieler.fontName 444 +)))|(% colspan="1" %)(% colspan="1" %) 445 +((( 274 274 String 275 -)))|((( 276 -Parents 277 -)))|((( 447 +)))|(% colspan="1" %)(% colspan="1" %) 448 +((( 449 +Labels 450 +)))|(% colspan="1" %)(% colspan="1" %) 451 +((( 278 278 279 279 ))) 280 280 |(% colspan="1" %)(% colspan="1" %) 281 281 ((( 282 - MinimalHeight456 +Font Size 283 283 )))|(% colspan="1" %)(% colspan="1" %) 284 284 ((( 285 -de.cau.cs.kieler. minHeight459 +de.cau.cs.kieler.fontSize 286 286 )))|(% colspan="1" %)(% colspan="1" %) 287 287 ((( 288 - Float462 +Int 289 289 )))|(% colspan="1" %)(% colspan="1" %) 290 290 ((( 291 -Nodes 292 -Parents 465 +Labels 293 293 )))|(% colspan="1" %)(% colspan="1" %) 294 294 ((( 295 - 0.0468 + 296 296 ))) 297 297 |(% colspan="1" %)(% colspan="1" %) 298 298 ((( 299 - Minimal Width472 +Hypernode 300 300 )))|(% colspan="1" %)(% colspan="1" %) 301 301 ((( 302 -de.cau.cs.kieler. minWidth475 +de.cau.cs.kieler.hypernode 303 303 )))|(% colspan="1" %)(% colspan="1" %) 304 304 ((( 305 - Float478 +Boolean 306 306 )))|(% colspan="1" %)(% colspan="1" %) 307 307 ((( 308 308 Nodes 309 -Parents 310 310 )))|(% colspan="1" %)(% colspan="1" %) 311 311 ((( 312 - 0.0484 +false 313 313 ))) 314 314 |(% colspan="1" %)(% colspan="1" %) 315 315 ((( 316 - NoLayout488 +Layout Ancestors 317 317 )))|(% colspan="1" %)(% colspan="1" %) 318 318 ((( 319 -de.cau.cs.kieler. noLayout491 +de.cau.cs.kieler.layoutAncestors 320 320 )))|(% colspan="1" %)(% colspan="1" %) 321 321 ((( 322 322 Boolean 323 323 )))|(% colspan="1" %)(% colspan="1" %) 324 324 ((( 325 - 497 +Parents 326 326 )))|(% colspan="1" %)(% colspan="1" %) 327 327 ((( 328 328 false ... ... @@ -329,116 +329,114 @@ 329 329 ))) 330 330 |(% colspan="1" %)(% colspan="1" %) 331 331 ((( 332 - Node LabelPlacement504 +Maximal Animation Time 333 333 )))|(% colspan="1" %)(% colspan="1" %) 334 334 ((( 335 -de.cau.cs.kieler. nodeLabelPlacement507 +de.cau.cs.kieler.maxAnimTim 336 336 )))|(% colspan="1" %)(% colspan="1" %) 337 337 ((( 338 - EnumSet510 +Int 339 339 )))|(% colspan="1" %)(% colspan="1" %) 340 340 ((( 341 - Nodes513 +Parents 342 342 )))|(% colspan="1" %)(% colspan="1" %) 343 343 ((( 344 - 516 +4000 345 345 ))) 346 -|((( 347 -Port Constraints 348 -)))|((( 349 -de.cau.cs.kieler.portConstraints 350 -)))|((( 351 -Enum 352 -)))|((( 353 -Nodes 354 -)))|((( 355 -UNDEFINED 518 +|(% colspan="1" %)(% colspan="1" %) 519 +((( 520 +Minimal Animation Time 521 +)))|(% colspan="1" %)(% colspan="1" %) 522 +((( 523 +de.cau.cs.kieler.minAnimTim 524 +)))|(% colspan="1" %)(% colspan="1" %) 525 +((( 526 +Int 527 +)))|(% colspan="1" %)(% colspan="1" %) 528 +((( 529 +Parents 530 +)))|(% colspan="1" %)(% colspan="1" %) 531 +((( 532 +400 356 356 ))) 357 357 |(% colspan="1" %)(% colspan="1" %) 358 358 ((( 359 - Port LabelPlacement536 +Minimal Height 360 360 )))|(% colspan="1" %)(% colspan="1" %) 361 361 ((( 362 -de.cau.cs.kieler. portLabelPlacement539 +de.cau.cs.kieler.minHeight 363 363 )))|(% colspan="1" %)(% colspan="1" %) 364 364 ((( 365 - Enum542 +Float 366 366 )))|(% colspan="1" %)(% colspan="1" %) 367 367 ((( 368 368 Nodes 546 +Parents 369 369 )))|(% colspan="1" %)(% colspan="1" %) 370 370 ((( 371 - OUTSIDE549 +0.0 372 372 ))) 373 373 |(% colspan="1" %)(% colspan="1" %) 374 374 ((( 375 - [[PortOffset>>doc:||anchor="portOffset"]]553 +Minimal Width 376 376 )))|(% colspan="1" %)(% colspan="1" %) 377 377 ((( 378 -de.cau.cs.kieler. offset556 +de.cau.cs.kieler.minWidth 379 379 )))|(% colspan="1" %)(% colspan="1" %) 380 380 ((( 381 381 Float 382 382 )))|(% colspan="1" %)(% colspan="1" %) 383 383 ((( 384 -Ports 562 +Nodes 563 +Parents 385 385 )))|(% colspan="1" %)(% colspan="1" %) 386 386 ((( 387 - 566 +0.0 388 388 ))) 389 389 |(% colspan="1" %)(% colspan="1" %) 390 390 ((( 391 - PortSide570 +No Layout 392 392 )))|(% colspan="1" %)(% colspan="1" %) 393 393 ((( 394 -de.cau.cs.kieler. portSide573 +de.cau.cs.kieler.noLayout 395 395 )))|(% colspan="1" %)(% colspan="1" %) 396 396 ((( 397 - Enum576 +Boolean 398 398 )))|(% colspan="1" %)(% colspan="1" %) 399 399 ((( 400 - Ports579 + 401 401 )))|(% colspan="1" %)(% colspan="1" %) 402 402 ((( 403 - UNDEFINED582 +false 404 404 ))) 405 -|((( 406 -Position 407 -)))|((( 408 -de.cau.cs.kieler.position 409 -)))|((( 410 -Object 411 -)))|((( 412 -Labels 413 -Nodes 584 +|(% colspan="1" %)(% colspan="1" %) 585 +((( 586 +Port Index 587 +)))|(% colspan="1" %)(% colspan="1" %) 588 +((( 589 +de.cau.cs.kieler.portIndex 590 +)))|(% colspan="1" %)(% colspan="1" %) 591 +((( 592 +Int 593 +)))|(% colspan="1" %)(% colspan="1" %) 594 +((( 414 414 Ports 415 -)))|((( 596 +)))|(% colspan="1" %)(% colspan="1" %) 597 +((( 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 - RandomizationSeed602 +[[Port Offset>>doc:||anchor="portOffset"]] 433 433 )))|(% colspan="1" %)(% colspan="1" %) 434 434 ((( 435 -de.cau.cs.kieler. randomSeed605 +de.cau.cs.kieler.offset 436 436 )))|(% colspan="1" %)(% colspan="1" %) 437 437 ((( 438 - Int608 +Float 439 439 )))|(% colspan="1" %)(% colspan="1" %) 440 440 ((( 441 -P arents611 +Ports 442 442 )))|(% colspan="1" %)(% colspan="1" %) 443 443 ((( 444 444 ... ... @@ -445,16 +445,16 @@ 445 445 ))) 446 446 |(% colspan="1" %)(% colspan="1" %) 447 447 ((( 448 - SeparateConnectedComponents618 +Port Side 449 449 )))|(% colspan="1" %)(% colspan="1" %) 450 450 ((( 451 -de.cau.cs.kieler. separateConnComp621 +de.cau.cs.kieler.portSide 452 452 )))|(% colspan="1" %)(% colspan="1" %) 453 453 ((( 454 - Boolean624 +Enum 455 455 )))|(% colspan="1" %)(% colspan="1" %) 456 456 ((( 457 -P arents627 +Ports 458 458 )))|(% colspan="1" %)(% colspan="1" %) 459 459 ((( 460 460 ... ... @@ -461,61 +461,95 @@ 461 461 ))) 462 462 |(% colspan="1" %)(% colspan="1" %) 463 463 ((( 464 - Size Constraint634 +Progress Bar 465 465 )))|(% colspan="1" %)(% colspan="1" %) 466 466 ((( 467 -de.cau.cs.kieler. sizeConstraint637 +de.cau.cs.kieler.progressBar 468 468 )))|(% colspan="1" %)(% colspan="1" %) 469 469 ((( 470 - EnumSet640 +Boolean 471 471 )))|(% colspan="1" %)(% colspan="1" %) 472 472 ((( 473 - Nodes643 +Parents 474 474 )))|(% colspan="1" %)(% colspan="1" %) 475 475 ((( 476 - 646 +false 477 477 ))) 478 478 |(% colspan="1" %)(% colspan="1" %) 479 479 ((( 480 -S izeOptions650 +Scale Factor 481 481 )))|(% colspan="1" %)(% colspan="1" %) 482 482 ((( 483 -de.cau.cs.kieler.s izeOptions653 +de.cau.cs.kieler.scaleFactor 484 484 )))|(% colspan="1" %)(% colspan="1" %) 485 485 ((( 486 - EnumSet656 +Float 487 487 )))|(% colspan="1" %)(% colspan="1" %) 488 488 ((( 489 489 Nodes 490 490 )))|(% colspan="1" %)(% colspan="1" %) 491 491 ((( 492 - DEFAULT_MINIMUM_SIZE662 +1.0 493 493 ))) 494 494 |(% colspan="1" %)(% colspan="1" %) 495 495 ((( 496 - Spacing666 +Zoom to Fit 497 497 )))|(% colspan="1" %)(% colspan="1" %) 498 498 ((( 499 -de.cau.cs.kieler. spacing669 +de.cau.cs.kieler.zoomToFit 500 500 )))|(% colspan="1" %)(% colspan="1" %) 501 501 ((( 502 - Float672 +Boolean 503 503 )))|(% colspan="1" %)(% colspan="1" %) 504 504 ((( 505 505 Parents 506 506 )))|(% colspan="1" %)(% colspan="1" %) 507 507 ((( 508 - -1.0678 +false 509 509 ))) 510 510 511 -= The MostImportantOptions =681 +=== Layout Output Properties === 512 512 513 - Whilemost layout options are used toaffecthowtheactivelayout algorithmcomputesconcretecoordinatesforthegraphelements,thereare somelayoutoptionsthat havea specialrolein KIML.683 +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 515 -== Layout Algorithm == 685 +|=((( 686 +Property 687 +)))|=((( 688 +ID 689 +)))|=((( 690 +Type 691 +)))|=((( 692 +Applies to 693 +))) 694 +|((( 695 +[[Edge Routing>>doc:||anchor="edgeRouting"]] 696 +)))|((( 697 +de.cau.cs.kieler.edgeRouting 698 +)))|((( 699 +Enum 700 +)))|((( 701 +Edges 702 +))) 703 +|((( 704 +Junction Points 705 +)))|((( 706 +de.cau.cs.kieler.junctionPoints 707 +)))|((( 708 +Object 709 +)))|((( 710 +Edges 711 +))) 516 516 713 + 517 517 715 += Detailed Documentation = 518 518 717 +== The Most Important Options == 718 + 719 +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. 720 + 721 +=== Layout Algorithm === 722 + 519 519 {{id name="layoutAlgorithm"/}} 520 520 521 521 The option with identifier {{code language="none"}}de.cau.cs.kieler.algorithm{{/code}} specifies which layout algorithm to use for the content of a composite node. 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. ... ... @@ -539,10 +539,8 @@ 539 539 * **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. 540 540 * **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. 541 541 542 -== Diagram Type == 746 +=== Diagram Type === 543 543 544 - 545 - 546 546 {{id name="diagramType"/}} 547 547 548 548 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. ... ... @@ -563,14 +563,10 @@ 563 563 * **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. 564 564 * **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. 565 565 566 -= Detailed Documentation = 567 - 568 568 This section explains every layout option in more detail. 569 569 570 -== Edge Routing == 770 +=== Edge Routing === 571 571 572 - 573 - 574 574 {{id name="edgeRouting"/}} 575 575 576 576 This option influences the way in which edges are routed between the nodes they connect. The following settings are available: ... ... @@ -586,10 +586,8 @@ 586 586 587 587 (% style="color: rgb(153,51,0);" %)**TODO:** Add an image illustrating the different routing styles. 588 588 589 -== Port Offset == 787 +=== Port Offset === 590 590 591 - 592 - 593 593 {{id name="portOffset"/}} 594 594 595 595 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.
- Confluence.Code.ConfluencePageClass[0]
-
- Id
-
... ... @@ -1,1 +1,1 @@ 1 -94700 041 +9470012 - URL
-
... ... @@ -1,1 +1,1 @@ 1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/94700 04/KIML Layout Options1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470012/KIML Layout Options