Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17

Manage
- Copy
Actions
- Export
- Print Preview
Viewers
- Source
- Children
- Content
- Information

From 17.1 to 18.1 From 23.1 to 24.1

From version 18.1

edited by msp
on 2014/03/07 17:04

Change comment: There is no comment for this version

To version 23.1

edited by msp
on 2014/03/13 10:36

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

@@ -1,8 +1,6 @@
--{{warning}}
--This is preliminary and incomplete documentation. You've been warned.
--{{/warning}}
++
--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.
++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.
  **Contents**
@@ -16,7 +16,7 @@
  * An ID to identify them.
  * 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.
--* 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.
++* 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.
  * 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.
  Layout options can be assigned to two main categories: user options and programmatic options.
@@ -37,7 +37,7 @@
  Default
  )))
  |(((
--Alignment
++[[Alignment>>doc:||anchor="alignment"]]
  )))|(((
  de.cau.cs.kieler.alignment
  )))|(((
@@ -48,7 +48,7 @@
  AUTOMATIC
  )))
  |(((
--Aspect Ratio
++[[Aspect Ratio>>doc:||anchor="aspectRatio"]]
  )))|(((
  de.cau.cs.kieler.aspectRatio
  )))|(((
@@ -148,7 +148,7 @@
  )))
  |(((
--Layout Hierarchy
++[[Layout Hierarchy>>doc:||anchor="layoutHierarchy"]]
  )))|(((
  de.cau.cs.kieler.layoutHierarchy
  )))|(((
@@ -349,6 +349,54 @@
  )))|=(((
  Default
  )))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Animate
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.animate
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Boolean
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Parents
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++true
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Animation Time Factor
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.animTimeFactor
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Int
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Parents
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++100
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++[[Comment Box>>doc:||anchor="commentBox"]]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.commentBox
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Boolean
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Nodes
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++false
++)))
  |(((
  [[Diagram Type>>doc:||anchor="diagramType"]]
  )))|(((
@@ -421,7 +421,7 @@
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Hypernode
++[[Hypernode>>doc:||anchor="hypernode"]]
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  de.cau.cs.kieler.hypernode
@@ -437,6 +437,54 @@
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
++Layout Ancestors
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.layoutAncestors
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Boolean
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Parents
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++false
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Maximal Animation Time
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.maxAnimTim
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Int
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Parents
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++4000
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Minimal Animation Time
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.minAnimTim
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Int
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Parents
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++400
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
  Minimal Height
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
@@ -471,7 +471,7 @@
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--No Layout
++[[No Layout>>doc:||anchor="noLayout"]]
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  de.cau.cs.kieler.noLayout
@@ -487,6 +487,22 @@
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
++Port Index
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.portIndex
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Int
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Ports
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
  [[Port Offset>>doc:||anchor="portOffset"]]
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
@@ -517,9 +517,109 @@
  (((
  )))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Progress Bar
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.progressBar
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Boolean
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Parents
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++false
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Scale Factor
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.scaleFactor
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Float
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Nodes
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++1.0
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Thickness
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.thickness
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Float
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Edges
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++1.0
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Zoom to Fit
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.zoomToFit
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Boolean
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Parents
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++false
++)))
++=== Layout Output Properties ===
++
++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
++
++|=(((
++Property
++)))|=(((
++ID
++)))|=(((
++Type
++)))|=(((
++Applies to
++)))
++|(((
++[[Edge Routing>>doc:||anchor="edgeRouting"]]
++)))|(((
++de.cau.cs.kieler.edgeRouting
++)))|(((
++Enum
++)))|(((
++Edges
++)))
++|(((
++Junction Points
++)))|(((
++de.cau.cs.kieler.junctionPoints
++)))|(((
++Object
++)))|(((
++Edges
++)))
++
++
++
  = Detailed Documentation =
++This section explains every layout option in more detail.
++
  == The Most Important Options ==
  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.
@@ -528,19 +528,15 @@
  {{id name="layoutAlgorithm"/}}
--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.
++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.
--The following layout types are predefined:
++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.
--* **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.
--* **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.
--* **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
--* **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.
--* **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.
++[[image:attach:layout_algorithm.png]]
--=== Available Algorithms and Libraries ===
++==== Available Algorithms and Libraries ====
--* **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.
++* **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.
  * **Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
  * (((
  **Box Layout** - Ignores edges, places all nodes in rows. Can be used to layout collections of unconnected boxes, such as Statechart regions.
@@ -549,6 +549,14 @@
  * **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.
  * **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.
++==== Predefined Layout Types ====
++
++* **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.
++* **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.
++* **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
++* **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.
++* **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.
++
  === Diagram Type ===
  {{id name="diagramType"/}}
@@ -564,15 +564,6 @@
  * **Use Case Diagram** - Use case diagrams as defined by the UML.
  * **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]].
--== Other Options ==
--
--* **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.
--* **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.
--* **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.
--* **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.
--
--This section explains every layout option in more detail.
--
  === Edge Routing ===
  {{id name="edgeRouting"/}}
@@ -582,14 +582,66 @@
  * POLYLINE
  Edges consist of one or more segments defined by a list of bend points.
  * ORTHOGONAL
--Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically, but never at an angle.
--* SPLINE
--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.
++Edges are routed orthogonally, meaning that each segment of an edge runs either horizontally or vertically.
++* SPLINES
++Edges are routed as splines (smooth curves).
  * UNDEFINED
--No particular edge routing style is selected. The result produced by the layout algorithm may be undefined.
++No particular edge routing style is selected. Usually this value points to the default setting of the selected layout algorithm.
--(% style="color: rgb(153,51,0);" %)**TODO:** Add an image illustrating the different routing styles.
++[[image:attach:edge_routing.png]]
++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:
++
++1. Start at the source point of the edge.
++1. As long as there are at least three bend points left:
++11. Draw a cubic spline segment to the third bend point with the other two bend points as control points.
++11. Use the third bend point as start point for the next segment.
++11. Consume the three bend points and proceed to the next segment.
++1. Check the number of remaining bend points:
++11. Two bend points – draw a cubic spline segment to the target point of the edge.
++11. One bend point – draw a quadratic spline segment to the target point of the edge.
++11. No bend point – draw a straight line to the target point of the edge.
++
++== Other Options ==
++
++=== Alignment ===
++
++{{id name="alignment"/}}
++
++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.
++
++=== Aspect Ratio ===
++
++{{id name="aspectRatio"/}}
++
++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.
++
++=== Comment Box ===
++
++{{id name="commentBox"/}}
++
++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.
++
++[[image:attach:comment_box.png]]
++
++=== (% style="line-height: 1.5625;" %)Hypernode(%%) ===
++
++{{id name="hypernode"/}}
++
++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.
++
++=== Layout Hierarchy ===
++
++{{id name="layoutHierarchy"/}}
++
++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.
++
++=== No Layout ===
++
++{{id name="noLayout"/}}
++
++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.
++
  === Port Offset ===
  {{id name="portOffset"/}}

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--9470010
++9470042

URL

@@ -1,1 +1,1 @@
--https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470010/KIML Layout Options
++https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470042/KIML Layout Options

Changes for page KIML Layout Options

Summary

Details

Navigation

Quick Links