Skip to Content

Changes for page KIML Layout Options

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
From version 18.1
edited by msp
on 2014/03/07 17:04
Change comment: There is no comment for this version
To version 20.1
edited by msp
on 2014/03/08 20:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,8 +1,6 @@
1 -{{warning}}
2 -This is preliminary and incomplete documentation. You've been warned.
3 -{{/warning}}
1 +
4 4  
5 -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.
3 +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.
6 6  
7 7  **Contents**
8 8  
... ... @@ -16,7 +16,7 @@
16 16  
17 17  * An ID to identify them.
18 18  * 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.
19 -* 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.
17 +* 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.
20 20  * 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.
21 21  
22 22  Layout options can be assigned to two main categories: user options and programmatic options.
... ... @@ -349,6 +349,54 @@
349 349  )))|=(((
350 350  Default
351 351  )))
350 +|(% colspan="1" %)(% colspan="1" %)
351 +(((
352 +Animate
353 +)))|(% colspan="1" %)(% colspan="1" %)
354 +(((
355 +de.cau.cs.kieler.animate
356 +)))|(% colspan="1" %)(% colspan="1" %)
357 +(((
358 +Boolean
359 +)))|(% colspan="1" %)(% colspan="1" %)
360 +(((
361 +Parents
362 +)))|(% colspan="1" %)(% colspan="1" %)
363 +(((
364 +true
365 +)))
366 +|(% colspan="1" %)(% colspan="1" %)
367 +(((
368 +Animation Time Factor
369 +)))|(% colspan="1" %)(% colspan="1" %)
370 +(((
371 +de.cau.cs.kieler.animTimeFactor
372 +)))|(% colspan="1" %)(% colspan="1" %)
373 +(((
374 +Int
375 +)))|(% colspan="1" %)(% colspan="1" %)
376 +(((
377 +Parents
378 +)))|(% colspan="1" %)(% colspan="1" %)
379 +(((
380 +100
381 +)))
382 +|(% colspan="1" %)(% colspan="1" %)
383 +(((
384 +Comment Box
385 +)))|(% colspan="1" %)(% colspan="1" %)
386 +(((
387 +de.cau.cs.kieler.commentBox
388 +)))|(% colspan="1" %)(% colspan="1" %)
389 +(((
390 +Boolean
391 +)))|(% colspan="1" %)(% colspan="1" %)
392 +(((
393 +Nodes
394 +)))|(% colspan="1" %)(% colspan="1" %)
395 +(((
396 +false
397 +)))
352 352  |(((
353 353  [[Diagram Type>>doc:||anchor="diagramType"]]
354 354  )))|(((
... ... @@ -437,6 +437,54 @@
437 437  )))
438 438  |(% colspan="1" %)(% colspan="1" %)
439 439  (((
486 +Layout Ancestors
487 +)))|(% colspan="1" %)(% colspan="1" %)
488 +(((
489 +de.cau.cs.kieler.layoutAncestors
490 +)))|(% colspan="1" %)(% colspan="1" %)
491 +(((
492 +Boolean
493 +)))|(% colspan="1" %)(% colspan="1" %)
494 +(((
495 +Parents
496 +)))|(% colspan="1" %)(% colspan="1" %)
497 +(((
498 +false
499 +)))
500 +|(% colspan="1" %)(% colspan="1" %)
501 +(((
502 +Maximal Animation Time
503 +)))|(% colspan="1" %)(% colspan="1" %)
504 +(((
505 +de.cau.cs.kieler.maxAnimTim
506 +)))|(% colspan="1" %)(% colspan="1" %)
507 +(((
508 +Int
509 +)))|(% colspan="1" %)(% colspan="1" %)
510 +(((
511 +Parents
512 +)))|(% colspan="1" %)(% colspan="1" %)
513 +(((
514 +4000
515 +)))
516 +|(% colspan="1" %)(% colspan="1" %)
517 +(((
518 +Minimal Animation Time
519 +)))|(% colspan="1" %)(% colspan="1" %)
520 +(((
521 +de.cau.cs.kieler.minAnimTim
522 +)))|(% colspan="1" %)(% colspan="1" %)
523 +(((
524 +Int
525 +)))|(% colspan="1" %)(% colspan="1" %)
526 +(((
527 +Parents
528 +)))|(% colspan="1" %)(% colspan="1" %)
529 +(((
530 +400
531 +)))
532 +|(% colspan="1" %)(% colspan="1" %)
533 +(((
440 440  Minimal Height
441 441  )))|(% colspan="1" %)(% colspan="1" %)
442 442  (((
... ... @@ -487,6 +487,22 @@
487 487  )))
488 488  |(% colspan="1" %)(% colspan="1" %)
489 489  (((
584 +Port Index
585 +)))|(% colspan="1" %)(% colspan="1" %)
586 +(((
587 +de.cau.cs.kieler.portIndex
588 +)))|(% colspan="1" %)(% colspan="1" %)
589 +(((
590 +Int
591 +)))|(% colspan="1" %)(% colspan="1" %)
592 +(((
593 +Ports
594 +)))|(% colspan="1" %)(% colspan="1" %)
595 +(((
596 +
597 +)))
598 +|(% colspan="1" %)(% colspan="1" %)
599 +(((
490 490  [[Port Offset>>doc:||anchor="portOffset"]]
491 491  )))|(% colspan="1" %)(% colspan="1" %)
492 492  (((
... ... @@ -517,7 +517,89 @@
517 517  (((
518 518  
519 519  )))
630 +|(% colspan="1" %)(% colspan="1" %)
631 +(((
632 +Progress Bar
633 +)))|(% colspan="1" %)(% colspan="1" %)
634 +(((
635 +de.cau.cs.kieler.progressBar
636 +)))|(% colspan="1" %)(% colspan="1" %)
637 +(((
638 +Boolean
639 +)))|(% colspan="1" %)(% colspan="1" %)
640 +(((
641 +Parents
642 +)))|(% colspan="1" %)(% colspan="1" %)
643 +(((
644 +false
645 +)))
646 +|(% colspan="1" %)(% colspan="1" %)
647 +(((
648 +Scale Factor
649 +)))|(% colspan="1" %)(% colspan="1" %)
650 +(((
651 +de.cau.cs.kieler.scaleFactor
652 +)))|(% colspan="1" %)(% colspan="1" %)
653 +(((
654 +Float
655 +)))|(% colspan="1" %)(% colspan="1" %)
656 +(((
657 +Nodes
658 +)))|(% colspan="1" %)(% colspan="1" %)
659 +(((
660 +1.0
661 +)))
662 +|(% colspan="1" %)(% colspan="1" %)
663 +(((
664 +Zoom to Fit
665 +)))|(% colspan="1" %)(% colspan="1" %)
666 +(((
667 +de.cau.cs.kieler.zoomToFit
668 +)))|(% colspan="1" %)(% colspan="1" %)
669 +(((
670 +Boolean
671 +)))|(% colspan="1" %)(% colspan="1" %)
672 +(((
673 +Parents
674 +)))|(% colspan="1" %)(% colspan="1" %)
675 +(((
676 +false
677 +)))
520 520  
679 +=== Layout Output Properties ===
680 +
681 +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
682 +
683 +|=(((
684 +Property
685 +)))|=(((
686 +ID
687 +)))|=(((
688 +Type
689 +)))|=(((
690 +Applies to
691 +)))
692 +|(((
693 +[[Edge Routing>>doc:||anchor="edgeRouting"]]
694 +)))|(((
695 +de.cau.cs.kieler.edgeRouting
696 +)))|(((
697 +Enum
698 +)))|(((
699 +Edges
700 +)))
701 +|(((
702 +Junction Points
703 +)))|(((
704 +de.cau.cs.kieler.junctionPoints
705 +)))|(((
706 +Object
707 +)))|(((
708 +Edges
709 +)))
710 +
711 +
712 +
521 521  = Detailed Documentation =
522 522  
523 523  == The Most Important Options ==
... ... @@ -528,19 +528,15 @@
528 528  
529 529  {{id name="layoutAlgorithm"/}}
530 530  
531 -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.
723 +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 option is active.
532 532  
533 -The following layout types are predefined:
725 +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.
534 534  
535 -* **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.
536 -* **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.
537 -* **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
538 -* **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.
539 -* **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.
727 +[[image:attach:layout_algorithm.png]]
540 540  
541 541  === Available Algorithms and Libraries ===
542 542  
543 -* **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.
731 +* **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.
544 544  * **Randomizer** - Distributes the nodes randomly; not very useful, but it can show how important a good layout is for understanding a graph.
545 545  * (((
546 546  **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 @@
549 549  * **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.
550 550  * **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.
551 551  
740 +=== Predefined Layout Types ===
741 +
742 +* **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.
743 +* **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.
744 +* **Force** - Layout algorithms that follow physical analogies by simulating a system of attractive and repulsive forces.
745 +* **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.
746 +* **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.
747 +
552 552  === Diagram Type ===
553 553  
554 554  {{id name="diagramType"/}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470010
1 +9470014
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470010/KIML Layout Options
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470014/KIML Layout Options