SeriesParallelLayout (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.layout.MultiStageLayout
- - com.yworks.yfiles.layout.seriesparallel.SeriesParallelLayout

All Implemented Interfaces:

ILayoutAlgorithm
```
public class SeriesParallelLayout
extends MultiStageLayout
```
This layout algorithm arranges series-parallel graphs.

Layout Style
Series-parallel graphs are directed graphs with a single source (node without incoming edges) and a single sink (node without outgoing edges). The layout algorithm highlights the main layout direction (from source to sink). It also emphasizes the paths through the graph because edges are routed with few bends.

SeriesParallelLayout is suitable for the visualization of circuits, call trees or flowcharts.

Concept
Series-parallel graphs are directed graphs with a single source (node without incoming edges) and a single sink (node without outgoing edges) that are built using only the following two rules:
1. Series composition: The source of a subgraph is merged with the sink of a second subgraph.
2. Parallel composition: The sources and sinks of two subgraphs are merged.
From the recursive structure of series-parallel graphs, the layout algorithm retrieves a decomposition tree where each node represents one of the decomposition types. Then, this tree is traversed recursively from bottom to top, aligning subgraphs above (series) or next to (parallel) each other until the whole graph is arranged. The edges are routed when both end nodes are placed. Different routing styles can be used.

To avoid moving all nodes several times and to be aware of the area that the subtrees occupy, the layout algorithm keeps track of the shape of the subtrees. These shapes are moved and merged during the layout calculation. The layout algorithm also stores the connections between nodes and nodes that haven't already been placed in these shapes.

Features

SeriesParallelLayout can take strong PortConstraints into account. It will connect the edges to the specified locations, the directions, however, will be ignored.

Grouping of nodes can also be handled by this layout algorithm. It is important that a group node contains a whole series-parallel subgraph. Otherwise, the group nodes may overlap with each other or with other nodes. Edges which are connected to non-empty group nodes are not allowed. Furthermore, the user may specify minimum size constraints for each group node using IDataProvider key GroupingKeys.MINIMUM_NODE_SIZE_DPKEY.

The layout algorithm can be configured to reserve space for node labels and to place the edge labels along the edge such that the labels won't overlap with other graph elements. Edge labels are placed according to the information stored in a PreferredPlacementDescriptor instance. However, labels that should be centered between source and target are placed close to the target node, unless this edge connects to the local source and sink of a subgraph.

Parallel subgraphs can be aligned in different ways. Depending on the node sizes, a different alignment can increase the compactness of the layout.

The way in which edges are distributed around their incident nodes is computed by an instance of IPortAssignment. The default assignment is able to consider PortConstraints and edge groups.

The From Sketch mode allows to take the initial locations of the nodes into account. However, the layout algorithm won't insert crossings because it maintains the order of children of each node.

SeriesParallelLayout supports custom sorting of the outgoing edges of a node. A Comparator can be assigned individually for the nodes using a IDataProvider registered with key OUT_EDGE_COMPARATOR_DPKEY. For all nodes for which the IDataProvider returns null, the layout algorithm falls back to the default comparator.

By default, this layout algorithm can only handle graphs with a series-parallel structure. To apply it to a general graph, general graph handling needs to be activated. Then, the layout algorithm will temporarily add and/or remove some edges from the input graph until a series-parallel graph is obtained. The edges that were removed will be routed separately afterwards.

Field Summary

Fields
Modifier and Type	Field and Description
`static EdgeDpKey<EdgeLayoutDescriptor>`	`EDGE_LAYOUT_DESCRIPTOR_DPKEY` A `DataProvider` key for storing individual settings for edges If no edge layout descriptor is mapped for an edge, a default edge layout descriptor will be obtained by method `DefaultEdgeLayoutDescriptor`.
`static IEdgeLabelLayoutDpKey<Boolean>`	`NON_SERIES_PARALLEL_EDGE_LABELS_DPKEY` A `DataProvider` key for marking edge labels of non-series-parallel edges
`static NodeDpKey<Comparator<Object>>`	`OUT_EDGE_COMPARATOR_DPKEY` A `DataProvider` key for assigning different orderings for outgoing edges of the nodes If the `Comparator` associated with a node is `null`, the outgoing edges maintain their initial order.
`static NodeDpKey<IPortAssignment>`	`PORT_ASSIGNMENT_DPKEY` A `DataProvider` key for providing an individual port distribution at nodes If there is no `IPortAssignment` specified for a node, the layout algorithm uses the `default assignment`.

Constructor Summary

Constructors
Constructor and Description

SeriesParallelLayout()
Creates a new SeriesParallelLayout instance with default settings.

Constructors
Constructor and Description
`SeriesParallelLayout()` Creates a new `SeriesParallelLayout` instance with default settings.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyLayoutCore(LayoutGraph graph)` Calculates a series-parallel layout for the given graph.
`EdgeLayoutDescriptor`	`getDefaultEdgeLayoutDescriptor()` Gets the `EdgeLayoutDescriptor` instance used for all those edges that do not have a specific layout descriptor assigned.
`Comparator<Object>`	`getDefaultOutEdgeComparator()` Gets the default `Comparator` used for sorting the outgoing edges incident to nodes that do not have a specific `Comparator`.
`IPortAssignment`	`getDefaultPortAssignment()` Gets the default `IPortAssignment` used for those nodes that do not have their own specific instance.
`double`	`getMinimumEdgeToEdgeDistance()` Gets the minimum distance between edges.
`double`	`getMinimumNodeToEdgeDistance()` Gets the minimum distance between nodes and edges.
`double`	`getMinimumNodeToNodeDistance()` Gets the minimum distance between nodes.
`double`	`getMinimumPolylineSegmentLength()` Gets the minimum vertical distance of the edge segments that are not orthogonal.
`double`	`getMinimumSlope()` Gets the minimum slope which a non-orthogonal edge segment should have.
`ILayoutAlgorithm`	`getNonSeriesParallelEdgeLabelingAlgorithm()` Gets the labeling algorithm that is applied to all edge labels that belong to non-series-parallel edges.
`Object`	`getNonSeriesParallelEdgeLabelSelectionKey()` Gets the key to register a `IDataProvider` that is used by the `non-series-parallel edge labeling algorithm` to determine which edge labels it should place.
`ILayoutAlgorithm`	`getNonSeriesParallelEdgeRouter()` Gets the edge routing algorithm used for the edges of a general graph that are not part of the series-parallel subgraph whose layout is calculated.
`Object`	`getNonSeriesParallelEdgesDpKey()` Gets the key to register a `IDataProvider` that is used for marking non-series-parallel edges.
`double`	`getPreferredOctilinearSegmentLength()` Gets the preferred length for non-orthogonal segments in octilinear edge routes.
`RoutingStyle`	`getRoutingStyle()` Gets the currently used routing style for edges.
`double`	`getVerticalAlignment()` Gets the vertical alignment of parallel subgraphs.
`boolean`	`isConsiderNodeLabels()` Gets whether or not the layout algorithm reserves space for node labels to avoid overlaps.
`boolean`	`isFromSketchMode()` Gets whether or not to take the coordinates of the input diagram into account when arranging the nodes.
`boolean`	`isGeneralGraphHandling()` Gets whether or not the layout algorithm can handle general graphs.
`boolean`	`isIntegratedEdgeLabeling()` Gets whether or not the layout algorithm will place edge labels and reserve space for them.
`static boolean`	`isSeriesParallelGraph(Graph graph)` Determines whether or not the given graph has a series-parallel structure.
`void`	`setComponentLayoutEnabled(boolean value)` Sets whether or not the `ILayoutStage` used for arranging the components of the graph is activated.
`void`	`setConsiderNodeLabels(boolean value)` Sets whether or not the layout algorithm reserves space for node labels to avoid overlaps.
`void`	`setDefaultEdgeLayoutDescriptor(EdgeLayoutDescriptor value)` Sets the `EdgeLayoutDescriptor` instance used for all those edges that do not have a specific layout descriptor assigned.
`void`	`setDefaultOutEdgeComparator(Comparator<Object> value)` Sets the default `Comparator` used for sorting the outgoing edges incident to nodes that do not have a specific `Comparator`.
`void`	`setDefaultPortAssignment(IPortAssignment value)` Sets the default `IPortAssignment` used for those nodes that do not have their own specific instance.
`void`	`setFromSketchMode(boolean value)` Sets whether or not to take the coordinates of the input diagram into account when arranging the nodes.
`void`	`setGeneralGraphHandling(boolean value)` Sets whether or not the layout algorithm can handle general graphs.
`void`	`setIntegratedEdgeLabeling(boolean value)` Sets whether or not the layout algorithm will place edge labels and reserve space for them.
`void`	`setMinimumEdgeToEdgeDistance(double value)` Sets the minimum distance between edges.
`void`	`setMinimumNodeToEdgeDistance(double value)` Sets the minimum distance between nodes and edges.
`void`	`setMinimumNodeToNodeDistance(double value)` Sets the minimum distance between nodes.
`void`	`setMinimumPolylineSegmentLength(double value)` Sets the minimum vertical distance of the edge segments that are not orthogonal.
`void`	`setMinimumSlope(double value)` Sets the minimum slope which a non-orthogonal edge segment should have.
`void`	`setNonSeriesParallelEdgeLabelingAlgorithm(ILayoutAlgorithm value)` Sets the labeling algorithm that is applied to all edge labels that belong to non-series-parallel edges.
`void`	`setNonSeriesParallelEdgeLabelSelectionKey(Object value)` Sets the key to register a `IDataProvider` that is used by the `non-series-parallel edge labeling algorithm` to determine which edge labels it should place.
`void`	`setNonSeriesParallelEdgeRouter(ILayoutAlgorithm value)` Sets the edge routing algorithm used for the edges of a general graph that are not part of the series-parallel subgraph whose layout is calculated.
`void`	`setNonSeriesParallelEdgesDpKey(Object value)` Sets the key to register a `IDataProvider` that is used for marking non-series-parallel edges.
`void`	`setPreferredOctilinearSegmentLength(double value)` Sets the preferred length for non-orthogonal segments in octilinear edge routes.
`void`	`setRoutingStyle(RoutingStyle value)` Sets the currently used routing style for edges.
`void`	`setSelfLoopRouterEnabled(boolean value)` Sets whether or not the `ILayoutStage` used for routing self-loops is activated.
`void`	`setVerticalAlignment(double value)` Sets the vertical alignment of parallel subgraphs.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EDGE_LAYOUT_DESCRIPTOR_DPKEY
```
public static final EdgeDpKey<EdgeLayoutDescriptor> EDGE_LAYOUT_DESCRIPTOR_DPKEY
```
    A DataProvider key for storing individual settings for edges
    If no edge layout descriptor is mapped for an edge, a default edge layout descriptor will be obtained by method DefaultEdgeLayoutDescriptor.
    
    See Also:
    
    getDefaultEdgeLayoutDescriptor()
  - NON_SERIES_PARALLEL_EDGE_LABELS_DPKEY
```
public static final IEdgeLabelLayoutDpKey<Boolean> NON_SERIES_PARALLEL_EDGE_LABELS_DPKEY
```
    A DataProvider key for marking edge labels of non-series-parallel edges
    
    This key only serves as default value for property NonSeriesParallelEdgeLabelSelectionKey. During the layout, a IDataProvider marking the non-series-parallel edges will automatically be registered with the graph. Thus, data provided by the user registered with this specific key is ignored.
    
    See Also:
    
    setNonSeriesParallelEdgeLabelSelectionKey(Object), setNonSeriesParallelEdgeLabelingAlgorithm(ILayoutAlgorithm)
  - OUT_EDGE_COMPARATOR_DPKEY
```
public static final NodeDpKey<Comparator<Object>> OUT_EDGE_COMPARATOR_DPKEY
```
    A DataProvider key for assigning different orderings for outgoing edges of the nodes
    If the Comparator associated with a node is null, the outgoing edges maintain their initial order.
    
    For general graphs, the Comparators are only used for the series-parallel part of the graph. Non-series-parallel edges are not included and will be routed by the edge router for non-series-parallel edges.
    
    The order cannot be maintained in all cases because the target nodes may not be completely independent.
    
    See Also:
    
    getDefaultOutEdgeComparator()
  - PORT_ASSIGNMENT_DPKEY
```
public static final NodeDpKey<IPortAssignment> PORT_ASSIGNMENT_DPKEY
```
    A DataProvider key for providing an individual port distribution at nodes
    If there is no IPortAssignment specified for a node, the layout algorithm uses the default assignment.
    
    See Also:
    
    getDefaultPortAssignment()
- Constructor Detail
  - SeriesParallelLayout
```
public SeriesParallelLayout()
```
    Creates a new SeriesParallelLayout instance with default settings.
- Method Detail
  - applyLayoutCore
```
public void applyLayoutCore(LayoutGraph graph)
```
    Calculates a series-parallel layout for the given graph.
    
    Specified by:
    
    applyLayoutCore in class MultiStageLayout
    
    Throws:
    
    InvalidGraphStructureException - if the graph is not series-parallel
    
    Parameters:
    
    graph - the input graph
  - getDefaultEdgeLayoutDescriptor
```
public EdgeLayoutDescriptor getDefaultEdgeLayoutDescriptor()
```
    Gets the EdgeLayoutDescriptor instance used for all those edges that do not have a specific layout descriptor assigned.
    
    Throws:
    
    IllegalArgumentException - if the specified EdgeLayoutDescriptor is null
    
    Default Value:
    The default value is EdgeLayoutDescriptor
    
    Returns:
    
    the current EdgeLayoutDescriptor instance
    
    See Also:
    
    EDGE_LAYOUT_DESCRIPTOR_DPKEY, setDefaultEdgeLayoutDescriptor(EdgeLayoutDescriptor)
  - getDefaultOutEdgeComparator
```
public Comparator<Object> getDefaultOutEdgeComparator()
```
    Gets the default Comparator used for sorting the outgoing edges incident to nodes that do not have a specific Comparator.
    Such a comparator is defined using a IDataProvider registered with the graph with key OUT_EDGE_COMPARATOR_DPKEY.
    
    To maintain the current order of edges, the default comparator can be set to null.
    
    Default Value:
    The default value is DefaultOutEdgeComparator. The order of the edges is used along with a special PortConstraint and edge group handling.
    
    Returns:
    
    the default Comparator for outgoing edges
    
    See Also:
    
    setDefaultOutEdgeComparator(Comparator)
  - getDefaultPortAssignment
```
public IPortAssignment getDefaultPortAssignment()
```
    Gets the default IPortAssignment used for those nodes that do not have their own specific instance.
    A IPortAssignment instance is defined using a IDataProvider registered with the graph with key PORT_ASSIGNMENT_DPKEY.
    
    Throws:
    
    IllegalArgumentException - if null is specified
    
    Default Value:
    The default value is DefaultPortAssignment. All ports are distributed on the borders of the nodes.
    
    Returns:
    
    the port assignment
    
    See Also:
    
    setDefaultPortAssignment(IPortAssignment)
  - getMinimumEdgeToEdgeDistance
```
public double getMinimumEdgeToEdgeDistance()
```
    Gets the minimum distance between edges.
    This distance needs to be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified distance is smaller than 0
    
    Default Value:
    The default value is 5.
    
    Returns:
    
    the minimum distance between edges
    
    See Also:
    
    setMinimumEdgeToEdgeDistance(double)
  - getMinimumNodeToEdgeDistance
```
public double getMinimumNodeToEdgeDistance()
```
    Gets the minimum distance between nodes and edges.
    This distance needs to be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified distance is smaller than 0
    
    Default Value:
    The default value is 10.
    
    Returns:
    
    the minimum distance between nodes and edges
    
    See Also:
    
    setMinimumNodeToEdgeDistance(double)
  - getMinimumNodeToNodeDistance
```
public double getMinimumNodeToNodeDistance()
```
    Gets the minimum distance between nodes.
    This distance needs to be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified distance is smaller than 0
    
    Default Value:
    The default value is 10.
    
    Returns:
    
    the minimum distance between nodes
    
    See Also:
    
    setMinimumNodeToNodeDistance(double)
  - getMinimumPolylineSegmentLength
```
public double getMinimumPolylineSegmentLength()
```
    Gets the minimum vertical distance of the edge segments that are not orthogonal.
    The distance needs to be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified length is smaller than 0
    
    This distance will only be considered when the routing style is RoutingStyle.POLYLINE.
    
    Default Value:
    The default value is 30.
    
    Returns:
    
    the minimum vertical distance
    
    See Also:
    
    setMinimumSlope(double), setRoutingStyle(RoutingStyle), RoutingStyle.POLYLINE, setMinimumPolylineSegmentLength(double)
  - getMinimumSlope
```
public double getMinimumSlope()
```
    Gets the minimum slope which a non-orthogonal edge segment should have.
    A higher minimum slope prevents those segments in very wide graphs from becoming nearly horizontal. The slope needs to have a non-negative value.
    
    Throws:
    
    IllegalArgumentException - if the specified slope is smaller than 0
    
    This distance will only be considered when the routing style is RoutingStyle.POLYLINE.
    
    Default Value:
    The default value is 0.25.
    
    Returns:
    
    the minimum slope for a non-orthogonal segment
    
    See Also:
    
    setMinimumPolylineSegmentLength(double), setRoutingStyle(RoutingStyle), RoutingStyle.POLYLINE, setMinimumSlope(double)
  - getNonSeriesParallelEdgeLabelingAlgorithm
```
public ILayoutAlgorithm getNonSeriesParallelEdgeLabelingAlgorithm()
```
    Gets the labeling algorithm that is applied to all edge labels that belong to non-series-parallel edges.
    
    When specifying a custom labeling algorithm, make sure that it uses the according edge label selection key to determine which edge labels it should place. Otherwise, the labeling algorithm might place all labels, including those that belong to actual series-parallel edges.
    
    Default Value:
    The default value is GenericLabeling
    
    Returns:
    
    the labeling algorithm used for edge labels of non-series-parallel edges
    
    See Also:
    
    setGeneralGraphHandling(boolean), setNonSeriesParallelEdgeLabelSelectionKey(Object), setNonSeriesParallelEdgeLabelingAlgorithm(ILayoutAlgorithm)
  - getNonSeriesParallelEdgeLabelSelectionKey
```
public Object getNonSeriesParallelEdgeLabelSelectionKey()
```
    Gets the key to register a IDataProvider that is used by the non-series-parallel edge labeling algorithm to determine which edge labels it should place.
    During the layout, a IDataProvider with this key will be registered with the graph. It will mark all IEdgeLabelLayouts that belong to non-series-parallel edges. A specified custom non-series-parallel edge labeling algorithm needs to obey this selection. If using GenericLabeling as labeling algorithm, set this key as value of property AffectedLabelsDpKey.
    
    The labeling algorithm set as default is already configured such that it uses the correct selection key.
    
    When specifying a custom non-series-parallel edge labeling algorithm but no edge label selection key, then the labeling algorithm might place all labels, including those that belong to actual series-parallel edges.
    
    Default Value:
    The default value is NON_SERIES_PARALLEL_EDGE_LABELS_DPKEY
    
    Returns:
    
    the non-series-parallel edge label selection IDataProvider key
    
    See Also:
    
    setNonSeriesParallelEdgeLabelingAlgorithm(ILayoutAlgorithm), setNonSeriesParallelEdgeLabelSelectionKey(Object)
  - getNonSeriesParallelEdgeRouter
```
public ILayoutAlgorithm getNonSeriesParallelEdgeRouter()
```
    Gets the edge routing algorithm used for the edges of a general graph that are not part of the series-parallel subgraph whose layout is calculated.
    
    Throws:
    
    IllegalArgumentException - if null is specified
    
    It is required that a suitable selection key is set.
    
    Default Value:
    The default value is EdgeRouter
    
    Returns:
    
    the edge routing algorithm applied to the non-series-parallel edges
    
    See Also:
    
    setGeneralGraphHandling(boolean), setNonSeriesParallelEdgesDpKey(Object), setNonSeriesParallelEdgeRouter(ILayoutAlgorithm)
  - getNonSeriesParallelEdgesDpKey
```
public Object getNonSeriesParallelEdgesDpKey()
```
    Gets the key to register a IDataProvider that is used for marking non-series-parallel edges.
    This key is used for determining the edges that are not part of the series-parallel structure in a general graph, such that the specified non-series-parallel edge router only routes marked edges.
    
    Throws:
    
    IllegalArgumentException - if the given key is set to null
    
    The layout algorithm automatically marks these edges and also registers the IDataProvider using the specified key.
    
    Returns:
    
    the selection key
    
    See Also:
    
    setGeneralGraphHandling(boolean), setNonSeriesParallelEdgeRouter(ILayoutAlgorithm), setNonSeriesParallelEdgesDpKey(Object)
  - getPreferredOctilinearSegmentLength
```
public double getPreferredOctilinearSegmentLength()
```
    Gets the preferred length for non-orthogonal segments in octilinear edge routes.
    If there is not enough space, those segments may be shorter than the specified length. The length needs to be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified length is smaller than 0
    
    This segment length will only be considered when the routing style is RoutingStyle.OCTILINEAR.
    
    Default Value:
    The default value is 10.
    
    Returns:
    
    the preferred length for non-orthogonal segments in octilinear edge routes
    
    See Also:
    
    setRoutingStyle(RoutingStyle), RoutingStyle.OCTILINEAR, setPreferredOctilinearSegmentLength(double)
  - getRoutingStyle
```
public RoutingStyle getRoutingStyle()
```
    Gets the currently used routing style for edges.
    
    The routing style has no effect on non-series-parallel edges, when GeneralGraphHandling is enabled.
    
    Default Value:
    The default value is RoutingStyle.ORTHOGONAL
    
    Returns:
    
    the routing style for the edges
    
    See Also:
    
    setRoutingStyle(RoutingStyle)
  - getVerticalAlignment
```
public double getVerticalAlignment()
```
    Gets the vertical alignment of parallel subgraphs.
    The alignment is defined by a ratio:
    - Ratio 0 means that nodes are top-aligned
    - Ratio 0.5 means that nodes are center-aligned
    - Ratio 1 means that nodes are bottom-aligned
    In grouped graphs, the vertical alignment only applies to parallel subgraphs that belong to the same group.
    
    Values outside interval [0,1] will be matched with the nearest interval end.
    
    Default Value:
    The default value is 0.5. Subgraphs are center aligned.
    
    Returns:
    
    the vertical alignment ratio from interval [0,1]
    
    See Also:
    
    setVerticalAlignment(double)
  - isConsiderNodeLabels
```
public boolean isConsiderNodeLabels()
```
    Gets whether or not the layout algorithm reserves space for node labels to avoid overlaps.
    
    When enabling this property, any previously specified labeling algorithm will be overwritten and when disabling it, any currently specified labeling algorithm will be disabled via property LabelingEnabled. Therefore, it is recommended to only use this convenience property instead of manually changing the mentioned other properties.
    
    Default Value:
    The default value is false. Node labels are not considered.
    
    Returns:
    
    true if node labels are considered, false otherwise
    
    See Also:
    
    setConsiderNodeLabels(boolean)
  - isFromSketchMode
```
public boolean isFromSketchMode()
```
    Gets whether or not to take the coordinates of the input diagram into account when arranging the nodes.
    The order of edges incident to the same source node will remain the same as in the original layout.
    
    Previously specified comparators will be ignored if From Sketch mode is enabled.
    
    Default Value:
    The default value is false. The initial coordinates of the nodes are not considered.
    
    Returns:
    
    true if input coordinates are considered, false otherwise
    
    See Also:
    
    setFromSketchMode(boolean)
  - isGeneralGraphHandling
```
public boolean isGeneralGraphHandling()
```
    Gets whether or not the layout algorithm can handle general graphs.
    General graphs are required to be transformed before being laid out (by adding or removing some edges) such that they satisfy the criteria of a series-parallel graph. After the layout, the graph will be restored and the initial edges which weren't included in the series-parallel graph are routed by a separate edge routing algorithm. Furthermore, the labels of these edges are placed by a customizable edge labeling algorithm.
    
    Default Value:
    The default value is false. Only series-parallel graphs are handled.
    
    Returns:
    
    true if general graphs should be handled, false otherwise
    
    See Also:
    
    setGeneralGraphHandling(boolean)
  - isIntegratedEdgeLabeling
```
public boolean isIntegratedEdgeLabeling()
```
    Gets whether or not the layout algorithm will place edge labels and reserve space for them.
    
    When enabling this property, any previously specified labeling algorithm will be overwritten and when disabling it, any currently specified labeling algorithm will be disabled via property LabelingEnabled. Therefore, it is recommended to only use this convenience property instead of manually changing the mentioned other properties.
    
    Default Value:
    The default value is false. Integrated edge labeling is disabled.
    
    Returns:
    
    true if edge labels should be placed, false otherwise
    
    See Also:
    
    setIntegratedEdgeLabeling(boolean)
  - isSeriesParallelGraph
```
public static final boolean isSeriesParallelGraph(Graph graph)
```
    Determines whether or not the given graph has a series-parallel structure.
    The current implementation detects the series-parallel graph structure in linear time.
    
    Parameters:
    
    graph - the input graph
    
    Returns:
    
    true if the given graph is series-parallel, false otherwise
  - setComponentLayoutEnabled
```
public void setComponentLayoutEnabled(boolean value)
```
    Sets whether or not the ILayoutStage used for arranging the components of the graph is activated.
    
    Overrides:
    
    setComponentLayoutEnabled in class MultiStageLayout
    
    SeriesParallelLayout can only handle single components. Disabling ComponentLayout will lead to errors during execution.
    
    Default Value:
    The default value is true. The stage that arranges connected graph components is activated.
    
    Parameters:
    
    value - true if the stage that arranges the graph components is activated, false otherwise
    
    See Also:
    
    MultiStageLayout.isComponentLayoutEnabled(), MultiStageLayout.setComponentLayout(com.yworks.yfiles.layout.ILayoutStage), ComponentLayout
  - setConsiderNodeLabels
```
public void setConsiderNodeLabels(boolean value)
```
    Sets whether or not the layout algorithm reserves space for node labels to avoid overlaps.
    
    When enabling this property, any previously specified labeling algorithm will be overwritten and when disabling it, any currently specified labeling algorithm will be disabled via property LabelingEnabled. Therefore, it is recommended to only use this convenience property instead of manually changing the mentioned other properties.
    
    Default Value:
    The default value is false. Node labels are not considered.
    
    Parameters:
    
    value - true if node labels are considered, false otherwise
    
    See Also:
    
    isConsiderNodeLabels()
  - setDefaultEdgeLayoutDescriptor
```
public void setDefaultEdgeLayoutDescriptor(EdgeLayoutDescriptor value)
```
    Sets the EdgeLayoutDescriptor instance used for all those edges that do not have a specific layout descriptor assigned.
    
    Throws:
    
    IllegalArgumentException - if the specified EdgeLayoutDescriptor is null
    
    Default Value:
    The default value is EdgeLayoutDescriptor
    
    Parameters:
    
    value - the current EdgeLayoutDescriptor instance
    
    See Also:
    
    EDGE_LAYOUT_DESCRIPTOR_DPKEY, getDefaultEdgeLayoutDescriptor()
  - setDefaultOutEdgeComparator
```
public void setDefaultOutEdgeComparator(Comparator<Object> value)
```
    Sets the default Comparator used for sorting the outgoing edges incident to nodes that do not have a specific Comparator.
    Such a comparator is defined using a IDataProvider registered with the graph with key OUT_EDGE_COMPARATOR_DPKEY.
    
    To maintain the current order of edges, the default comparator can be set to null.
    
    Default Value:
    The default value is DefaultOutEdgeComparator. The order of the edges is used along with a special PortConstraint and edge group handling.
    
    Parameters:
    
    value - the default Comparator for outgoing edges
    
    See Also:
    
    getDefaultOutEdgeComparator()
  - setDefaultPortAssignment
```
public void setDefaultPortAssignment(IPortAssignment value)
```
    Sets the default IPortAssignment used for those nodes that do not have their own specific instance.
    A IPortAssignment instance is defined using a IDataProvider registered with the graph with key PORT_ASSIGNMENT_DPKEY.
    
    Throws:
    
    IllegalArgumentException - if null is specified
    
    Default Value:
    The default value is DefaultPortAssignment. All ports are distributed on the borders of the nodes.
    
    Parameters:
    
    value - the port assignment
    
    See Also:
    
    getDefaultPortAssignment()
  - setFromSketchMode
```
public void setFromSketchMode(boolean value)
```
    Sets whether or not to take the coordinates of the input diagram into account when arranging the nodes.
    The order of edges incident to the same source node will remain the same as in the original layout.
    
    Previously specified comparators will be ignored if From Sketch mode is enabled.
    
    Default Value:
    The default value is false. The initial coordinates of the nodes are not considered.
    
    Parameters:
    
    value - true if input coordinates are considered, false otherwise
    
    See Also:
    
    isFromSketchMode()
  - setGeneralGraphHandling
```
public void setGeneralGraphHandling(boolean value)
```
    Sets whether or not the layout algorithm can handle general graphs.
    General graphs are required to be transformed before being laid out (by adding or removing some edges) such that they satisfy the criteria of a series-parallel graph. After the layout, the graph will be restored and the initial edges which weren't included in the series-parallel graph are routed by a separate edge routing algorithm. Furthermore, the labels of these edges are placed by a customizable edge labeling algorithm.
    
    Default Value:
    The default value is false. Only series-parallel graphs are handled.
    
    Parameters:
    
    value - true if general graphs should be handled, false otherwise
    
    See Also:
    
    isGeneralGraphHandling()
  - setIntegratedEdgeLabeling
```
public void setIntegratedEdgeLabeling(boolean value)
```
    Sets whether or not the layout algorithm will place edge labels and reserve space for them.
    
    When enabling this property, any previously specified labeling algorithm will be overwritten and when disabling it, any currently specified labeling algorithm will be disabled via property LabelingEnabled. Therefore, it is recommended to only use this convenience property instead of manually changing the mentioned other properties.
    
    Default Value:
    The default value is false. Integrated edge labeling is disabled.
    
    Parameters:
    
    value - true if edge labels should be placed, false otherwise
    
    See Also:
    
    isIntegratedEdgeLabeling()
  - setMinimumEdgeToEdgeDistance
```
public void setMinimumEdgeToEdgeDistance(double value)
```
    Sets the minimum distance between edges.
    This distance needs to be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified distance is smaller than 0
    
    Default Value:
    The default value is 5.
    
    Parameters:
    
    value - the minimum distance between edges
    
    See Also:
    
    getMinimumEdgeToEdgeDistance()
  - setMinimumNodeToEdgeDistance
```
public void setMinimumNodeToEdgeDistance(double value)
```
    Sets the minimum distance between nodes and edges.
    This distance needs to be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified distance is smaller than 0
    
    Default Value:
    The default value is 10.
    
    Parameters:
    
    value - the minimum distance between nodes and edges
    
    See Also:
    
    getMinimumNodeToEdgeDistance()
  - setMinimumNodeToNodeDistance
```
public void setMinimumNodeToNodeDistance(double value)
```
    Sets the minimum distance between nodes.
    This distance needs to be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified distance is smaller than 0
    
    Default Value:
    The default value is 10.
    
    Parameters:
    
    value - the minimum distance between nodes
    
    See Also:
    
    getMinimumNodeToNodeDistance()
  - setMinimumPolylineSegmentLength
```
public void setMinimumPolylineSegmentLength(double value)
```
    Sets the minimum vertical distance of the edge segments that are not orthogonal.
    The distance needs to be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified length is smaller than 0
    
    This distance will only be considered when the routing style is RoutingStyle.POLYLINE.
    
    Default Value:
    The default value is 30.
    
    Parameters:
    
    value - the minimum vertical distance
    
    See Also:
    
    setMinimumSlope(double), setRoutingStyle(RoutingStyle), RoutingStyle.POLYLINE, getMinimumPolylineSegmentLength()
  - setMinimumSlope
```
public void setMinimumSlope(double value)
```
    Sets the minimum slope which a non-orthogonal edge segment should have.
    A higher minimum slope prevents those segments in very wide graphs from becoming nearly horizontal. The slope needs to have a non-negative value.
    
    Throws:
    
    IllegalArgumentException - if the specified slope is smaller than 0
    
    This distance will only be considered when the routing style is RoutingStyle.POLYLINE.
    
    Default Value:
    The default value is 0.25.
    
    Parameters:
    
    value - the minimum slope for a non-orthogonal segment
    
    See Also:
    
    setMinimumPolylineSegmentLength(double), setRoutingStyle(RoutingStyle), RoutingStyle.POLYLINE, getMinimumSlope()
  - setNonSeriesParallelEdgeLabelingAlgorithm
```
public void setNonSeriesParallelEdgeLabelingAlgorithm(ILayoutAlgorithm value)
```
    Sets the labeling algorithm that is applied to all edge labels that belong to non-series-parallel edges.
    
    When specifying a custom labeling algorithm, make sure that it uses the according edge label selection key to determine which edge labels it should place. Otherwise, the labeling algorithm might place all labels, including those that belong to actual series-parallel edges.
    
    Default Value:
    The default value is GenericLabeling
    
    Parameters:
    
    value - the labeling algorithm used for edge labels of non-series-parallel edges
    
    See Also:
    
    setGeneralGraphHandling(boolean), setNonSeriesParallelEdgeLabelSelectionKey(Object), getNonSeriesParallelEdgeLabelingAlgorithm()
  - setNonSeriesParallelEdgeLabelSelectionKey
```
public void setNonSeriesParallelEdgeLabelSelectionKey(Object value)
```
    Sets the key to register a IDataProvider that is used by the non-series-parallel edge labeling algorithm to determine which edge labels it should place.
    During the layout, a IDataProvider with this key will be registered with the graph. It will mark all IEdgeLabelLayouts that belong to non-series-parallel edges. A specified custom non-series-parallel edge labeling algorithm needs to obey this selection. If using GenericLabeling as labeling algorithm, set this key as value of property AffectedLabelsDpKey.
    
    The labeling algorithm set as default is already configured such that it uses the correct selection key.
    
    When specifying a custom non-series-parallel edge labeling algorithm but no edge label selection key, then the labeling algorithm might place all labels, including those that belong to actual series-parallel edges.
    
    Default Value:
    The default value is NON_SERIES_PARALLEL_EDGE_LABELS_DPKEY
    
    Parameters:
    
    value - the non-series-parallel edge label selection IDataProvider key
    
    See Also:
    
    setNonSeriesParallelEdgeLabelingAlgorithm(ILayoutAlgorithm), getNonSeriesParallelEdgeLabelSelectionKey()
  - setNonSeriesParallelEdgeRouter
```
public void setNonSeriesParallelEdgeRouter(ILayoutAlgorithm value)
```
    Sets the edge routing algorithm used for the edges of a general graph that are not part of the series-parallel subgraph whose layout is calculated.
    
    Throws:
    
    IllegalArgumentException - if null is specified
    
    It is required that a suitable selection key is set.
    
    Default Value:
    The default value is EdgeRouter
    
    Parameters:
    
    value - the edge routing algorithm applied to the non-series-parallel edges
    
    See Also:
    
    setGeneralGraphHandling(boolean), setNonSeriesParallelEdgesDpKey(Object), getNonSeriesParallelEdgeRouter()
  - setNonSeriesParallelEdgesDpKey
```
public void setNonSeriesParallelEdgesDpKey(Object value)
```
    Sets the key to register a IDataProvider that is used for marking non-series-parallel edges.
    This key is used for determining the edges that are not part of the series-parallel structure in a general graph, such that the specified non-series-parallel edge router only routes marked edges.
    
    Throws:
    
    IllegalArgumentException - if the given key is set to null
    
    The layout algorithm automatically marks these edges and also registers the IDataProvider using the specified key.
    
    Parameters:
    
    value - the selection key
    
    See Also:
    
    setGeneralGraphHandling(boolean), setNonSeriesParallelEdgeRouter(ILayoutAlgorithm), getNonSeriesParallelEdgesDpKey()
  - setPreferredOctilinearSegmentLength
```
public void setPreferredOctilinearSegmentLength(double value)
```
    Sets the preferred length for non-orthogonal segments in octilinear edge routes.
    If there is not enough space, those segments may be shorter than the specified length. The length needs to be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified length is smaller than 0
    
    This segment length will only be considered when the routing style is RoutingStyle.OCTILINEAR.
    
    Default Value:
    The default value is 10.
    
    Parameters:
    
    value - the preferred length for non-orthogonal segments in octilinear edge routes
    
    See Also:
    
    setRoutingStyle(RoutingStyle), RoutingStyle.OCTILINEAR, getPreferredOctilinearSegmentLength()
  - setRoutingStyle
```
public void setRoutingStyle(RoutingStyle value)
```
    Sets the currently used routing style for edges.
    
    The routing style has no effect on non-series-parallel edges, when GeneralGraphHandling is enabled.
    
    Default Value:
    The default value is RoutingStyle.ORTHOGONAL
    
    Parameters:
    
    value - the routing style for the edges
    
    See Also:
    
    getRoutingStyle()
  - setSelfLoopRouterEnabled
```
public void setSelfLoopRouterEnabled(boolean value)
```
    Sets whether or not the ILayoutStage used for routing self-loops is activated.
    
    Overrides:
    
    setSelfLoopRouterEnabled in class MultiStageLayout
    
    SeriesParallelLayout cannot handle self-loops. Disabling SelfLoopRouter will lead to errors during execution.
    
    Default Value:
    The default value is true. The stage that routes self-loops is activated.
    
    Parameters:
    
    value - true if the stage responsible for routing self-loops is activated, false otherwise
    
    See Also:
    
    MultiStageLayout.isSelfLoopRouterEnabled(), MultiStageLayout.setSelfLoopRouter(com.yworks.yfiles.layout.ILayoutStage), SelfLoopRouter
  - setVerticalAlignment
```
public void setVerticalAlignment(double value)
```
    Sets the vertical alignment of parallel subgraphs.
    The alignment is defined by a ratio:
    - Ratio 0 means that nodes are top-aligned
    - Ratio 0.5 means that nodes are center-aligned
    - Ratio 1 means that nodes are bottom-aligned
    In grouped graphs, the vertical alignment only applies to parallel subgraphs that belong to the same group.
    
    Values outside interval [0,1] will be matched with the nearest interval end.
    
    Default Value:
    The default value is 0.5. Subgraphs are center aligned.
    
    Parameters:
    
    value - the vertical alignment ratio from interval [0,1]
    
    See Also:
    
    getVerticalAlignment()

Class SeriesParallelLayout

Layout Style

Concept

Features

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.yworks.yfiles.layout.MultiStageLayout

Methods inherited from class java.lang.Object

Field Detail

EDGE_LAYOUT_DESCRIPTOR_DPKEY

NON_SERIES_PARALLEL_EDGE_LABELS_DPKEY

OUT_EDGE_COMPARATOR_DPKEY

PORT_ASSIGNMENT_DPKEY

Constructor Detail

SeriesParallelLayout

Method Detail

applyLayoutCore

getDefaultEdgeLayoutDescriptor

getDefaultOutEdgeComparator

getDefaultPortAssignment

getMinimumEdgeToEdgeDistance

getMinimumNodeToEdgeDistance

getMinimumNodeToNodeDistance

getMinimumPolylineSegmentLength

getMinimumSlope

getNonSeriesParallelEdgeLabelingAlgorithm

getNonSeriesParallelEdgeLabelSelectionKey

getNonSeriesParallelEdgeRouter

getNonSeriesParallelEdgesDpKey

getPreferredOctilinearSegmentLength

getRoutingStyle

getVerticalAlignment

isConsiderNodeLabels

isFromSketchMode

isGeneralGraphHandling

isIntegratedEdgeLabeling

isSeriesParallelGraph

setComponentLayoutEnabled

setConsiderNodeLabels

setDefaultEdgeLayoutDescriptor

setDefaultOutEdgeComparator

setDefaultPortAssignment

setFromSketchMode

setGeneralGraphHandling

setIntegratedEdgeLabeling

setMinimumEdgeToEdgeDistance

setMinimumNodeToEdgeDistance

setMinimumNodeToNodeDistance

setMinimumPolylineSegmentLength

setMinimumSlope

setNonSeriesParallelEdgeLabelingAlgorithm

setNonSeriesParallelEdgeLabelSelectionKey

setNonSeriesParallelEdgeRouter

setNonSeriesParallelEdgesDpKey

setPreferredOctilinearSegmentLength

setRoutingStyle

setSelfLoopRouterEnabled

setVerticalAlignment