Skip to Content

Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
From version 29.1
edited by uru
on 2015/01/28 15:56
Change comment: There is no comment for this version
To version 30.1
edited by csp
on 2015/02/18 12:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.uru
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  
... ... @@ -226,6 +226,91 @@
226 226  (((
227 227  
228 228  )))
230 +|(% colspan="1" %)(% colspan="1" %)
231 +(((
232 +Port Alignment
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  )))|(((
... ... @@ -766,12 +766,10 @@
766 766  
767 767  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.
768 768  
769 -=== Layout Algorithm ===
855 +=== ===
770 770  
771 -{{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.
772 772  
773 -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.
774 -
775 775  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.
776 776  
777 777  [[image:attach:layout_algorithm.png]]
... ... @@ -795,12 +795,10 @@
795 795  * **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.
796 796  * **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.
797 797  
798 -=== Diagram Type ===
882 +=== ===
799 799  
800 -{{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.
801 801  
802 -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.
803 -
804 804  The following diagram types are predefined:
805 805  
806 806  * **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.
... ... @@ -810,12 +810,10 @@
810 810  * **Use Case Diagram** - Use case diagrams as defined by the UML.
811 811  * **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]].
812 812  
813 -=== Edge Routing ===
895 +=== ===
814 814  
815 -{{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:
816 816  
817 -This option influences the way in which edges are routed between the nodes they connect. The following settings are available:
818 -
819 819  * POLYLINE
820 820  Edges consist of one or more segments defined by a list of bend points.
821 821  * ORTHOGONAL
... ... @@ -841,77 +841,57 @@
841 841  
842 842  == Other Options ==
843 843  
844 -=== Additional Port Space ===
924 +=== ===
845 845  
846 -{{id name="addPortSpace"/}}
926 +{{id name="addPortSpace"/}}Additional Port SpaceThis option controls additional port space left around the set of ports on each side:
847 847  
848 -This option controls additional port space left around the set of ports on each side:
849 -
850 850  [[image:attach:addPortSpace.png]]
851 851  
852 852  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.
853 853  
854 -=== Alignment ===
932 +=== ===
855 855  
856 -{{id name="alignment"/}}
934 +{{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.
857 857  
858 -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.
936 +=== ===
859 859  
860 -=== Aspect Ratio ===
938 +{{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.
861 861  
862 -{{id name="aspectRatio"/}}
940 +=== ===
863 863  
864 -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.
942 +{{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.
865 865  
866 -=== Comment Box ===
867 -
868 -{{id name="commentBox"/}}
869 -
870 -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.
871 -
872 872  [[image:attach:comment_box.png]]
873 873  
874 -=== (% style="line-height: 1.5625;" %)Hypernode(%%) ===
946 +=== ===
875 875  
876 -{{id name="hypernode"/}}
948 +{{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.
877 877  
878 -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.
950 +=== ===
879 879  
880 -=== Layout Hierarchy ===
952 +{{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.
881 881  
882 -{{id name="layoutHierarchy"/}}
954 +=== ===
883 883  
884 -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.
956 +{{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.
885 885  
886 -=== No Layout ===
958 +=== ===
887 887  
888 -{{id name="noLayout"/}}
960 +{{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.
889 889  
890 -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.
891 -
892 -=== Port Anchor Offset ===
893 -
894 -{{id name="portAnchor"/}}
895 -
896 -Since 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.
897 -
898 898  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:
899 899  
900 900  [[image:attach:KLay Layered Layout Options@port_anchors.png]]
901 901  
902 -=== Port Offset ===
966 +=== ===
903 903  
904 -{{id name="portOffset"/}}
968 +{{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.
905 905  
906 -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.
907 -
908 908  Set this property if one of the following cases applies:
909 909  
910 910  * The port constraints on a node are set to FREE, FIXED_SIDES or FIXED_ORDER.
911 911  * 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.)
912 912  
913 -=== Port Spacing ===
975 +=== ===
914 914  
915 -{{id name="portSpacing"/}}
916 -
917 -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}}.
977 +{{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}}.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -10751220
1 +10751222
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751220/KIML Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/10751222/KIML Layout Options