Skip to Content

Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
From version 21.1
edited by msp
on 2014/03/08 21:51
Change comment: There is no comment for this version
To version 18.1
edited by msp
on 2014/03/07 17:04
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,8 @@
1 -
1 +{{warning}}
2 +This is preliminary and incomplete documentation. You've been warned.
3 +{{/warning}}
2 2  
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.
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.
4 4  
5 5  **Contents**
6 6  
... ... @@ -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 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.
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, or Labels.
18 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 20  Layout options can be assigned to two main categories: user options and programmatic options.
... ... @@ -146,7 +146,7 @@
146 146  
147 147  )))
148 148  |(((
149 -[[Layout Hierarchy>>doc:||anchor="layoutHierarchy"]]
151 +Layout Hierarchy
150 150  )))|(((
151 151  de.cau.cs.kieler.layoutHierarchy
152 152  )))|(((
... ... @@ -347,54 +347,6 @@
347 347  )))|=(((
348 348  Default
349 349  )))
350 -|(% colspan="1" %)(% colspan="1" %)
351 -(((
352 -Animate
353 -)))|(% colspan="1" %)(% colspan="1" %)
354 -(((
355 -de.cau.cs.kieler.animate
356 -)))|(% colspan="1" %)(% colspan="1" %)
357 -(((
358 -Boolean
359 -)))|(% colspan="1" %)(% colspan="1" %)
360 -(((
361 -Parents
362 -)))|(% colspan="1" %)(% colspan="1" %)
363 -(((
364 -true
365 -)))
366 -|(% colspan="1" %)(% colspan="1" %)
367 -(((
368 -Animation Time Factor
369 -)))|(% colspan="1" %)(% colspan="1" %)
370 -(((
371 -de.cau.cs.kieler.animTimeFactor
372 -)))|(% colspan="1" %)(% colspan="1" %)
373 -(((
374 -Int
375 -)))|(% colspan="1" %)(% colspan="1" %)
376 -(((
377 -Parents
378 -)))|(% colspan="1" %)(% colspan="1" %)
379 -(((
380 -100
381 -)))
382 -|(% colspan="1" %)(% colspan="1" %)
383 -(((
384 -[[Comment Box>>doc:||anchor="commentBox"]]
385 -)))|(% colspan="1" %)(% colspan="1" %)
386 -(((
387 -de.cau.cs.kieler.commentBox
388 -)))|(% colspan="1" %)(% colspan="1" %)
389 -(((
390 -Boolean
391 -)))|(% colspan="1" %)(% colspan="1" %)
392 -(((
393 -Nodes
394 -)))|(% colspan="1" %)(% colspan="1" %)
395 -(((
396 -false
397 -)))
398 398  |(((
399 399  [[Diagram Type>>doc:||anchor="diagramType"]]
400 400  )))|(((
... ... @@ -467,7 +467,7 @@
467 467  )))
468 468  |(% colspan="1" %)(% colspan="1" %)
469 469  (((
470 -[[Hypernode>>doc:||anchor="hypernode"]]
424 +Hypernode
471 471  )))|(% colspan="1" %)(% colspan="1" %)
472 472  (((
473 473  de.cau.cs.kieler.hypernode
... ... @@ -483,54 +483,6 @@
483 483  )))
484 484  |(% colspan="1" %)(% colspan="1" %)
485 485  (((
486 -Layout Ancestors
487 -)))|(% colspan="1" %)(% colspan="1" %)
488 -(((
489 -de.cau.cs.kieler.layoutAncestors
490 -)))|(% colspan="1" %)(% colspan="1" %)
491 -(((
492 -Boolean
493 -)))|(% colspan="1" %)(% colspan="1" %)
494 -(((
495 -Parents
496 -)))|(% colspan="1" %)(% colspan="1" %)
497 -(((
498 -false
499 -)))
500 -|(% colspan="1" %)(% colspan="1" %)
501 -(((
502 -Maximal Animation Time
503 -)))|(% colspan="1" %)(% colspan="1" %)
504 -(((
505 -de.cau.cs.kieler.maxAnimTim
506 -)))|(% colspan="1" %)(% colspan="1" %)
507 -(((
508 -Int
509 -)))|(% colspan="1" %)(% colspan="1" %)
510 -(((
511 -Parents
512 -)))|(% colspan="1" %)(% colspan="1" %)
513 -(((
514 -4000
515 -)))
516 -|(% colspan="1" %)(% colspan="1" %)
517 -(((
518 -Minimal Animation Time
519 -)))|(% colspan="1" %)(% colspan="1" %)
520 -(((
521 -de.cau.cs.kieler.minAnimTim
522 -)))|(% colspan="1" %)(% colspan="1" %)
523 -(((
524 -Int
525 -)))|(% colspan="1" %)(% colspan="1" %)
526 -(((
527 -Parents
528 -)))|(% colspan="1" %)(% colspan="1" %)
529 -(((
530 -400
531 -)))
532 -|(% colspan="1" %)(% colspan="1" %)
533 -(((
534 534  Minimal Height
535 535  )))|(% colspan="1" %)(% colspan="1" %)
536 536  (((
... ... @@ -565,7 +565,7 @@
565 565  )))
566 566  |(% colspan="1" %)(% colspan="1" %)
567 567  (((
568 -[[No Layout>>doc:||anchor="noLayout"]]
474 +No Layout
569 569  )))|(% colspan="1" %)(% colspan="1" %)
570 570  (((
571 571  de.cau.cs.kieler.noLayout
... ... @@ -581,22 +581,6 @@
581 581  )))
582 582  |(% colspan="1" %)(% colspan="1" %)
583 583  (((
584 -Port Index
585 -)))|(% colspan="1" %)(% colspan="1" %)
586 -(((
587 -de.cau.cs.kieler.portIndex
588 -)))|(% colspan="1" %)(% colspan="1" %)
589 -(((
590 -Int
591 -)))|(% colspan="1" %)(% colspan="1" %)
592 -(((
593 -Ports
594 -)))|(% colspan="1" %)(% colspan="1" %)
595 -(((
596 -
597 -)))
598 -|(% colspan="1" %)(% colspan="1" %)
599 -(((
600 600  [[Port Offset>>doc:||anchor="portOffset"]]
601 601  )))|(% colspan="1" %)(% colspan="1" %)
602 602  (((
... ... @@ -627,93 +627,9 @@
627 627  (((
628 628  
629 629  )))
630 -|(% colspan="1" %)(% colspan="1" %)
631 -(((
632 -Progress Bar
633 -)))|(% colspan="1" %)(% colspan="1" %)
634 -(((
635 -de.cau.cs.kieler.progressBar
636 -)))|(% colspan="1" %)(% colspan="1" %)
637 -(((
638 -Boolean
639 -)))|(% colspan="1" %)(% colspan="1" %)
640 -(((
641 -Parents
642 -)))|(% colspan="1" %)(% colspan="1" %)
643 -(((
644 -false
645 -)))
646 -|(% colspan="1" %)(% colspan="1" %)
647 -(((
648 -Scale Factor
649 -)))|(% colspan="1" %)(% colspan="1" %)
650 -(((
651 -de.cau.cs.kieler.scaleFactor
652 -)))|(% colspan="1" %)(% colspan="1" %)
653 -(((
654 -Float
655 -)))|(% colspan="1" %)(% colspan="1" %)
656 -(((
657 -Nodes
658 -)))|(% colspan="1" %)(% colspan="1" %)
659 -(((
660 -1.0
661 -)))
662 -|(% colspan="1" %)(% colspan="1" %)
663 -(((
664 -Zoom to Fit
665 -)))|(% colspan="1" %)(% colspan="1" %)
666 -(((
667 -de.cau.cs.kieler.zoomToFit
668 -)))|(% colspan="1" %)(% colspan="1" %)
669 -(((
670 -Boolean
671 -)))|(% colspan="1" %)(% colspan="1" %)
672 -(((
673 -Parents
674 -)))|(% colspan="1" %)(% colspan="1" %)
675 -(((
676 -false
677 -)))
678 678  
679 -=== Layout Output Properties ===
680 -
681 -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
682 -
683 -|=(((
684 -Property
685 -)))|=(((
686 -ID
687 -)))|=(((
688 -Type
689 -)))|=(((
690 -Applies to
691 -)))
692 -|(((
693 -[[Edge Routing>>doc:||anchor="edgeRouting"]]
694 -)))|(((
695 -de.cau.cs.kieler.edgeRouting
696 -)))|(((
697 -Enum
698 -)))|(((
699 -Edges
700 -)))
701 -|(((
702 -Junction Points
703 -)))|(((
704 -de.cau.cs.kieler.junctionPoints
705 -)))|(((
706 -Object
707 -)))|(((
708 -Edges
709 -)))
710 -
711 -
712 -
713 713  = Detailed Documentation =
714 714  
715 -This section explains every layout option in more detail.
716 -
717 717  == The Most Important Options ==
718 718  
719 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.
... ... @@ -722,15 +722,19 @@
722 722  
723 723  {{id name="layoutAlgorithm"/}}
724 724  
725 -The 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.
531 +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.
726 726  
727 -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.
533 +The following layout types are predefined:
728 728  
729 -[[image:attach:layout_algorithm.png]]
535 +* **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.
536 +* **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.
537 +* **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
538 +* **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.
539 +* **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.
730 730  
731 -==== Available Algorithms and Libraries ====
541 +=== Available Algorithms and Libraries ===
732 732  
733 -* **The [[KLay Project>>doc:Layout Algorithms (KLay)]]** - Java implementations of standard layout approaches, augmented with special processing of graph features such as ports and labels.
543 +* **The [[KLay Project>>doc:Layout Algorithms (KLay)]]** - Java implementations of standard layout approaches, augmented with special processing of graph features such as ports and edge labels.
734 734  * **Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
735 735  * (((
736 736  **Box Layout** - Ignores edges, places all nodes in rows. Can be used to layout collections of unconnected boxes, such as Statechart regions.
... ... @@ -739,14 +739,6 @@
739 739  * **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.
740 740  * **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.
741 741  
742 -==== Predefined Layout Types ====
743 -
744 -* **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.
745 -* **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.
746 -* **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
747 -* **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.
748 -* **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.
749 -
750 750  === Diagram Type ===
751 751  
752 752  {{id name="diagramType"/}}
... ... @@ -762,6 +762,15 @@
762 762  * **Use Case Diagram** - Use case diagrams as defined by the UML.
763 763  * **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:SCCharts SyncCharts]].
764 764  
567 +== Other Options ==
568 +
569 +* **Layout Hierarchy** ({{code language="none"}}de.cau.cs.kieler.layoutHierarchy{{/code}}) - If 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.
570 +* **Hypernode** ({{code language="none"}}de.cau.cs.kieler.hypernode{{/code}}) - A 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.
571 +* **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.
572 +* **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.
573 +
574 +This section explains every layout option in more detail.
575 +
765 765  === Edge Routing ===
766 766  
767 767  {{id name="edgeRouting"/}}
... ... @@ -771,54 +771,14 @@
771 771  * POLYLINE
772 772  Edges consist of one or more segments defined by a list of bend points.
773 773  * ORTHOGONAL
774 -Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically.
775 -* SPLINES
776 -Edges are routed as splines (smooth curves).
585 +Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically, but never at an angle.
586 +* SPLINE
587 +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.
777 777  * UNDEFINED
778 -No particular edge routing style is selected. Usually this value points to the default setting of the selected layout algorithm.
589 +No particular edge routing style is selected. The result produced by the layout algorithm may be undefined.
779 779  
780 -[[image:attach:edge_routing.png]]
591 +(% style="color: rgb(153,51,0);" %)**TODO:** Add an image illustrating the different routing styles.
781 781  
782 -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:
783 -
784 -1. Start at the source point of the edge.
785 -1. As long as there are at least three bend points left:
786 -11. Draw a cubic spline segment to the third bend point with the other two bend points as control points.
787 -11. Use the third bend point as start point for the next segment.
788 -11. Consume the three bend points and proceed to the next segment.
789 -1. Check the number of remaining bend points:
790 -11. Two bend points – draw a cubic spline segment to the target point of the edge.
791 -11. One bend point – draw a quadratic spline segment to the target point of the edge.
792 -11. No bend point – draw a straight line to the target point of the edge.
793 -
794 -== Other Options ==
795 -
796 -=== Comment Box ===
797 -
798 -{{id name="commentBox"/}}
799 -
800 -A 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.
801 -
802 -[[image:attach:comment_box.png]]
803 -
804 -=== (% style="line-height: 1.5625;" %)Hypernode(%%) ===
805 -
806 -{{id name="hypernode"/}}
807 -
808 -A 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.
809 -
810 -=== Layout Hierarchy ===
811 -
812 -{{id name="layoutHierarchy"/}}
813 -
814 -If 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.
815 -
816 -=== No Layout ===
817 -
818 -{{id name="noLayout"/}}
819 -
820 -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.
821 -
822 822  === Port Offset ===
823 823  
824 824  {{id name="portOffset"/}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470016
1 +9470010
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470016/KIML Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470010/KIML Layout Options