Skip to Content

Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
From version 27.1
edited by cds
on 2014/04/15 10:56
Change comment: There is no comment for this version
To version 31.1
edited by csp
on 2015/02/18 12:54
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +Infrastructure for Meta Layout (KIML)
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cds
1 +XWiki.csp
Content
... ... @@ -179,6 +179,7 @@
179 179  )))|(% colspan="1" %)(% colspan="1" %)
180 180  (((
181 181  Nodes
182 +Labels
182 182  )))|(% colspan="1" %)(% colspan="1" %)
183 183  (((
184 184  
... ... @@ -212,7 +212,7 @@
212 212  )))
213 213  |(% colspan="1" %)(% colspan="1" %)
214 214  (((
215 -
216 +[[Port Spacing>>doc:||anchor="portSpacing"]]
216 216  )))|(% colspan="1" %)(% colspan="1" %)
217 217  (((
218 218  de.cau.cs.kieler.portSpacing
... ... @@ -226,6 +226,91 @@
226 226  (((
227 227  
228 228  )))
230 +|(% colspan="1" %)(% colspan="1" %)
231 +(((
232 +[[Port Alignment>>doc:||anchor="portAlignment"]]
233 +)))|(% colspan="1" %)(% colspan="1" %)
234 +(((
235 +de.cau.cs.kieler.portAlignment
236 +)))|(% colspan="1" %)(% colspan="1" %)
237 +(((
238 +Enum
239 +)))|(% colspan="1" %)(% colspan="1" %)
240 +(((
241 +Nodes
242 +Parents
243 +)))|(% colspan="1" %)(% colspan="1" %)
244 +(((
245 +JUSTIFIED
246 +)))
247 +|(% colspan="1" %)(% colspan="1" %)
248 +(((
249 +Port Alignment for Northern Ports
250 +)))|(% colspan="1" %)(% colspan="1" %)
251 +(((
252 +de.cau.cs.kieler.portAlignment.north
253 +)))|(% colspan="1" %)(% colspan="1" %)
254 +(((
255 +Enum
256 +)))|(% colspan="1" %)(% colspan="1" %)
257 +(((
258 +Nodes
259 +Parents
260 +)))|(% colspan="1" %)(% colspan="1" %)
261 +(((
262 +UNDEFINED
263 +)))
264 +|(% colspan="1" %)(% colspan="1" %)
265 +(((
266 +Port Alignment for Souther Ports
267 +)))|(% colspan="1" %)(% colspan="1" %)
268 +(((
269 +de.cau.cs.kieler.portAlignment.south
270 +)))|(% colspan="1" %)(% colspan="1" %)
271 +(((
272 +Enum
273 +)))|(% colspan="1" %)(% colspan="1" %)
274 +(((
275 +Nodes
276 +Parents
277 +)))|(% colspan="1" %)(% colspan="1" %)
278 +(((
279 +UNDEFINED
280 +)))
281 +|(% colspan="1" %)(% colspan="1" %)
282 +(((
283 +Port Alignment for Eastern Ports
284 +)))|(% colspan="1" %)(% colspan="1" %)
285 +(((
286 +de.cau.cs.kieler.portAlignment.east
287 +)))|(% colspan="1" %)(% colspan="1" %)
288 +(((
289 +Enum
290 +)))|(% colspan="1" %)(% colspan="1" %)
291 +(((
292 +Nodes
293 +Parents
294 +)))|(% colspan="1" %)(% colspan="1" %)
295 +(((
296 +UNDEFINED
297 +)))
298 +|(% colspan="1" %)(% colspan="1" %)
299 +(((
300 +Port Alignment for Western Ports
301 +)))|(% colspan="1" %)(% colspan="1" %)
302 +(((
303 +de.cau.cs.kieler.portAlignment.west
304 +)))|(% colspan="1" %)(% colspan="1" %)
305 +(((
306 +Enum
307 +)))|(% colspan="1" %)(% colspan="1" %)
308 +(((
309 +Nodes
310 +Parents
311 +)))|(% colspan="1" %)(% colspan="1" %)
312 +(((
313 +UNDEFINED
314 +)))
229 229  |(((
230 230  Position
231 231  )))|(((
... ... @@ -597,6 +597,22 @@
597 597  )))
598 598  |(% colspan="1" %)(% colspan="1" %)
599 599  (((
686 +[[Port Anchor Offset>>doc:||anchor="portAnchor"]]
687 +)))|(% colspan="1" %)(% colspan="1" %)
688 +(((
689 +de.cau.cs.kieler.klay.layered.portAnchor
690 +)))|(% colspan="1" %)(% colspan="1" %)
691 +(((
692 +Object
693 +)))|(% colspan="1" %)(% colspan="1" %)
694 +(((
695 +Ports
696 +)))|(% colspan="1" %)(% colspan="1" %)
697 +(((
698 +
699 +)))
700 +|(% colspan="1" %)(% colspan="1" %)
701 +(((
600 600  Port Index
601 601  )))|(% colspan="1" %)(% colspan="1" %)
602 602  (((
... ... @@ -750,12 +750,10 @@
750 750  
751 751  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.
752 752  
753 -=== Layout Algorithm ===
855 +=== ===
754 754  
755 -{{id name="layoutAlgorithm"/}}
857 +{{id name="layoutAlgorithm"/}}Layout AlgorithmThe 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.
756 756  
757 -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.
758 -
759 759  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.
760 760  
761 761  [[image:attach:layout_algorithm.png]]
... ... @@ -779,27 +779,23 @@
779 779  * **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.
780 780  * **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.
781 781  
782 -=== Diagram Type ===
882 +=== ===
783 783  
784 -{{id name="diagramType"/}}
884 +{{id name="diagramType"/}}Diagram TypeDiagram 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.
785 785  
786 -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.
787 -
788 788  The following diagram types are predefined:
789 789  
790 790  * **General** - This type is automatically assigned to all diagrams for which no specific type is declared. A layout algorithm that has the highest priority on the //General// diagram type is taken as the default algorithm when no further information on a diagram is available to KIML.
791 -* **State Machine** - All kinds of state machines, automata, and activity diagrams. Examples: [[doc:SCCharts SyncCharts]], UML Activity diagrams.
889 +* **State Machine** - All kinds of state machines, automata, and activity diagrams. Examples: [[doc:SyncCharts]], UML Activity diagrams.
792 792  * **Data Flow Diagram** - Actor-oriented diagrams, where connections are mostly done between //ports// of nodes. These diagrams can only be handled properly by very special layout algorithms, such as those developed in the [[KLay project>>doc:Layout Algorithms (KLay)]].
793 793  * **Class Diagram** - Class diagrams such as Ecore diagrams for the [[EMF>>url:http://www.eclipse.org/modeling/emf/||shape="rect"]] or UML Class diagrams.
794 794  * **Use Case Diagram** - Use case diagrams as defined by the UML.
795 -* **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]].
893 +* **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:SyncCharts]].
796 796  
797 -=== Edge Routing ===
895 +=== ===
798 798  
799 -{{id name="edgeRouting"/}}
897 +{{id name="edgeRouting"/}}Edge RoutingThis option influences the way in which edges are routed between the nodes they connect. The following settings are available:
800 800  
801 -This option influences the way in which edges are routed between the nodes they connect. The following settings are available:
802 -
803 803  * POLYLINE
804 804  Edges consist of one or more segments defined by a list of bend points.
805 805  * ORTHOGONAL
... ... @@ -825,67 +825,80 @@
825 825  
826 826  == Other Options ==
827 827  
828 -=== Additional Port Space ===
924 +=== ===
829 829  
830 -{{id name="addPortSpace"/}}
926 +{{id name="addPortSpace"/}}Additional Port SpaceThis option controls the usable space for ports on each side:
831 831  
832 -This option controls additional port space left around the set of ports on each side:
833 -
834 834  [[image:attach:addPortSpace.png]]
835 835  
930 +If the option is not set, the value of [[Port Spacing>>doc:||anchor="portSpacing"]] is used instead for all four components.
931 +
836 836  This option is only relevant if port constraints are {{code language="none"}}FREE{{/code}}, {{code language="none"}}FIXED_SIDE{{/code}}, or {{code language="none"}}FIXED_ORDER{{/code}}. If size constraints include {{code language="none"}}PORTS{{/code}}, the additional port space, together with the port spacing and the size of ports, determines a lower bound on the node size.
837 837  
838 -=== Alignment ===
934 +=== ===
839 839  
840 -{{id name="alignment"/}}
936 +{{id name="alignment"/}}AlignmentDetermines the alignment of a node in relation to other nodes of the same row or column. For layer-based algorithms, for instance, this option controls how a node is positioned inside its assigned layer.
841 841  
842 -Determines the alignment of a node in relation to other nodes of the same row or column. For layer-based algorithms, for instance, this option controls how a node is positioned inside its assigned layer.
938 +=== ===
843 843  
844 -=== Aspect Ratio ===
940 +{{id name="aspectRatio"/}}Aspect RatioThe aspect ratio of a drawing is the ratio of its total width to its total height. This option gives some control over that ratio, although in most cases it is only interpreted as a hint on how to arrange multiple connected components, hence the actual aspect ratio will probably be different from what has been specified with the option.
845 845  
846 -{{id name="aspectRatio"/}}
942 +=== ===
847 847  
848 -The aspect ratio of a drawing is the ratio of its total width to its total height. This option gives some control over that ratio, although in most cases it is only interpreted as a hint on how to arrange multiple connected components, hence the actual aspect ratio will probably be different from what has been specified with the option.
944 +{{id name="commentBox"/}}Comment BoxA 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.
849 849  
850 -=== Comment Box ===
946 +[[image:attach:comment_box.png]]
851 851  
852 -{{id name="commentBox"/}}
948 +=== ===
853 853  
854 -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.
950 +{{id name="hypernode"/}}HypernodeA 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.
855 855  
856 -[[image:attach:comment_box.png]]
952 +=== ===
857 857  
858 -=== (% style="line-height: 1.5625;" %)Hypernode(%%) ===
954 +{{id name="layoutHierarchy"/}}Layout HierarchyIf 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.
859 859  
860 -{{id name="hypernode"/}}
956 +=== ===
861 861  
862 -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.
958 +{{id name="noLayout"/}}No LayoutElements 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.
863 863  
864 -=== Layout Hierarchy ===
960 +=== ===
865 865  
866 -{{id name="layoutHierarchy"/}}
962 +{{id name="portAlignment"/}}Port AlignmentThe port alignment controls how ports are distributed over their respective edge.
867 867  
868 -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.
964 +This option is only relevant if port constraints are {{code language="none"}}FREE{{/code}}, {{code language="none"}}FIXED_SIDE{{/code}}, or {{code language="none"}}FIXED_ORDER{{/code}}.
869 869  
870 -=== No Layout ===
966 +The following settings are possible:
871 871  
872 -{{id name="noLayout"/}}
968 +* {{code language="none"}}UNDEFINED{{/code}}
969 +Defaults to {{code language="none"}}JUSTIFIED{{/code}}.
970 +* {{code language="none"}}JUSTIFIED{{/code}}
971 +Distributes the ports evenly over the whole usable space (for usable space, see [[additional port space>>doc:||anchor="addPortSpace"]]).
972 +* {{code language="none"}}BEGIN{{/code}}
973 +Places the ports at top-/leftmost position with [[port spacing>>doc:||anchor="portSpacing"]] between them.
974 +* {{code language="none"}}CENTER{{/code}}
975 +Places the ports centered in the usable space with port spacing between them.
976 +* {{code language="none"}}END{{/code}}
977 +Places the ports at bottom-/rightmost position with port spacing between them.
873 873  
874 -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.
979 +Port alignment can also be set as specialized options {{code language="none"}}portAlignment.{north|south|east|west{{/code}}}. These options overwrite the general policy for the respective side. Setting one of these to {{code language="none"}}UNDEFINED{{/code}} defaults it to the general port alignment.
875 875  
876 -=== Port Offset ===
981 +=== ===
877 877  
878 -{{id name="portOffset"/}}
983 +{{id name="portAnchor"/}}Port Anchor OffsetSince ports have a size, we need a concrete point inside the port that edges should start or end in. In KLay Layered, this is referred to as the //port anchor//. By default, the center of each port is used as its port anchor, but this behavior can be overridden by setting an explicit port anchor.
879 879  
880 -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.
985 +In the following example, the port anchor of the left port was moved upwards, while the port anchor of the second port was moved downwards:
881 881  
987 +[[image:attach:KLay Layered Layout Options@port_anchors.png]]
988 +
989 +=== ===
990 +
991 +{{id name="portOffset"/}}Port OffsetThe 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.
992 +
882 882  Set this property if one of the following cases applies:
883 883  
884 884  * The port constraints on a node are set to FREE, FIXED_SIDES or FIXED_ORDER.
885 885  * 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.)
886 886  
887 -=== Port Spacing ===
998 +=== ===
888 888  
889 -{{id name="portSpacing"/}}
890 -
891 -The port spacing determines how much space KLay Layered should leave between the ports of each side. This option is only relevant if the node size depends on the ports, that is, if the size constraints include {{code language="none"}}SizeConstraint.PORTS{{/code}}.
1000 +{{id name="portSpacing"/}}Port SpacingThe port spacing determines how much space KLay Layered should leave between the ports of each side. This option is only relevant if the node size depends on the ports, that is, if the size constraints include {{code language="none"}}SizeConstraint.PORTS{{/code}}.
addPortSpace.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +20.2 KB
Content
comment_box.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +5.5 KB
Content
edge_routing.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +57.8 KB
Content
layout_algorithm.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +20.0 KB
Content
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -10751028
1 +7111094
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751028/KIML Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/7111094/KIML Layout Options