Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.als
	1	+XWiki.stu230980

Content

...	...	@@ -763,19 +763,19 @@
763	763
764	764	This section explains every layout option in more detail. See [[the KIML documentation>>doc:KIELER.Discontinued Projects.Infrastructure for Meta Layout (KIML).KIML Layout Options.WebHome]] for more information on KIML layout options. Those options are only mentioned here if KLay Layered adds some custom behavior.
765	765
766		-== ==
	766	+== ==
767	767
768	768	{{id name="addUnnecessaryBendpoints"/}}Add Unnecessary BendpointsBy default, KLay Layered tries not to add bendpoints to an edge at positions where the edge doesn't change direction since there's no real bend there. Turning this option on forces such bend points. More specifically, a bend point is added for each edge that spans more than one layer at the point where it crosses a layer. If hierarchy layout is turned on, a bend point is also added whenever the edge crosses a hierarchy boundary.
769	769
770		-== ==
	770	+== ==
771	771
772	772	{{id name="contentAlignment"/}}Content AlignmentDetermines how the content of compound nodes is to be aligned if the compound node's size exceeds the bounding box of the content (i.e. child nodes). This might be the case if for a compound node the size constraint of {{code language="none"}}MINIMUM_SIZE{{/code}} is set and the minimum width and height are set large enough.
773	773
774		-{{note}}
	774	+{{info}}
775	775	This option is not tested for external ports with port constraints {{code language="none"}}FIXED_RATIO{{/code}} or {{code language="none"}}FIXED_POS{{/code}}.
776		-{{/note}}
	776	+{{/info}}
777	777
778		-== ==
	778	+== ==
779	779
780	780	{{id name="crossingMinimization"/}}Crossing MinimizationCrossing minimization determines the ordering of nodes in each layer, which influences the number of edge crossings. This option switches between one of several algorithms that can be used to minimize crossings. Possible values are:
781	781
...	...	@@ -784,7 +784,7 @@
784	784	* {{code language="none"}}INTERACTIVE{{/code}}
785	785	Orders the nodes of each layer by comparing their positions before the layout algorithm was started. The idea is that the relative order of nodes as it was before layout was applied is not changed. This of course requires valid positions for all nodes to have been set on the input graph before calling the layout algorithm. The interactive layer sweep algorithm uses the //Interactive Reference Point// option to determine which reference point of nodes are used to compare positions.
786	786
787		-== ==
	787	+== ==
788	788
789	789	{{id name="cycleBreaking"/}}Cycle BreakingKLay Layered tries to position nodes in a way that all edges point rightwards. This is not possible if the input graph has cycles. Such cycles have to be broken by reversing as few edges as possible. The reversed edges end up pointing leftwards in the resulting diagram. There are different cycle breaking algorithms available:
790	790
...	...	@@ -793,17 +793,17 @@
793	793	* {{code language="none"}}INTERACTIVE{{/code}}
794	794	The interactive algorithm tries to reverse edges that already pointed leftwards in the input graph. This requires node and port coordinates to have been set to sensible values.
795	795
796		-== ==
	796	+== ==
797	797
798	798	{{id name="direction"/}}DirectionThe layout direction influences where the majority of edges in the final layout will point to. With data flow diagrams, this will usually be to the right. With control flow diagrams, it might be downwards. The layout direction defaults to {{code language="none"}}UNDEFINED{{/code}}. This causes KLay Layered to calculate a layout direction based on the {{code language="none"}}ASPECT_RATIO{{/code}} setting. As of now, if the aspect ratio is >=1 (that is, if the diagram should be wider than it is high), the direction is set to {{code language="none"}}RIGHT{{/code}}. Otherwise, it is set to {{code language="none"}}DOWN{{/code}}.
799	799
800		-== ==
	800	+== ==
801	801
802	802	{{id name="edgeSpacingFactor"/}}Edge Spacing FactorThe edge spacing factor determines the amount of space between edges, relative to the regular //Spacing// value. The idea is that we don't need as much space between edges as we do between nodes.
803	803
804	804	[[image:attach:edgeSpacingFactor.png]]
805	805
806		-== ==
	806	+== ==
807	807
808	808	{{id name="edgeLabelSideSelection"/}}Edge Label Side SelectionDetermines how KLay Layered places edge labels. The following strategies are available:
809	809
...	...	@@ -818,7 +818,7 @@
818	818	* {{code language="none"}}SMART{{/code}}
819	819	Uses a heuristic that determines the best edge label placement, also taking the placement of port labels into account.
820	820
821		-== ==
	821	+== ==
822	822
823	823	{{id name="feedbackEdges"/}}Feedback EdgesFeedback edges are edges that feed the output of a node back to be the input of a previous node. This option controls how feedback edges are routed if port constraints are FREE. This influences how much emphasis is put on feedback edges.
824	824
...	...	@@ -830,13 +830,13 @@
830	830
831	831	[[image:attach:feedback_off.png]]
832	832
833		-== ==
	833	+== ==
834	834
835	835	{{id name="fixedAlignment"/}}Fixed AlignmentThe {{code language="none"}}BRANDES_KOEPF{{/code}} node placement algorithm computes several different node placements. One of the placements is chosen by the algorithm, usually the one that takes the least amount of space. With this option, a particular result can be chosen.
836	836
837	837	This option should usually be left alone.
838	838
839		-== ==
	839	+== ==
840	840
841	841	{{id name="interactiveReferencePoint"/}}Interactive Reference PointInteractive layering, crossing minimization, and cycle breaking algorithms use node positions to sort nodes into layers or to determine the order of nodes in each layer. However, it is unclear if for example the top left corners of nodes should be compared, or the bottom left corners — different settings might lead to different results. The interactive reference point determines which part of nodes is used to compare their positions. It provides the following settings:
842	842
...	...	@@ -845,43 +845,43 @@
845	845	* {{code language="none"}}CENTER{{/code}}
846	846	The center of a node is taken as the reference point.
847	847
848		-== ==
	848	+== ==
849	849
850	850	{{id name="layerConstraint"/}}Layer ConstraintThe layer a node is placed in is usually computed by the layer assignment algorithms. However, sometimes certain nodes need to be placed in the first or in the last layer (for example, nodes that represent inputs from the outside). The layer constraint option can be set on such nodes to do just that.
851	851
852	852	[[image:attach:layer_constraints.png]]
853	853
854		-{{note}}
	854	+{{info}}
855	855	This option can also be set to {{code language="none"}}FIRST_SEPARATE{{/code}} and {{code language="none"}}LAST_SEPARATE{{/code}}. These are for internal use only and should not have been publicly exposed in the first place. Using them can result in layout problems.
856		-{{/note}}
	856	+{{/info}}
857	857
858		-== ==
	858	+== ==
859	859
860	860	{{id name="deflectionDampening"/}}Linear Segments Deflection Dampening
861	861
862		-{{note}}
	862	+{{info}}
863	863	This is a very advanced layout option that you normally shouldn't worry about.
864		-{{/note}}
	864	+{{/info}}
865	865
866	866	The linear segments node placer can sometimes place nodes in a way that results in unnecessarily large diagrams. This option dampens how much the nodes are moved around. A dampening factor of 1.0 disables dampening and just lets the node placer do what it wants. A more conservative dampening factor of 0.3 (the default) restricts the freedom of the node placer a bit more.
867	867
868		-== ==
	868	+== ==
869	869
870	870	{{id name="maximalIterations"/}}Maximal IterationsDelimits the amount of depth-first-search iterations performed by the network simplex layering strategy. Large, highly connected graphs might require a long time to be processed. This property serves as a timeout after which an exception is raised.
871	871
872		-== ==
	872	+== ==
873	873
874	874	{{id name="mergeEdges"/}}Merge EdgesIn the KGraph model, edges can either connect to nodes through ports or directly. In the latter case, KLay Layered will introduce a virtual port for each edge, which results in all edges connecting to the node at different points in the final drawing. If this option is switched on, KLay Layered will only generate up to one input and one output port for each node. The option is set on a parent node and applies to all of its children, but not to the parent node itself.
875	875
876	876	[[image:attach:merging.png]]
877	877
878		-== ==
	878	+== ==
879	879
880	880	{{id name="mergeHierarchyEdges"/}}Merge Hierarchy-Crossing EdgesIf hierarchical layout is active, this option is the hierarchical equivalent to //Merge Edges//. If set to true on a compound node, all hierarchy-crossing edges that start or end inside that compound node are eligible for merging.
881	881
882	882	[[image:attach:merge_hierarchy_edges.png]]
883	883
884		-== ==
	884	+== ==
885	885
886	886	{{id name="nodeLayering"/}}Node LayeringDecides which algorithm is used to compute the layer each node is placed in. We have different algorithms available, with different optimization goals:
887	887
...	...	@@ -892,7 +892,7 @@
892	892	* {{code language="none"}}INTERACTIVE{{/code}}
893	893	Distributes the nodes into layers by comparing their positions before the layout algorithm was started. The idea is that the relative horizontal order of nodes as it was before layout was applied is not changed. This of course requires valid positions for all nodes to have been set on the input graph before calling the layout algorithm. The interactive node layering algorithm uses the //Interactive Reference Point// option to determine which reference point of nodes are used to compare positions.
894	894
895		-== ==
	895	+== ==
896	896
897	897	{{id name="nodePlacement"/}}Node PlacementDecides which algorithm is used to compute the y coordinate of each node. This influences the length of edges, the number of edge bends, and the height of the diagram. We have different algorithms available, with different optimization goals:
898	898
...	...	@@ -905,6 +905,6 @@
905	905	* {{code language="none"}}SIMPLE{{/code}}
906	906	Minimizes the area at the expense of... well, pretty much everything else.
907	907
908		-== ==
	908	+== ==
909	909
910	910	{{id name="thoroughness"/}}ThoroughnessThere are heuristics in use all over KLay Layered whose results often improve with the number of iterations computed. The thoroughness is a measure for telling KLay Layered to compute more iterations to improve the quality of results, at the expense of performance.