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

From 5.1 to 6.1 From 30.1 to 31.1

From version 6.1

edited by cds
on 2013/06/03 10:42

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

Raw
Rendered

Summary

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

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.cds
++XWiki.csp

Content

@@ -1,24 +1,28 @@
--{{warning}}
--This is preliminary 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, it may change the option's default value. Algorithms may also provide more specialized documentation for a given layout option.
++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**
--
++
++{{toc maxLevel="2"/}}
++
  = Overview =
--Beside a human-readable name, layout options are defined by the following properties:
++Beside a user-friendly name, layout options are defined by the following properties:
  * An ID to identify them.
--* A type. One of Boolean, String, Int, Float, Enum, EnumSet (a {{code language="none"}}Set{{/code}} over a given enumeration), or Object. The types Enum and EnumSet have to be further defined by an enumeration class. The Object type can be constricted to a certain 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, and Labels.
--* An optional default value. If an option is not set on an object and if the option does not have a default value, {{code language="none"}}null{{/code}} is returned when it is accessed.
++* 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 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.
--KIML defines the following set of layout options:
++Layout options can be assigned to two main categories: user options and programmatic options.
++== User Options ==
++
++User options are those that you can see in the "//Layout View//" available in Eclipse if the KIML user interface is installed. That view is restricted to layout options that are supported by the currently active layout algorithm. Furthermore, some options are visible only when the //Show Advanced Properties// button is active in the view.
++
  |=(((
  Option
  )))|=(((
@@ -31,7 +31,7 @@
  Default
  )))
  |(((
--Alignment
++[[Alignment>>doc:||anchor="alignment"]]
  )))|(((
  de.cau.cs.kieler.alignment
  )))|(((
@@ -42,7 +42,7 @@
  AUTOMATIC
  )))
  |(((
--Aspect Ratio
++[[Aspect Ratio>>doc:||anchor="aspectRatio"]]
  )))|(((
  de.cau.cs.kieler.aspectRatio
  )))|(((
@@ -72,128 +72,279 @@
  )))|(((
  Parents
  )))|(((
---1.0
++
  )))
++|(((
++Debug Mode
++)))|(((
++de.cau.cs.kieler.debugMode
++)))|(((
++Boolean
++)))|(((
++Parents
++)))|(((
++false
++)))
++|(((
++Direction
++)))|(((
++de.cau.cs.kieler.direction
++)))|(((
++Enum
++)))|(((
++Parents
++)))|(((
++
++)))
++|(((
++[[Edge Routing>>doc:||anchor="edgeRouting"]]
++)))|(((
++de.cau.cs.kieler.edgeRouting
++)))|(((
++Enum
++)))|(((
++Parents
++)))|(((
++
++)))
++|(((
++Expand Nodes
++)))|(((
++de.cau.cs.kieler.expandNodes
++)))|(((
++Boolean
++)))|(((
++Parents
++)))|(((
++false
++)))
++|(((
++Interactive
++)))|(((
++de.cau.cs.kieler.interactive
++)))|(((
++Boolean
++)))|(((
++Parents
++)))|(((
++false
++)))
++|(((
++Label Spacing
++)))|(((
++de.cau.cs.kieler.labelSpacing
++)))|(((
++Float
++)))|(((
++Edges
++Nodes
++)))|(((
++
++)))
++|(((
++[[Layout Hierarchy>>doc:||anchor="layoutHierarchy"]]
++)))|(((
++de.cau.cs.kieler.layoutHierarchy
++)))|(((
++Boolean
++)))|(((
++Parents
++)))|(((
++false
++)))
++|(((
++[[Layout Algorithm>>doc:||anchor="layoutAlgorithm"]]
++)))|(((
++de.cau.cs.kieler.algorithm
++)))|(((
++String
++)))|(((
++Parents
++)))|(((
++
++)))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Comment Box
++Node Label Placement
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.commentBox
++de.cau.cs.kieler.nodeLabelPlacement
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Boolean
++EnumSet
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  Nodes
++Labels
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--false
++
  )))
  |(((
--Debug Mode
++Port Constraints
  )))|(((
--de.cau.cs.kieler.debugMode
++de.cau.cs.kieler.portConstraints
  )))|(((
--Boolean
++Enum
  )))|(((
--Parents
++Nodes
  )))|(((
--false
++
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Diagram Type
++Port Label Placement
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.diagramType
++de.cau.cs.kieler.portLabelPlacement
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--String
++Enum
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--
++Nodes
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
++OUTSIDE
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.portSpacing
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Float
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Nodes
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
  )))
--|(((
--Direction
--)))|(((
--de.cau.cs.kieler.direction
--)))|(((
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Port Alignment
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.portAlignment
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
  Enum
--)))|(((
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Nodes
  Parents
--)))|(((
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++JUSTIFIED
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Port Alignment for Northern Ports
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.portAlignment.north
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Enum
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Nodes
++Parents
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
  UNDEFINED
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Edge Label Placement
++Port Alignment for Souther Ports
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.edgeLabelPlacement
++de.cau.cs.kieler.portAlignment.south
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  Enum
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Labels
++Nodes
++Parents
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  UNDEFINED
  )))
--|(((
--Edge Routing
--)))|(((
--de.cau.cs.kieler.edgeRouting
--)))|(((
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Port Alignment for Eastern Ports
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.portAlignment.east
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
  Enum
--)))|(((
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Nodes
  Parents
--)))|(((
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
  UNDEFINED
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Edge Type
++Port Alignment for Western Ports
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.edgeType
++de.cau.cs.kieler.portAlignment.west
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  Enum
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Edges
++Nodes
++Parents
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--NONE
++UNDEFINED
  )))
  |(((
--Expand Nodes
++Position
  )))|(((
--de.cau.cs.kieler.expandNodes
++de.cau.cs.kieler.position
  )))|(((
--Boolean
++Object
  )))|(((
--Parents
++Labels
++Nodes
++Ports
  )))|(((
--false
++
  )))
++|(((
++Priority
++)))|(((
++de.cau.cs.kieler.priority
++)))|(((
++Int
++)))|(((
++Edges
++Nodes
++)))|(((
++
++)))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Font Name
++Randomization Seed
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.fontName
++de.cau.cs.kieler.randomSeed
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--String
++Int
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Labels
++Parents
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
@@ -200,16 +200,16 @@
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Font Size
++Separate Connected Components
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.fontSize
++de.cau.cs.kieler.separateConnComp
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Int
++Boolean
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Labels
++Parents
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
@@ -216,15 +216,127 @@
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Hypernode
++Size Constraint
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.hypernode
++de.cau.cs.kieler.sizeConstraint
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
++EnumSet
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Nodes
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Size Options
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.sizeOptions
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++EnumSet
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Nodes
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++DEFAULT_MINIMUM_SIZE
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Spacing
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.spacing
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Float
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Parents
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))
++
++== Programmatic Options ==
++
++Programmatic options are such that are meant to be configured exclusively through the KIML API. They should not be visible in the user interface.
++
++|=(((
++Option
++)))|=(((
++ID
++)))|=(((
++Type
++)))|=(((
++Applies to
++)))|=(((
++Default
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++[[Additional Port Space>>doc:||anchor="addPortSpace"]]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.additionalPortSpace
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Margins
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Nodes
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++0, 0, 0, 0
++)))
++|(% 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" %)
  (((
@@ -231,52 +231,141 @@
  false
  )))
  |(((
--Interactive
++[[Diagram Type>>doc:||anchor="diagramType"]]
  )))|(((
--de.cau.cs.kieler.interactive
++de.cau.cs.kieler.diagramType
  )))|(((
--Boolean
++String
  )))|(((
  Parents
  )))|(((
--false
++
  )))
  |(((
--Label Spacing
++Edge Label Placement
  )))|(((
--de.cau.cs.kieler.labelSpacing
++de.cau.cs.kieler.edgeLabelPlacement
  )))|(((
--Float
++Enum
  )))|(((
++Labels
++)))|(((
++
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Edge Type
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.edgeType
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Enum
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
  Edges
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++NONE
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Font Name
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.fontName
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++String
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Labels
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Font Size
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.fontSize
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Int
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Labels
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++[[Hypernode>>doc:||anchor="hypernode"]]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++de.cau.cs.kieler.hypernode
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Boolean
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
  Nodes
--)))|(((
---1.0
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++false
  )))
--|(((
--Layout Hierarchy
--)))|(((
--de.cau.cs.kieler.layoutHierarchy
--)))|(((
++|(% 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
  )))
--|(((
--Layout Algorithm
--)))|(((
--de.cau.cs.kieler.algorithm
--)))|(((
--String
--)))|(((
++|(% 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" %)
  (((
@@ -311,7 +311,7 @@
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--No Layout
++[[No Layout>>doc:||anchor="noLayout"]]
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  de.cau.cs.kieler.noLayout
@@ -327,46 +327,35 @@
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Node Label Placement
++[[Port Anchor Offset>>doc:||anchor="portAnchor"]]
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.nodeLabelPlacement
++de.cau.cs.kieler.klay.layered.portAnchor
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--EnumSet
++Object
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Nodes
++Ports
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  )))
--|(((
--Port Constraints
--)))|(((
--de.cau.cs.kieler.portConstraints
--)))|(((
--Enum
--)))|(((
--Nodes
--)))|(((
--UNDEFINED
--)))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Port Label Placement
++Port Index
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.portLabelPlacement
++de.cau.cs.kieler.portIndex
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Enum
++Int
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Nodes
++Ports
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--OUTSIDE
++
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -398,57 +398,16 @@
  Ports
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--UNDEFINED
--)))
--|(((
--Position
--)))|(((
--de.cau.cs.kieler.position
--)))|(((
--Object
--)))|(((
--Labels
--Nodes
--Ports
--)))|(((
  )))
--|(((
--Priority
--)))|(((
--de.cau.cs.kieler.priority
--)))|(((
--Int
--)))|(((
--Edges
--Nodes
--)))|(((
--
--)))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Randomization Seed
++Progress Bar
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.randomSeed
++de.cau.cs.kieler.progressBar
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Int
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Parents
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--Separate Connected Components
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--de.cau.cs.kieler.separateConnComp
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
  Boolean
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
@@ -455,72 +455,219 @@
  Parents
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--
++false
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Size Constraint
++Scale Factor
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.sizeConstraint
++de.cau.cs.kieler.scaleFactor
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--EnumSet
++Float
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  Nodes
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--
++1.0
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Size Options
++Thickness
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.sizeOptions
++de.cau.cs.kieler.thickness
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--EnumSet
++Float
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Nodes
++Edges
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--DEFAULT_MINIMUM_SIZE
++1.0
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--Spacing
++Zoom to Fit
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--de.cau.cs.kieler.spacing
++de.cau.cs.kieler.zoomToFit
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Float
++Boolean
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  Parents
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
---1.0
++false
  )))
--= The Most Important Options =
++=== Layout Output Properties ===
--**TODO:** Write a bit of documentation about the most important layout options and how to use them, possibly with a simple example or something.
++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.
--== Port Offset  ==
++== The Most Important Options ==
--{{id name="portOffset"/}}
++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.
--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.
++===  ===
++{{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.
++
++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.
++
++[[image:attach:layout_algorithm.png]]
++
++==== 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 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.
++)))
++* **Fixed Layout** - Does not compute a new layout, but leaves all nodes and edges where they are. If the Position and Bend Points options are set for the elements of the graph, the pre-defined layout is applied.
++* **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.
++
++===  ===
++
++{{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.
++
++The following diagram types are predefined:
++
++* **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.
++* **State Machine** - All kinds of state machines, automata, and activity diagrams. Examples: [[doc:SCCharts  SyncCharts]], UML Activity diagrams.
++* **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)]].
++* **Class Diagram** - Class diagrams such as Ecore diagrams for the [[EMF>>url:http://www.eclipse.org/modeling/emf/||shape="rect"]] or UML Class diagrams.
++* **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]].
++
++===  ===
++
++{{id name="edgeRouting"/}}Edge RoutingThis option influences the way in which edges are routed between the nodes they connect. The following settings are available:
++
++* 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.
++* SPLINES
++Edges are routed as splines (smooth curves).
++* UNDEFINED
++No particular edge routing style is selected. Usually this value points to the default setting of the selected layout algorithm.
++
++[[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 ==
++
++===  ===
++
++{{id name="addPortSpace"/}}Additional Port SpaceThis option controls additional port space left around the set of ports on each side:
++
++[[image:attach:addPortSpace.png]]
++
++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.
++
++===  ===
++
++{{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.
++
++===  ===
++
++{{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.
++
++===  ===
++
++{{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.
++
++[[image:attach:comment_box.png]]
++
++===  ===
++
++{{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.
++
++===  ===
++
++{{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.
++
++===  ===
++
++{{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.
++
++===  ===
++
++{{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.
++
++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:
++
++[[image:attach:KLay Layered Layout Options@port_anchors.png]]
++
++===  ===
++
++{{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.
++
  Set this property if one of the following cases applies:
  * The port constraints on a node are set to FREE, FIXED_SIDES or FIXED_ORDER.
  * 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.)
++
++===  ===
++
++{{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 @@
--7111110
++10751222

URL

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

Changes for page KIML Layout Options

Summary

Details

Navigation

Quick Links