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

java.lang.Object
- com.yworks.yfiles.layout.MultiStageLayout
- - com.yworks.yfiles.layout.orthogonal.OrthogonalLayout

All Implemented Interfaces:

ILayoutAlgorithm
```
public class OrthogonalLayout
extends MultiStageLayout
```
This layout algorithm arranges graphs in an orthogonal fashion.

Layout Style

This layout algorithm arranges the nodes of a given graph such that each edge is drawn as an alternating sequence of horizontal and vertical segments.

It produces compact drawings with no overlapping nodes, few crossings and few bends and is well suited for small and medium-sized sparse graphs.

Orthogonal drawings are common in engineering applications since they are able to provide clear representations of complex networks that can also be optimal with respect to diverse objective functions such as bend minimization or area minimization. Application domains of orthogonal drawings include software engineering, database schema representation, system management, knowledge representation, VLSI circuits and floor planning applications.

Orthogonal layout with default settings

This algorithm also optionally supports directed edge drawings (although not in combination with hierarchically nested graphs or the non-default layout styles). Application domains of directed orthogonal drawings include, for example, software engineering, database schema and system management.

Sample output of OrthogonalLayout with default settings. Marked edges are considered as directed and the layout orientation is top-to-bottom. Sample output of OrthogonalLayout with edge grouping. All edges are considered directed and the layout orientation is left-to-right.

Also this algorithm supports hierarchically nested graphs (although not in combination with the directed edge drawings, the from sketch option, or the non-default layout styles) feature:

Orthogonal layout of a grouped graph with default settings Orthogonal layout of a graph with nested groups
Concept
The orthogonal layout algorithm is based on the topology-shape-metrics approach and runs in three phases:
- Planarization – A planar embedding is computed.
- Orthogonalization – The bends and the angles are computed.
- Compaction – The coordinates for the nodes and edges are determined.
Features

There exist several different layout styles that the orthogonal layout algorithm supports depending on whether or not the edges should be routed completely orthogonal, or whether or not the original size of the nodes should be maintained. Such layout styles are LayoutStyle.NORMAL, LayoutStyle.UNIFORM, LayoutStyle.BOX, LayoutStyle.NORMAL_TREE, LayoutStyle.MIXED, LayoutStyle.FIXED_BOX, LayoutStyle.FIXED_MIXED and can be applied using LayoutStyle.

OrthogonalLayout is able to consider edge label data when arranging a graph. This means that the layout algorithm will determine the positions of the nodes and edges such that the edge labels do not overlap with the rest of the layout. Integrated edge labeling can be activated using method IntegratedEdgeLabelingEnabled.

EdgeLayoutDescriptor instances can be used for specifying individual information (e.g. distances) for each edge in the graph. The descriptors are bound to the graph using IDataProviders registered with key EDGE_LAYOUT_DESCRIPTOR_DPKEY. If there is no descriptor assigned to some edges, a default descriptor will be used. To set default descriptors, use EdgeLayoutDescriptor.

OrthogonalLayout tries to optimize diverse objective functions such as bend minimization, number of edge crossings, edge length minimization or face maximization. These settings can be enabled using the corresponding methods PerceivedBendOptimizationEnabled, CrossingReductionEnabled, EdgeLengthReductionEnabled, and FaceMaximizationEnabled, respectively. The drawback when these settings are enabled is that the running time of the algorithm may be drastically increased.

Field Summary

Fields
Modifier and Type	Field and Description
`static EdgeDpKey<Boolean>`	`DIRECTED_EDGE_DPKEY` A `DataProvider` key for marking edges which should be routed such that they point to the main layout orientation The main layout orientation can be set using method `LayoutOrientation`.
`static EdgeDpKey<EdgeLayoutDescriptor>`	`EDGE_LAYOUT_DESCRIPTOR_DPKEY` A `DataProvider` key for providing layout information for each edge If no edge layout descriptor is mapped for an edge, a default edge layout descriptor will be obtained using method `createEdgeLayoutDescriptor()`.

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyLayout(LayoutGraph graph)` Calculates an orthogonal layout for the given graph.
`void`	`applyLayoutCore(LayoutGraph graph)` Calculates an orthogonal layout for the given graph.
`protected EdgeLayoutDescriptor`	`createEdgeLayoutDescriptor()` Returns a new `EdgeLayoutDescriptor` instance that will be used during the various phases of the layout algorithm to determine the drawing details of the edges of the graph.
`EdgeLayoutDescriptor`	`getEdgeLayoutDescriptor()` Gets the `EdgeLayoutDescriptor` instance used for all those edges that do not have a specific layout descriptor assigned.
`int`	`getGridSpacing()` Gets the equidistant spacing between the horizontal and vertical grid lines.
`LayoutStyle`	`getLayoutStyle()` Gets the layout style for this layout algorithm.
`boolean`	`isAligningDegreeOneNodesEnabled()` Gets whether or not degree-one nodes that have the same neighbor should be aligned.
`boolean`	`isCrossingReductionEnabled()` Gets whether or not the number of edge crossings should be reduced.
`boolean`	`isEdgeLengthReductionEnabled()` Gets whether or not the overall edge length should be optimized.
`boolean`	`isFaceMaximizationEnabled()` Gets whether or not one face of the embedding of the graph should be maximized.
`boolean`	`isFromSketchModeEnabled()` Gets whether or not the existing drawing should be used as a sketch of the resulting orthogonal layout.
`boolean`	`isIntegratedEdgeLabelingEnabled()` Gets whether or not the layout algorithm preserves space and places edge labels.
`boolean`	`isNodeLabelConsiderationEnabled()` Gets whether or not the layout algorithm considers node labels when calculating node positions to avoid overlaps.
`boolean`	`isPerceivedBendOptimizationEnabled()` Gets whether or not the number of perceived bends should be minimized.
`boolean`	`isRandomizationEnabled()` Gets whether or not a randomization strategy should be performed.
`void`	`setAligningDegreeOneNodesEnabled(boolean value)` Sets whether or not degree-one nodes that have the same neighbor should be aligned.
`void`	`setComponentLayoutEnabled(boolean value)` Sets whether or not the `ILayoutStage` used for arranging the components of the graph is activated.
`void`	`setCrossingReductionEnabled(boolean value)` Sets whether or not the number of edge crossings should be reduced.
`void`	`setEdgeLayoutDescriptor(EdgeLayoutDescriptor value)` Sets the `EdgeLayoutDescriptor` instance used for all those edges that do not have a specific layout descriptor assigned.
`void`	`setEdgeLengthReductionEnabled(boolean value)` Sets whether or not the overall edge length should be optimized.
`void`	`setFaceMaximizationEnabled(boolean value)` Sets whether or not one face of the embedding of the graph should be maximized.
`void`	`setFromSketchModeEnabled(boolean value)` Sets whether or not the existing drawing should be used as a sketch of the resulting orthogonal layout.
`void`	`setGridSpacing(int value)` Sets the equidistant spacing between the horizontal and vertical grid lines.
`void`	`setHideGroupsStageEnabled(boolean value)` Sets whether or not the `ILayoutStage` used for hiding group nodes is activated.
`void`	`setIntegratedEdgeLabelingEnabled(boolean value)` Sets whether or not the layout algorithm preserves space and places edge labels.
`void`	`setLayoutStyle(LayoutStyle value)` Sets the layout style for this layout algorithm.
`void`	`setNodeLabelConsiderationEnabled(boolean value)` Sets whether or not the layout algorithm considers node labels when calculating node positions to avoid overlaps.
`void`	`setOrientationLayoutEnabled(boolean value)` Sets whether or not the `ILayoutStage` that modifies the orientation of the layout is activated.
`void`	`setPerceivedBendOptimizationEnabled(boolean value)` Sets whether or not the number of perceived bends should be minimized.
`void`	`setRandomizationEnabled(boolean value)` Sets whether or not a randomization strategy should be performed.

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

- Field Detail
  - DIRECTED_EDGE_DPKEY
```
public static final EdgeDpKey<Boolean> DIRECTED_EDGE_DPKEY
```
    A DataProvider key for marking edges which should be routed such that they point to the main layout orientation
    The main layout orientation can be set using method LayoutOrientation.
    
    This implementation can not be used if there are group nodes in the graph. This directed edges will be ignored if group nodes exist in the graph component.
  - EDGE_LAYOUT_DESCRIPTOR_DPKEY
```
public static final EdgeDpKey<EdgeLayoutDescriptor> EDGE_LAYOUT_DESCRIPTOR_DPKEY
```
    A DataProvider key for providing layout information for each edge
    If no edge layout descriptor is mapped for an edge, a default edge layout descriptor will be obtained using method createEdgeLayoutDescriptor().
    
    Minimum edge length constraints can only be considered for layout styles LayoutStyle.NORMAL, LayoutStyle.NORMAL_TREE and LayoutStyle.UNIFORM.
    
    See Also:
    
    setLayoutStyle(LayoutStyle)
- Constructor Detail
  - OrthogonalLayout
```
public OrthogonalLayout()
```
    Creates a new OrthogonalLayout instance with default settings.
- Method Detail
  - applyLayout
```
public void applyLayout(LayoutGraph graph)
```
    Calculates an orthogonal layout for the given graph.
    
    Specified by:
    
    applyLayout in interface ILayoutAlgorithm
    
    Overrides:
    
    applyLayout in class MultiStageLayout
    
    The given graph will not be copied during the layout process and the result will be immediately applied to the input graph.
    
    Parameters:
    
    graph - the input graph
    
    See Also:
    
    MultiStageLayout.appendStage(ILayoutStage), MultiStageLayout.prependStage(ILayoutStage), MultiStageLayout.applyLayoutCore(LayoutGraph)
  - applyLayoutCore
```
public void applyLayoutCore(LayoutGraph graph)
```
    Calculates an orthogonal layout for the given graph.
    
    Specified by:
    
    applyLayoutCore in class MultiStageLayout
    
    The given graph will not be copied during the layout process and the result will be immediately applied to the input graph.
    
    Parameters:
    
    graph - the input graph
  - createEdgeLayoutDescriptor
```
protected EdgeLayoutDescriptor createEdgeLayoutDescriptor()
```
    Returns a new EdgeLayoutDescriptor instance that will be used during the various phases of the layout algorithm to determine the drawing details of the edges of the graph.
    This method may be overridden to create a new EdgeLayoutDescriptor instance with different configuration settings.
    
    This method must not return null.
    
    Returns:
    
    a new EdgeLayoutDescriptor instance
  - getEdgeLayoutDescriptor
```
public EdgeLayoutDescriptor getEdgeLayoutDescriptor()
```
    Gets the EdgeLayoutDescriptor instance used for all those edges that do not have a specific layout descriptor assigned.
    By default, this method will return an EdgeLayoutDescriptor instance created with createEdgeLayoutDescriptor().
    
    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, setEdgeLayoutDescriptor(EdgeLayoutDescriptor)
  - getGridSpacing
```
public int getGridSpacing()
```
    Gets the equidistant spacing between the horizontal and vertical grid lines.
    Each node will be placed on a grid point. Edges will be routed such that all segments but the first and last one lie on grid lines. (The first and last segments of an edge may or may not lie on grid lines.) Edges consisting of a single segment always lie on grid lines.
    
    The grid spacing has to be greater than 0.
    
    Throws:
    
    IllegalArgumentException - if the grid spacing is negative
    
    This option is only guaranteed if layout style is LayoutStyle.NORMAL. For all other styles, it is used as a hint only.
    
    Default Value:
    The default value is 20.
    
    Returns:
    
    the grid spacing
    
    See Also:
    
    setGridSpacing(int)
  - getLayoutStyle
```
public LayoutStyle getLayoutStyle()
```
    Gets the layout style for this layout algorithm.
    
    Throws:
    
    IllegalArgumentException - if an unknown layout style is given
    
    Default Value:
    The default value is LayoutStyle.NORMAL
    
    Returns:
    
    one of the predefined layout styles
    
    See Also:
    
    setLayoutStyle(LayoutStyle)
  - isAligningDegreeOneNodesEnabled
```
public boolean isAligningDegreeOneNodesEnabled()
```
    Gets whether or not degree-one nodes that have the same neighbor should be aligned.
    
    Default Value:
    The default value is false. Degree-one nodes with the same neighbor are not aligned with each other.
    
    Returns:
    
    true if the degree-one nodes are aligned, false otherwise
    
    See Also:
    
    setAligningDegreeOneNodesEnabled(boolean)
  - isCrossingReductionEnabled
```
public boolean isCrossingReductionEnabled()
```
    Gets whether or not the number of edge crossings should be reduced.
    The layout algorithm will try to significantly reduce the number of crossings in a post-processing step.
    
    The running time of the layout algorithm may increase.
    
    Default Value:
    The default value is true. The number of edge crossings is reduced.
    
    Returns:
    
    true if the number of crossings is reduced, false otherwise
    
    See Also:
    
    setCrossingReductionEnabled(boolean)
  - isEdgeLengthReductionEnabled
```
public boolean isEdgeLengthReductionEnabled()
```
    Gets whether or not the overall edge length should be optimized.
    The algorithm will try to significantly reduce the length of some edges.
    
    The drawback is that the running time of the layout algorithm may increase.
    
    Default Value:
    The default value is true. The overall edge length is reduced.
    
    Returns:
    
    true if the overall edge length minimization is reduced, false otherwise
    
    See Also:
    
    setEdgeLengthReductionEnabled(boolean)
  - isFaceMaximizationEnabled
```
public boolean isFaceMaximizationEnabled()
```
    Gets whether or not one face of the embedding of the graph should be maximized.
    An embedding of a graph is uniquely specified by the cyclic order of edges incident to the same node in a graph drawing.
    
    In any planar drawing of a planar graph, the edges divide the plane into different regions called faces. If one of these faces (the outer face) gets maximized, all other faces will be more compact.
    
    Default Value:
    The default value is false. No face of the embedding is maximized.
    
    Returns:
    
    true if a face of the embedding is maximized, false otherwise
    
    See Also:
    
    setRandomizationEnabled(boolean), setFaceMaximizationEnabled(boolean)
  - isFromSketchModeEnabled
```
public boolean isFromSketchModeEnabled()
```
    Gets whether or not the existing drawing should be used as a sketch of the resulting orthogonal layout.
    The layout algorithm will try to orthogonalize the given sketch without making too many modifications with respect to the original drawing.
    
    If this option is enabled, the existing drawing should be preserved as much as possible. Hence, optimization steps like CrossingReductionEnabled, FaceMaximizationEnabled and PerceivedBendOptimizationEnabled are not applied even if enabled.
    
    This implementation can not use the sketch as input if there are group nodes in the graph. This property will be ignored if group nodes exist in the graph component
    
    Default Value:
    The default value is false. The initial coordinates of the nodes are not considered.
    
    Returns:
    
    true if the existing drawing is used as a sketch, false otherwise
    
    See Also:
    
    setFromSketchModeEnabled(boolean)
  - isIntegratedEdgeLabelingEnabled
```
public boolean isIntegratedEdgeLabelingEnabled()
```
    Gets whether or not the layout algorithm preserves space and places edge labels.
    To define the desired placement for each label add a PreferredPlacementDescriptor on IEdgeLabelLayout.
    
    This method also assures that the labeling algorithm is of type LabelLayoutTranslator and EdgeLabelTranslationEnabled is set to true.
    
    Throws:
    
    IllegalStateException - if no properly configured LabelLayoutTranslator is registered even though integrated labeling was enabled earlier (can happen when manually specifying the labeling algorithm).
    
    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 integrated edge labeling is enabled, false otherwise
    
    See Also:
    
    setIntegratedEdgeLabelingEnabled(boolean)
  - isNodeLabelConsiderationEnabled
```
public boolean isNodeLabelConsiderationEnabled()
```
    Gets whether or not the layout algorithm considers node labels when calculating node positions to avoid overlaps.
    This method is a convenience method that assures that the labeling algorithm is of type LabelLayoutTranslator and NodeLabelTranslationEnabled is set to true.
    
    Throws:
    
    IllegalStateException - if no properly configured LabelLayoutTranslator is registered even though this property was enabled earlier (can happen when manually specifying the labeling algorithm).
    
    Setting this option may overwrite the currently set labeling algorithm. Hence, to combine this option with a generic edge labeling algorithm, the generic labeling has to be applied in an additional step after calculating the layout.
    
    Default Value:
    The default value is false. Node labels are ignored.
    
    Returns:
    
    true if the layout algorithm takes the node labels into account, false otherwise
    
    See Also:
    
    setNodeLabelConsiderationEnabled(boolean)
  - isPerceivedBendOptimizationEnabled
```
public boolean isPerceivedBendOptimizationEnabled()
```
    Gets whether or not the number of perceived bends should be minimized.
    A perceived bend is not an actual bend but it is created when a helical arrangement of chains of nodes occurs.
    
    Default Value:
    The default value is false. The number of perceived bends will not be minimized.
    
    Returns:
    
    true if the number of perceived bends is minimized, false otherwise
    
    See Also:
    
    setPerceivedBendOptimizationEnabled(boolean)
  - isRandomizationEnabled
```
public boolean isRandomizationEnabled()
```
    Gets whether or not a randomization strategy should be performed.
    The randomization will increase the overall layout quality with high probability.
    
    The drawback is that the running time of the layout algorithm may increase and non-deterministic results for subsequent layout invocations may occur.
    
    Default Value:
    The default value is true. A randomization strategy is applied.
    
    Returns:
    
    true if randomization is performed, false otherwise
    
    See Also:
    
    setRandomizationEnabled(boolean)
  - setAligningDegreeOneNodesEnabled
```
public void setAligningDegreeOneNodesEnabled(boolean value)
```
    Sets whether or not degree-one nodes that have the same neighbor should be aligned.
    
    Default Value:
    The default value is false. Degree-one nodes with the same neighbor are not aligned with each other.
    
    Parameters:
    
    value - true if the degree-one nodes are aligned, false otherwise
    
    See Also:
    
    isAligningDegreeOneNodesEnabled()
  - 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
    
    OrthogonalLayout 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(ILayoutStage), ComponentLayout
  - setCrossingReductionEnabled
```
public void setCrossingReductionEnabled(boolean value)
```
    Sets whether or not the number of edge crossings should be reduced.
    The layout algorithm will try to significantly reduce the number of crossings in a post-processing step.
    
    The running time of the layout algorithm may increase.
    
    Default Value:
    The default value is true. The number of edge crossings is reduced.
    
    Parameters:
    
    value - true if the number of crossings is reduced, false otherwise
    
    See Also:
    
    isCrossingReductionEnabled()
  - setEdgeLayoutDescriptor
```
public void setEdgeLayoutDescriptor(EdgeLayoutDescriptor value)
```
    Sets the EdgeLayoutDescriptor instance used for all those edges that do not have a specific layout descriptor assigned.
    By default, this method will return an EdgeLayoutDescriptor instance created with createEdgeLayoutDescriptor().
    
    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, getEdgeLayoutDescriptor()
  - setEdgeLengthReductionEnabled
```
public void setEdgeLengthReductionEnabled(boolean value)
```
    Sets whether or not the overall edge length should be optimized.
    The algorithm will try to significantly reduce the length of some edges.
    
    The drawback is that the running time of the layout algorithm may increase.
    
    Default Value:
    The default value is true. The overall edge length is reduced.
    
    Parameters:
    
    value - true if the overall edge length minimization is reduced, false otherwise
    
    See Also:
    
    isEdgeLengthReductionEnabled()
  - setFaceMaximizationEnabled
```
public void setFaceMaximizationEnabled(boolean value)
```
    Sets whether or not one face of the embedding of the graph should be maximized.
    An embedding of a graph is uniquely specified by the cyclic order of edges incident to the same node in a graph drawing.
    
    In any planar drawing of a planar graph, the edges divide the plane into different regions called faces. If one of these faces (the outer face) gets maximized, all other faces will be more compact.
    
    Default Value:
    The default value is false. No face of the embedding is maximized.
    
    Parameters:
    
    value - true if a face of the embedding is maximized, false otherwise
    
    See Also:
    
    setRandomizationEnabled(boolean), isFaceMaximizationEnabled()
  - setFromSketchModeEnabled
```
public void setFromSketchModeEnabled(boolean value)
```
    Sets whether or not the existing drawing should be used as a sketch of the resulting orthogonal layout.
    The layout algorithm will try to orthogonalize the given sketch without making too many modifications with respect to the original drawing.
    
    If this option is enabled, the existing drawing should be preserved as much as possible. Hence, optimization steps like CrossingReductionEnabled, FaceMaximizationEnabled and PerceivedBendOptimizationEnabled are not applied even if enabled.
    
    This implementation can not use the sketch as input if there are group nodes in the graph. This property will be ignored if group nodes exist in the graph component
    
    Default Value:
    The default value is false. The initial coordinates of the nodes are not considered.
    
    Parameters:
    
    value - true if the existing drawing is used as a sketch, false otherwise
    
    See Also:
    
    isFromSketchModeEnabled()
  - setGridSpacing
```
public void setGridSpacing(int value)
```
    Sets the equidistant spacing between the horizontal and vertical grid lines.
    Each node will be placed on a grid point. Edges will be routed such that all segments but the first and last one lie on grid lines. (The first and last segments of an edge may or may not lie on grid lines.) Edges consisting of a single segment always lie on grid lines.
    
    The grid spacing has to be greater than 0.
    
    Throws:
    
    IllegalArgumentException - if the grid spacing is negative
    
    This option is only guaranteed if layout style is LayoutStyle.NORMAL. For all other styles, it is used as a hint only.
    
    Default Value:
    The default value is 20.
    
    Parameters:
    
    value - the grid spacing
    
    See Also:
    
    getGridSpacing()
  - setHideGroupsStageEnabled
```
public void setHideGroupsStageEnabled(boolean value)
```
    Sets whether or not the ILayoutStage used for hiding group nodes is activated.
    
    Overrides:
    
    setHideGroupsStageEnabled in class MultiStageLayout
    
    OrthogonalLayout cannot handle group nodes. Disabling HideGroupsStage will lead to errors during execution.
    
    Default Value:
    The default value is true. The stage responsible for hiding group nodes is activated.
    
    Parameters:
    
    value - true if the stage used for hiding group nodes is activated, false otherwise
    
    See Also:
    
    MultiStageLayout.isHideGroupsStageEnabled(), MultiStageLayout.setHideGroupsStage(ILayoutStage), HideGroupsStage
  - setIntegratedEdgeLabelingEnabled
```
public void setIntegratedEdgeLabelingEnabled(boolean value)
```
    Sets whether or not the layout algorithm preserves space and places edge labels.
    To define the desired placement for each label add a PreferredPlacementDescriptor on IEdgeLabelLayout.
    
    This method also assures that the labeling algorithm is of type LabelLayoutTranslator and EdgeLabelTranslationEnabled is set to true.
    
    Throws:
    
    IllegalStateException - if no properly configured LabelLayoutTranslator is registered even though integrated labeling was enabled earlier (can happen when manually specifying the labeling algorithm).
    
    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 integrated edge labeling is enabled, false otherwise
    
    See Also:
    
    isIntegratedEdgeLabelingEnabled()
  - setLayoutStyle
```
public void setLayoutStyle(LayoutStyle value)
```
    Sets the layout style for this layout algorithm.
    
    Throws:
    
    IllegalArgumentException - if an unknown layout style is given
    
    Default Value:
    The default value is LayoutStyle.NORMAL
    
    Parameters:
    
    value - one of the predefined layout styles
    
    See Also:
    
    getLayoutStyle()
  - setNodeLabelConsiderationEnabled
```
public void setNodeLabelConsiderationEnabled(boolean value)
```
    Sets whether or not the layout algorithm considers node labels when calculating node positions to avoid overlaps.
    This method is a convenience method that assures that the labeling algorithm is of type LabelLayoutTranslator and NodeLabelTranslationEnabled is set to true.
    
    Throws:
    
    IllegalStateException - if no properly configured LabelLayoutTranslator is registered even though this property was enabled earlier (can happen when manually specifying the labeling algorithm).
    
    Setting this option may overwrite the currently set labeling algorithm. Hence, to combine this option with a generic edge labeling algorithm, the generic labeling has to be applied in an additional step after calculating the layout.
    
    Default Value:
    The default value is false. Node labels are ignored.
    
    Parameters:
    
    value - true if the layout algorithm takes the node labels into account, false otherwise
    
    See Also:
    
    isNodeLabelConsiderationEnabled()
  - setOrientationLayoutEnabled
```
public void setOrientationLayoutEnabled(boolean value)
```
    Sets whether or not the ILayoutStage that modifies the orientation of the layout is activated.
    
    Overrides:
    
    setOrientationLayoutEnabled in class MultiStageLayout
    
    If the current layout orientation is LayoutOrientation.TOP_TO_BOTTOM, the orientation of the layout will not be modified.
    
    Based on the undirected layout style, disabling OrientationLayout has no significant effect unless directed orthogonal edges are enabled.
    
    Default Value:
    The default value is true. The orientation ILayoutStage is activated.
    
    Parameters:
    
    value - true if the stage that modifies the orientation is activated, false otherwise
    
    See Also:
    
    MultiStageLayout.isOrientationLayoutEnabled(), MultiStageLayout.setOrientationLayout(ILayoutStage), MultiStageLayout.setLayoutOrientation(com.yworks.yfiles.layout.LayoutOrientation), OrientationLayout
  - setPerceivedBendOptimizationEnabled
```
public void setPerceivedBendOptimizationEnabled(boolean value)
```
    Sets whether or not the number of perceived bends should be minimized.
    A perceived bend is not an actual bend but it is created when a helical arrangement of chains of nodes occurs.
    
    Default Value:
    The default value is false. The number of perceived bends will not be minimized.
    
    Parameters:
    
    value - true if the number of perceived bends is minimized, false otherwise
    
    See Also:
    
    isPerceivedBendOptimizationEnabled()
  - setRandomizationEnabled
```
public void setRandomizationEnabled(boolean value)
```
    Sets whether or not a randomization strategy should be performed.
    The randomization will increase the overall layout quality with high probability.
    
    The drawback is that the running time of the layout algorithm may increase and non-deterministic results for subsequent layout invocations may occur.
    
    Default Value:
    The default value is true. A randomization strategy is applied.
    
    Parameters:
    
    value - true if randomization is performed, false otherwise
    
    See Also:
    
    isRandomizationEnabled()

Class OrthogonalLayout

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

DIRECTED_EDGE_DPKEY

EDGE_LAYOUT_DESCRIPTOR_DPKEY

Constructor Detail

OrthogonalLayout

Method Detail

applyLayout

applyLayoutCore

createEdgeLayoutDescriptor

getEdgeLayoutDescriptor

getGridSpacing

getLayoutStyle

isAligningDegreeOneNodesEnabled

isCrossingReductionEnabled

isEdgeLengthReductionEnabled

isFaceMaximizationEnabled

isFromSketchModeEnabled

isIntegratedEdgeLabelingEnabled

isNodeLabelConsiderationEnabled

isPerceivedBendOptimizationEnabled

isRandomizationEnabled

setAligningDegreeOneNodesEnabled

setComponentLayoutEnabled

setCrossingReductionEnabled

setEdgeLayoutDescriptor

setEdgeLengthReductionEnabled

setFaceMaximizationEnabled

setFromSketchModeEnabled

setGridSpacing

setHideGroupsStageEnabled

setIntegratedEdgeLabelingEnabled

setLayoutStyle

setNodeLabelConsiderationEnabled

setOrientationLayoutEnabled

setPerceivedBendOptimizationEnabled

setRandomizationEnabled