Wiki source code of KLay Layered Layout Options

Last modified by Richard Kreissig on 2023/09/14 10:20

version	line-number	content
1.1	1	KLay Layered supports a whole bunch of layout options. Every single one of them is documented here.
	2
	3	Contents
	4
	5
	6
	7	{{toc/}}
	8
	9	= Overview =
	10
47.1	11	For a general introduction on layout options, see [[the KIML documentation>>doc:KIELER.Discontinued Projects.Infrastructure for Meta Layout (KIML).KIML Layout Options.WebHome]]. KLay Layered supports layout options defined by KIML and defines additional custom layout options.
1.1	12
	13	== Supported KIML Layout Options ==
	14
47.1	15	KLay Layered supports the following standard layout options defined by KIML. Note that the default value may be altered (highlighted yellow). These layout options are documented on [[KIML's Layout Options page>>doc:KIELER.Discontinued Projects.Infrastructure for Meta Layout (KIML).KIML Layout Options.WebHome]].
1.1	16
	17	\|=(((
	18	Option
	19	)))\|=(((
	20	ID
	21	)))\|=(((
	22	Type
	23	)))\|=(((
	24	Applies to
	25	)))\|=(((
	26	Default
	27	)))
28.1	28	\|(% colspan="1" %)(% colspan="1" %)
	29	(((
	30	Additional Port Space
	31	)))\|(% colspan="1" %)(% colspan="1" %)
	32	(((
	33	de.cau.cs.kieler.additionalPortSpace
	34	)))\|(% colspan="1" %)(% colspan="1" %)
	35	(((
	36	Margins
	37	)))\|(% colspan="1" %)(% colspan="1" %)
	38	(((
	39	Nodes
	40	)))\|(% colspan="1" %)(% colspan="1" %)
	41	(((
	42	0, 0, 0, 0
	43	)))
1.1	44	\|(((
	45	Alignment
	46	)))\|(((
	47	de.cau.cs.kieler.alignment
	48	)))\|(((
	49	Enum
	50	)))\|(((
	51	Nodes
	52	)))\|(((
	53	AUTOMATIC
	54	)))
	55	\|(((
	56	Aspect Ratio
	57	)))\|(((
	58	de.cau.cs.kieler.aspectRatio
	59	)))\|(((
	60	Float
	61	)))\|(((
	62	Parents
	63	)))\|(% class="highlight-yellow" data-highlight-colour="yellow" %)(% class="highlight-yellow" data-highlight-colour="yellow" %)
	64	(((
	65	1.6
	66	)))
	67	\|(((
	68	Border Spacing
	69	)))\|(((
	70	de.cau.cs.kieler.borderSpacing
	71	)))\|(((
	72	Float
	73	)))\|(((
	74	Parents
	75	)))\|(% class="highlight-yellow" data-highlight-colour="yellow" %)(% class="highlight-yellow" data-highlight-colour="yellow" %)
	76	(((
	77	20
	78	)))
	79	\|(% colspan="1" %)(% colspan="1" %)
	80	(((
14.1	81	Comment Box
1.1	82	)))\|(% colspan="1" %)(% colspan="1" %)
	83	(((
	84	de.cau.cs.kieler.commentBox
	85	)))\|(% colspan="1" %)(% colspan="1" %)
	86	(((
	87	Boolean
	88	)))\|(% colspan="1" %)(% colspan="1" %)
	89	(((
	90	Nodes
	91	)))\|(% colspan="1" %)(% colspan="1" %)
	92	(((
	93	false
	94	)))
	95	\|(((
	96	Debug Mode
	97	)))\|(((
	98	de.cau.cs.kieler.debugMode
	99	)))\|(((
	100	Boolean
	101	)))\|(((
	102	Parents
	103	)))\|(((
	104	false
	105	)))
	106	\|(% colspan="1" %)(% colspan="1" %)
	107	(((
	108	Diagram Type
	109	)))\|(% colspan="1" %)(% colspan="1" %)
	110	(((
	111	de.cau.cs.kieler.diagramType
	112	)))\|(% colspan="1" %)(% colspan="1" %)
	113	(((
	114	String
	115	)))\|(% colspan="1" %)(% colspan="1" %)
	116	(((
	117
	118	)))\|(% colspan="1" %)(% colspan="1" %)
	119	(((
	120
	121	)))
	122	\|(((
31.1	123	[[Direction>>doc:\|\|anchor="direction"]]
1.1	124	)))\|(((
	125	de.cau.cs.kieler.direction
	126	)))\|(((
	127	Enum
	128	)))\|(((
	129	Parents
31.1	130	)))\|(((
	131	UNDEFINED
1.1	132	)))
	133	\|(% colspan="1" %)(% colspan="1" %)
	134	(((
14.1	135	Edge Label Placement
1.1	136	)))\|(% colspan="1" %)(% colspan="1" %)
	137	(((
	138	de.cau.cs.kieler.edgeLabelPlacement
	139	)))\|(% colspan="1" %)(% colspan="1" %)
	140	(((
	141	Enum
	142	)))\|(% colspan="1" %)(% colspan="1" %)
	143	(((
	144	Labels
	145	)))\|(% colspan="1" %)(% colspan="1" %)
	146	(((
	147	UNDEFINED
	148	)))
	149	\|(((
	150	Edge Routing
	151	)))\|(((
	152	de.cau.cs.kieler.edgeRouting
	153	)))\|(((
	154	Enum
	155	)))\|(((
	156	Parents
	157	)))\|(% class="highlight-yellow" data-highlight-colour="yellow" %)(% class="highlight-yellow" data-highlight-colour="yellow" %)
	158	(((
42.1	159	ORTHOGONAL
1.1	160	)))
	161	\|(% colspan="1" %)(% colspan="1" %)
	162	(((
14.1	163	Hypernode
1.1	164	)))\|(% colspan="1" %)(% colspan="1" %)
	165	(((
	166	de.cau.cs.kieler.hypernode
	167	)))\|(% colspan="1" %)(% colspan="1" %)
	168	(((
	169	Boolean
	170	)))\|(% colspan="1" %)(% colspan="1" %)
	171	(((
	172	Nodes
	173	)))\|(% colspan="1" %)(% colspan="1" %)
	174	(((
	175	false
	176	)))
12.1	177	\|(% colspan="1" %)(% colspan="1" %)
	178	(((
	179	Label Side
	180	)))\|(% colspan="1" %)(% colspan="1" %)
	181	(((
	182	de.cau.cs.kieler.labelSide
	183	)))\|(% colspan="1" %)(% colspan="1" %)
	184	(((
	185	Enum
	186	)))\|(% colspan="1" %)(% colspan="1" %)
	187	(((
	188	Parents
	189	)))\|(% colspan="1" %)(% colspan="1" %)
	190	(((
	191	SMART
	192	)))
1.1	193	\|(((
14.1	194	Label Spacing
1.1	195	)))\|(((
	196	de.cau.cs.kieler.labelSpacing
	197	)))\|(((
	198	Float
	199	)))\|(((
	200	Edges
	201	Nodes
	202	)))\|(((
	203	-1.0
	204	)))
	205	\|(((
	206	Layout Hierarchy
	207	)))\|(((
	208	de.cau.cs.kieler.layoutHierarchy
	209	)))\|(((
	210	Boolean
	211	)))\|(((
	212	Parents
	213	)))\|(((
	214	false
	215	)))
	216	\|(% colspan="1" %)(% colspan="1" %)
	217	(((
14.1	218	Minimal Height
1.1	219	)))\|(% colspan="1" %)(% colspan="1" %)
	220	(((
	221	de.cau.cs.kieler.minHeight
	222	)))\|(% colspan="1" %)(% colspan="1" %)
	223	(((
	224	Float
	225	)))\|(% colspan="1" %)(% colspan="1" %)
	226	(((
	227	Nodes
	228	Parents
	229	)))\|(% colspan="1" %)(% colspan="1" %)
	230	(((
	231	0.0
	232	)))
	233	\|(% colspan="1" %)(% colspan="1" %)
	234	(((
14.1	235	Minimal Width
1.1	236	)))\|(% colspan="1" %)(% colspan="1" %)
	237	(((
	238	de.cau.cs.kieler.minWidth
	239	)))\|(% colspan="1" %)(% colspan="1" %)
	240	(((
	241	Float
	242	)))\|(% colspan="1" %)(% colspan="1" %)
	243	(((
	244	Nodes
	245	Parents
	246	)))\|(% colspan="1" %)(% colspan="1" %)
	247	(((
	248	0.0
	249	)))
	250	\|(% colspan="1" %)(% colspan="1" %)
	251	(((
14.1	252	No Layout
1.1	253	)))\|(% colspan="1" %)(% colspan="1" %)
	254	(((
	255	de.cau.cs.kieler.noLayout
	256	)))\|(% colspan="1" %)(% colspan="1" %)
	257	(((
	258	Boolean
	259	)))\|(% colspan="1" %)(% colspan="1" %)
	260	(((
	261
	262	)))\|(% colspan="1" %)(% colspan="1" %)
	263	(((
	264	false
	265	)))
	266	\|(% colspan="1" %)(% colspan="1" %)
	267	(((
	268	Node Label Placement
	269	)))\|(% colspan="1" %)(% colspan="1" %)
	270	(((
	271	de.cau.cs.kieler.nodeLabelPlacement
	272	)))\|(% colspan="1" %)(% colspan="1" %)
	273	(((
	274	EnumSet
	275	)))\|(% colspan="1" %)(% colspan="1" %)
	276	(((
	277	Nodes
	278	)))\|(% colspan="1" %)(% colspan="1" %)
	279	(((
	280
	281	)))
37.1	282	\|(% colspan="1" %)(% colspan="1" %)
	283	(((
	284	(% class="confluence-link" %)Port Anchor Offset
	285	)))\|(% colspan="1" %)(% colspan="1" %)
	286	(((
	287	de.cau.cs.kieler.klay.layered.portAnchor
	288	)))\|(% colspan="1" %)(% colspan="1" %)
	289	(((
	290	Object
	291	)))\|(% colspan="1" %)(% colspan="1" %)
	292	(((
	293	Ports
	294	)))\|(% colspan="1" %)(% colspan="1" %)
	295	(((
	296
	297	)))
1.1	298	\|(((
	299	Port Constraints
	300	)))\|(((
	301	de.cau.cs.kieler.portConstraints
	302	)))\|(((
	303	Enum
	304	)))\|(((
	305	Nodes
	306	)))\|(((
	307	UNDEFINED
	308	)))
	309	\|(% colspan="1" %)(% colspan="1" %)
	310	(((
	311	Port Label Placement
	312	)))\|(% colspan="1" %)(% colspan="1" %)
	313	(((
	314	de.cau.cs.kieler.portLabelPlacement
	315	)))\|(% colspan="1" %)(% colspan="1" %)
	316	(((
	317	Enum
	318	)))\|(% colspan="1" %)(% colspan="1" %)
	319	(((
	320	Nodes
	321	)))\|(% colspan="1" %)(% colspan="1" %)
	322	(((
	323	OUTSIDE
	324	)))
	325	\|(% colspan="1" %)(% colspan="1" %)
	326	(((
14.1	327	Port Offset
1.1	328	)))\|(% colspan="1" %)(% colspan="1" %)
	329	(((
	330	de.cau.cs.kieler.offset
	331	)))\|(% colspan="1" %)(% colspan="1" %)
	332	(((
	333	Float
	334	)))\|(% colspan="1" %)(% colspan="1" %)
	335	(((
	336	Ports
	337	)))\|(% colspan="1" %)(% colspan="1" %)
	338	(((
	339
	340	)))
	341	\|(% colspan="1" %)(% colspan="1" %)
	342	(((
14.1	343	Port Side
1.1	344	)))\|(% colspan="1" %)(% colspan="1" %)
	345	(((
	346	de.cau.cs.kieler.portSide
	347	)))\|(% colspan="1" %)(% colspan="1" %)
	348	(((
	349	Enum
	350	)))\|(% colspan="1" %)(% colspan="1" %)
	351	(((
	352	Ports
	353	)))\|(% colspan="1" %)(% colspan="1" %)
	354	(((
	355	UNDEFINED
	356	)))
28.1	357	\|(% colspan="1" %)(% colspan="1" %)
	358	(((
	359	Port Spacing
	360	)))\|(% colspan="1" %)(% colspan="1" %)
	361	(((
	362	de.cau.cs.kieler.portSpacing
	363	)))\|(% colspan="1" %)(% colspan="1" %)
	364	(((
	365	Float
	366	)))\|(% colspan="1" %)(% colspan="1" %)
	367	(((
	368	Nodes
30.1	369	)))\|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
28.1	370	(((
30.1	371	10
28.1	372	)))
1.1	373	\|(((
	374	Priority
	375	)))\|(((
	376	de.cau.cs.kieler.priority
	377	)))\|(((
	378	Int
	379	)))\|(((
	380	Edges
	381	Nodes
	382	)))\|(((
	383
	384	)))
	385	\|(% colspan="1" %)(% colspan="1" %)
	386	(((
	387	Randomization Seed
	388	)))\|(% colspan="1" %)(% colspan="1" %)
	389	(((
	390	de.cau.cs.kieler.randomSeed
	391	)))\|(% colspan="1" %)(% colspan="1" %)
	392	(((
	393	Int
	394	)))\|(% colspan="1" %)(% colspan="1" %)
	395	(((
	396	Parents
	397	)))\|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
	398	(((
	399	1
	400	)))
	401	\|(% colspan="1" %)(% colspan="1" %)
	402	(((
	403	Separate Connected Components
	404	)))\|(% colspan="1" %)(% colspan="1" %)
	405	(((
	406	de.cau.cs.kieler.separateConnComp
	407	)))\|(% colspan="1" %)(% colspan="1" %)
	408	(((
	409	Boolean
	410	)))\|(% colspan="1" %)(% colspan="1" %)
	411	(((
	412	Parents
	413	)))\|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
	414	(((
	415	true
	416	)))
	417	\|(% colspan="1" %)(% colspan="1" %)
	418	(((
	419	Size Constraint
	420	)))\|(% colspan="1" %)(% colspan="1" %)
	421	(((
	422	de.cau.cs.kieler.sizeConstraint
	423	)))\|(% colspan="1" %)(% colspan="1" %)
	424	(((
	425	EnumSet
	426	)))\|(% colspan="1" %)(% colspan="1" %)
	427	(((
	428	Nodes
	429	)))\|(% colspan="1" %)(% colspan="1" %)
	430	(((
	431
	432	)))
	433	\|(% colspan="1" %)(% colspan="1" %)
	434	(((
	435	Size Options
	436	)))\|(% colspan="1" %)(% colspan="1" %)
	437	(((
	438	de.cau.cs.kieler.sizeOptions
	439	)))\|(% colspan="1" %)(% colspan="1" %)
	440	(((
	441	EnumSet
	442	)))\|(% colspan="1" %)(% colspan="1" %)
	443	(((
	444	Nodes
	445	)))\|(% colspan="1" %)(% colspan="1" %)
	446	(((
	447	DEFAULT_MINIMUM_SIZE
	448	)))
	449	\|(% colspan="1" %)(% colspan="1" %)
	450	(((
	451	Spacing
	452	)))\|(% colspan="1" %)(% colspan="1" %)
	453	(((
	454	de.cau.cs.kieler.spacing
	455	)))\|(% colspan="1" %)(% colspan="1" %)
	456	(((
	457	Float
	458	)))\|(% colspan="1" %)(% colspan="1" %)
	459	(((
	460	Parents
	461	)))\|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
	462	(((
	463	20
	464	)))
	465
3.1	466	== Custom Layout Options ==
1.1	467
	468	\|=(((
	469	Option
	470	)))\|=(((
	471	ID
	472	)))\|=(((
	473	Type
	474	)))\|=(((
	475	Applies to
	476	)))\|=(((
	477	Default
9.1	478	)))\|=(% colspan="1" %)(% colspan="1" %)
	479	(((
	480	Dependency
1.1	481	)))
33.1	482	\|(% colspan="1" %)(% colspan="1" %)
	483	(((
	484	[[Add Unnecessary Bendpoints>>doc:\|\|anchor="addUnnecessaryBendpoints"]]
	485	)))\|(% colspan="1" %)(% colspan="1" %)
	486	(((
	487	de.cau.cs.kieler.klay.layered.unnecessaryBendpoints
	488	)))\|(% colspan="1" %)(% colspan="1" %)
	489	(((
	490	Boolean
	491	)))\|(% colspan="1" %)(% colspan="1" %)
	492	(((
	493	Parents
	494	)))\|(% colspan="1" %)(% colspan="1" %)
	495	(((
	496	false
	497	)))\|(% colspan="1" %)(% colspan="1" %)
	498	(((
	499
	500	)))
34.1	501	\|(% colspan="1" %)(% colspan="1" %)
	502	(((
36.1	503	[[Content Alignment>>doc:\|\|anchor="contentAlignment"]]
34.1	504	)))\|(% colspan="1" %)(% colspan="1" %)
	505	(((
	506	de.cau.cs.kieler.klay.layered.contentAlignment
	507	)))\|(% colspan="1" %)(% colspan="1" %)
	508	(((
	509	EnumSet
	510	)))\|(% colspan="1" %)(% colspan="1" %)
	511	(((
	512	Parents
	513	)))\|(% colspan="1" %)(% colspan="1" %)
	514	(((
	515	V_TOP, H_LEFT
	516	)))\|(% colspan="1" %)(% colspan="1" %)
	517	(((
	518
	519	)))
1.1	520	\|(((
15.1	521	[[Crossing Minimization>>doc:\|\|anchor="crossingMinimization"]]
1.1	522	)))\|(((
	523	de.cau.cs.kieler.klay.layered.crossMin
	524	)))\|(((
	525	Enum
	526	)))\|(((
	527	Parents
	528	)))\|(((
	529	LAYER_SWEEP
9.1	530	)))\|(% colspan="1" %)(% colspan="1" %)
	531	(((
	532
1.1	533	)))
	534	\|(((
6.1	535	[[Cycle Breaking>>doc:\|\|anchor="cycleBre"]]
1.1	536	)))\|(((
	537	de.cau.cs.kieler.klay.layered.cycleBreaking
	538	)))\|(((
	539	Enum
	540	)))\|(((
	541	Parents
	542	)))\|(((
	543	GREEDY
9.1	544	)))\|(% colspan="1" %)(% colspan="1" %)
	545	(((
	546
1.1	547	)))
	548	\|(((
6.1	549	[[Edge Spacing Factor>>doc:\|\|anchor="edgeSpacingFactor"]]
1.1	550	)))\|(((
	551	de.cau.cs.kieler.klay.layered.edgeSpacingFactor
	552	)))\|(((
	553	Float
	554	)))\|(((
	555	Parents
	556	)))\|(((
	557	0.5
9.1	558	)))\|(% colspan="1" %)(% colspan="1" %)
	559	(((
	560
1.1	561	)))
	562	\|(% colspan="1" %)(% colspan="1" %)
	563	(((
19.1	564	[[Edge Label Side Selection>>doc:\|\|anchor="edgeLabelSideSelection"]]
18.1	565	)))\|(% colspan="1" %)(% colspan="1" %)
	566	(((
	567	de.cau.cs.kieler.klay.layered.edgeLabelSideSelection
	568	)))\|(% colspan="1" %)(% colspan="1" %)
	569	(((
	570	Enum
	571	)))\|(% colspan="1" %)(% colspan="1" %)
	572	(((
	573	Parents
	574	)))\|(% colspan="1" %)(% colspan="1" %)
	575	(((
41.1	576	ALWAYS_DOWN
18.1	577	)))\|(% colspan="1" %)(% colspan="1" %)
	578	(((
	579
	580	)))
	581	\|(% colspan="1" %)(% colspan="1" %)
	582	(((
14.1	583	[[Feedback Edges>>doc:\|\|anchor="feedbackEdges"]]
1.1	584	)))\|(% colspan="1" %)(% colspan="1" %)
	585	(((
	586	de.cau.cs.kieler.klay.layered.feedBackEdges
	587	)))\|(% colspan="1" %)(% colspan="1" %)
	588	(((
	589	Boolean
	590	)))\|(% colspan="1" %)(% colspan="1" %)
	591	(((
	592	Parents
	593	)))\|(% colspan="1" %)(% colspan="1" %)
	594	(((
	595	false
9.1	596	)))\|(% colspan="1" %)(% colspan="1" %)
	597	(((
	598
1.1	599	)))
	600	\|(% colspan="1" %)(% colspan="1" %)
	601	(((
15.1	602	[[Fixed Alignment>>doc:\|\|anchor="fixedAlignment"]]
1.1	603	)))\|(% colspan="1" %)(% colspan="1" %)
	604	(((
	605	de.cau.cs.kieler.klay.layered.fixedAlignment
	606	)))\|(% colspan="1" %)(% colspan="1" %)
	607	(((
	608	Enum
	609	)))\|(% colspan="1" %)(% colspan="1" %)
	610	(((
	611	Parents
	612	)))\|(% colspan="1" %)(% colspan="1" %)
	613	(((
	614	NONE
9.1	615	)))\|(% colspan="1" %)(% colspan="1" %)
	616	(((
13.1	617	nodePlace=BRANDES_KOEPF
1.1	618	)))
	619	\|(% colspan="1" %)(% colspan="1" %)
	620	(((
15.1	621	[[Interactive Reference Point>>doc:\|\|anchor="interactiveReferencePoint"]]
1.1	622	)))\|(% colspan="1" %)(% colspan="1" %)
	623	(((
	624	de.cau.cs.kieler.klay.layered.interactiveReferencePoint
	625	)))\|(% colspan="1" %)(% colspan="1" %)
	626	(((
	627	Enum
	628	)))\|(% colspan="1" %)(% colspan="1" %)
	629	(((
	630	Parents
	631	)))\|(% colspan="1" %)(% colspan="1" %)
	632	(((
	633	CENTER
9.1	634	)))\|(% colspan="1" %)(% colspan="1" %)
	635	(((
	636
1.1	637	)))
	638	\|(% colspan="1" %)(% colspan="1" %)
	639	(((
14.1	640	[[Layer Constraint>>doc:\|\|anchor="layerConstraint"]]
1.1	641	)))\|(% colspan="1" %)(% colspan="1" %)
	642	(((
	643	de.cau.cs.kieler.klay.layered.layerConstraint
	644	)))\|(% colspan="1" %)(% colspan="1" %)
	645	(((
	646	Enum
	647	)))\|(% colspan="1" %)(% colspan="1" %)
	648	(((
	649	Nodes
	650	)))\|(% colspan="1" %)(% colspan="1" %)
	651	(((
	652	NONE
9.1	653	)))\|(% colspan="1" %)(% colspan="1" %)
	654	(((
	655
1.1	656	)))
	657	\|(% colspan="1" %)(% colspan="1" %)
	658	(((
29.1	659	[[Linear Segments Deflection Dampening>>doc:\|\|anchor="deflectionDampening"]]
	660	)))\|(% colspan="1" %)(% colspan="1" %)
	661	(((
	662	de.cau.cs.kieler.klay.layered.linearSegmentsDeflectionDampening
	663	)))\|(% colspan="1" %)(% colspan="1" %)
	664	(((
	665	Float
	666	)))\|(% colspan="1" %)(% colspan="1" %)
	667	(((
	668	Parents
	669	)))\|(% colspan="1" %)(% colspan="1" %)
	670	(((
	671	0.3
	672	)))\|(% colspan="1" %)(% colspan="1" %)
	673	(((
	674	nodePlace=LINEAR_SEGMENTS
	675	)))
	676	\|(% colspan="1" %)(% colspan="1" %)
	677	(((
15.1	678	[[Merge Edges>>doc:\|\|anchor="mergeEdges"]]
1.1	679	)))\|(% colspan="1" %)(% colspan="1" %)
	680	(((
32.1	681	de.cau.cs.kieler.klay.layered.mergeEdges
1.1	682	)))\|(% colspan="1" %)(% colspan="1" %)
	683	(((
	684	Boolean
	685	)))\|(% colspan="1" %)(% colspan="1" %)
	686	(((
	687	Parents
	688	)))\|(% colspan="1" %)(% colspan="1" %)
	689	(((
	690	false
9.1	691	)))\|(% colspan="1" %)(% colspan="1" %)
	692	(((
	693
1.1	694	)))
11.1	695	\|(% colspan="1" %)(% colspan="1" %)
	696	(((
15.1	697	[[Merge Hierarchy-Crossing Edges>>doc:\|\|anchor="mergeHierarchyEdges"]]
11.1	698	)))\|(% colspan="1" %)(% colspan="1" %)
	699	(((
	700	de.cau.cs.kieler.klay.layered.mergeHierarchyPorts
	701	)))\|(% colspan="1" %)(% colspan="1" %)
	702	(((
	703	Boolean
	704	)))\|(% colspan="1" %)(% colspan="1" %)
	705	(((
	706	Parents
	707	)))\|(% colspan="1" %)(% colspan="1" %)
	708	(((
	709	true
	710	)))\|(% colspan="1" %)(% colspan="1" %)
	711	(((
20.1	712	layoutHierarchy=true
11.1	713	)))
1.1	714	\|(((
14.1	715	[[Node Layering>>doc:\|\|anchor="nodeLayering"]]
1.1	716	)))\|(((
	717	de.cau.cs.kieler.klay.layered.nodeLayering
	718	)))\|(((
	719	Enum
	720	)))\|(((
	721	Parents
	722	)))\|(((
	723	NETWORK_SIMPLEX
9.1	724	)))\|(% colspan="1" %)(% colspan="1" %)
	725	(((
	726
1.1	727	)))
	728	\|(% colspan="1" %)(% colspan="1" %)
	729	(((
15.1	730	[[Node Placement>>doc:\|\|anchor="nodePlacement"]]
1.1	731	)))\|(% colspan="1" %)(% colspan="1" %)
	732	(((
	733	de.cau.cs.kieler.klay.layered.nodePlace
	734	)))\|(% colspan="1" %)(% colspan="1" %)
	735	(((
	736	Enum
	737	)))\|(% colspan="1" %)(% colspan="1" %)
	738	(((
	739	Parents
	740	)))\|(% colspan="1" %)(% colspan="1" %)
	741	(((
	742	BRANDES_KOEPF
9.1	743	)))\|(% colspan="1" %)(% colspan="1" %)
	744	(((
	745
1.1	746	)))
	747	\|(((
15.1	748	[[Thoroughness>>doc:\|\|anchor="thoroughness"]]
1.1	749	)))\|(((
	750	de.cau.cs.kieler.klay.layered.thoroughness
	751	)))\|(((
	752	Int
	753	)))\|(((
	754	Parents
	755	)))\|(((
42.1	756	10
9.1	757	)))\|(% colspan="1" %)(% colspan="1" %)
	758	(((
	759
1.1	760	)))
	761
	762	= Detailed Documentation =
	763
47.1	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.
1.1	765
49.1	766	== ==
33.1	767
40.1	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.
33.1	769
49.1	770	== ==
33.1	771
40.1	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.
34.1	773
49.1	774	{{info}}
35.1	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}}.
49.1	776	{{/info}}
35.1	777
49.1	778	== ==
4.1	779
40.1	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:
6.1	781
40.1	782	* {{code language="none"}}LAYER_SWEEP{{/code}}
4.1	783	The layer sweep algorithm iterates multiple times over the layers, trying to find node orderings that minimize the number of crossings. The algorithm uses randomization to increase the odds of finding a good result. To improve its results, consider increasing the //Thoroughness// option, which influences the number of iterations done. The //Randomization// seed also influences results.
40.1	784	* {{code language="none"}}INTERACTIVE{{/code}}
4.1	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
49.1	787	== ==
5.1	788
40.1	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:
6.1	790
40.1	791	* {{code language="none"}}GREEDY{{/code}}
5.1	792	This algorithm reverses edges greedily. The algorithm tries to avoid edges that have the //Priority// property set.
40.1	793	* {{code language="none"}}INTERACTIVE{{/code}}
5.1	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
49.1	796	== ==
31.1	797
40.1	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}}.
31.1	799
49.1	800	== ==
31.1	801
40.1	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.
31.1	803
6.1	804	[[image:attach:edgeSpacingFactor.png]]
	805
49.1	806	== ==
19.1	807
40.1	808	{{id name="edgeLabelSideSelection"/}}Edge Label Side SelectionDetermines how KLay Layered places edge labels. The following strategies are available:
19.1	809
40.1	810	* {{code language="none"}}ALWAYS_UP{{/code}}
26.1	811	Always places edge labels above the edge.
40.1	812	* {{code language="none"}}ALWAYS_DOWN{{/code}}
26.1	813	Always places edge labels below the edge.
40.1	814	* {{code language="none"}}DIRECTION_UP{{/code}}
26.1	815	Places edge labels above edges pointing right, and below edges pointing left.
40.1	816	* {{code language="none"}}DIRECTION_DOWN{{/code}}
26.1	817	Places edge labels below edges pointing right, and above edges pointing left.
40.1	818	* {{code language="none"}}SMART{{/code}}
26.1	819	Uses a heuristic that determines the best edge label placement, also taking the placement of port labels into account.
19.1	820
49.1	821	== ==
14.1	822
40.1	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.
14.1	824
21.1	825	With feedback edges:
	826
	827	[[image:attach:feedback_on.png]]
	828
	829	Without feedback edges:
	830
	831	[[image:attach:feedback_off.png]]
	832
49.1	833	== ==
14.1	834
40.1	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.
14.1	836
20.1	837	This option should usually be left alone.
14.1	838
49.1	839	== ==
4.1	840
40.1	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:
6.1	842
40.1	843	* {{code language="none"}}TOP_LEFT{{/code}}
4.1	844	The top left corner of a node is taken as the reference point.
40.1	845	* {{code language="none"}}CENTER{{/code}}
4.1	846	The center of a node is taken as the reference point.
	847
49.1	848	== ==
14.1	849
40.1	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.
14.1	851
25.1	852	[[image:attach:layer_constraints.png]]
9.1	853
49.1	854	{{info}}
25.1	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.
49.1	856	{{/info}}
25.1	857
49.1	858	== ==
29.1	859
40.1	860	{{id name="deflectionDampening"/}}Linear Segments Deflection Dampening
29.1	861
49.1	862	{{info}}
29.1	863	This is a very advanced layout option that you normally shouldn't worry about.
49.1	864	{{/info}}
29.1	865
	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
49.1	868	== ==
9.1	869
40.1	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.
9.1	871
49.1	872	== ==
9.1	873
40.1	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.
9.1	875
16.1	876	[[image:attach:merging.png]]
	877
49.1	878	== ==
14.1	879
40.1	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.
14.1	881
22.1	882	[[image:attach:merge_hierarchy_edges.png]]
	883
49.1	884	== ==
14.1	885
40.1	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:
14.1	887
40.1	888	* {{code language="none"}}NETWORK_SIMPLEX{{/code}}
17.1	889	This algorithm tries to minimize the length of edges. This is the most computationally intensive algorithm. The number of iterations after which it aborts if it hasn't found a result yet can be set with the [[Maximal Iterations>>doc:\|\|anchor="maximalInterations"]] option.
40.1	890	* {{code language="none"}}LONGEST_PATH{{/code}}
17.1	891	A very simple algorithm that distributes nodes along their longest path to a sink node.
40.1	892	* {{code language="none"}}INTERACTIVE{{/code}}
17.1	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
49.1	895	== ==
14.1	896
40.1	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:
14.1	898
38.1	899	* {{code language="none"}}BRANDES_KOEPF{{/code}}
23.1	900	Minimizes the number of edge bends at the expense of diagram size: diagrams drawn with this algorithm are usually higher than diagrams drawn with other algorithms.
38.1	901	* {{code language="none"}}LINEAR_SEGMENTS{{/code}}
23.1	902	Computes a balanced placement.
38.1	903	* {{code language="none"}}INTERACTIVE{{/code}}
	904	Tries to keep the preset y coordinates of nodes from the original layout. For dummy nodes, a guess is made to infer their coordinates. Requires the other interactive phase implementations to have run as well.
	905	* {{code language="none"}}SIMPLE{{/code}}
23.1	906	Minimizes the area at the expense of... well, pretty much everything else.
	907
49.1	908	== ==
4.1	909
40.1	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.