| ... |
... |
@@ -1,5 +1,5 @@ |
| 1 |
1 |
{{warning}} |
| 2 |
|
-This is preliminary documentation. You've been warned. |
|
2 |
+This is preliminary and incomplete documentation. You've been warned. |
| 3 |
3 |
{{/warning}} |
| 4 |
4 |
|
| 5 |
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. |
| ... |
... |
@@ -372,7 +372,7 @@ |
| 372 |
372 |
))) |
| 373 |
373 |
|(% colspan="1" %)(% colspan="1" %) |
| 374 |
374 |
((( |
| 375 |
|
-Port Offset |
|
375 |
+[[Port Offset>>doc:||anchor="portOffset"]] |
| 376 |
376 |
)))|(% colspan="1" %)(% colspan="1" %) |
| 377 |
377 |
((( |
| 378 |
378 |
de.cau.cs.kieler.offset |
| ... |
... |
@@ -516,8 +516,29 @@ |
| 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 |
+ |
| 519 |
519 |
== Port Offset == |
| 520 |
520 |
|
|
538 |
+ |
|
539 |
+ |
|
540 |
+{{id name="portOffset"/}} |
|
541 |
+ |
| 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 |
522 |
|
| 523 |
523 |
Set this property if one of the following cases applies: |