| Package | com.yworks.yfiles.layout.orthogonal |
| Class | public class DirectedOrthogonalLayouter |
| Inheritance | DirectedOrthogonalLayouter  CanonicMultiStageLayouter YObject Object |
See also
| Property | Defined By | ||
|---|---|---|---|
| alignDegreeOneNodes : Boolean
Specifies whether the algorithm should try to align degree-one nodes that have the same neighbour. | DirectedOrthogonalLayouter | ||
 | componentLayouter : LayoutStage
Specifies the LayoutStage responsible for laying out the connected components of the graph. | CanonicMultiStageLayouter | |
| componentLayouterEnabled : Boolean
Getter:
Returns whether or not ComponentLayouter is enabled. | CanonicMultiStageLayouter | |
| considerNodeLabels : Boolean
Getter:
Returns whether or not node labels are taken into account when calculating node positions (thereby preventing possible node/node label or node label/node label overlaps). | DirectedOrthogonalLayouter | ||
| edgeLayoutDescriptor : EdgeLayoutDescriptor
Specifies the EdgeLayoutDescriptor instance used for all those edges, that do not have a specific layout descriptor assigned. | DirectedOrthogonalLayouter | ||
| grid : int
Getter:
Returns the currently set grid spacing. | DirectedOrthogonalLayouter | ||
| groupNodeHider : LayoutStage
Specifies the LayoutStage that is responsible for hiding away grouping information for the layout algorithm. | CanonicMultiStageLayouter | |
| hideGroupNodes : Boolean
Specifies whether or not to hide away group nodes before the layout begins. | CanonicMultiStageLayouter | |
| integratedEdgeLabeling : Boolean
Getter:
Returns whether integrated edge labeling is enabled. | DirectedOrthogonalLayouter | ||
| labelLayouter : LayoutStage
Getter:
Returns the algorithm used for placing labels. | CanonicMultiStageLayouter | |
| labelLayouterEnabled : Boolean
Getter:
Returns whether or not LabelLayouter is enabled. | CanonicMultiStageLayouter | |
| layoutOrientation : int
Specifies the main layout orientation. | CanonicMultiStageLayouter | |
| optimizePerceivedBends : Boolean
Specifies whether the algorithm should perform a post processing algorithm to reduce perceived bends in the drawing. | DirectedOrthogonalLayouter | ||
| orientationLayouter : LayoutStage
Specifies the LayoutStage that is responsible for changing the orientation of the computed layout. | CanonicMultiStageLayouter | |
| orientationLayouterEnabled : Boolean
Getter:
Returns whether or not the OrientationLayouter is enabled. | CanonicMultiStageLayouter | |
| parallelEdgeLayouter : LayoutStage
Getter:
Returns the LayoutStage responsible for routing parallel edges. | CanonicMultiStageLayouter | |
| parallelEdgeLayouterEnabled : Boolean
Getter:
Returns whether or not the ParallelEdgeLayouter is enabled. | CanonicMultiStageLayouter | |
| selfLoopLayouter : LayoutStage
Getter:
Returns the LayoutStage used for routing Self-loops. | CanonicMultiStageLayouter | |
| selfLoopLayouterEnabled : Boolean
Getter:
Returns whether or not the SelfLoopLayouter is enabled. | CanonicMultiStageLayouter | |
| subgraphLayouter : LayoutStage
Specifies the LayoutStage that is responsible for constraining the layout process to a subgraph of the target graph. | CanonicMultiStageLayouter | |
| subgraphLayouterEnabled : Boolean
Getter:
Returns whether or not the SubgraphLayouter is enabled. | CanonicMultiStageLayouter | |
| usePostprocessing : Boolean
Specifies if an additional postprocessing step is used that improves compactness and reduces the number of edge bends. | DirectedOrthogonalLayouter | ||
| useSketchDrawing : Boolean
Specifies if the existing drawing should be used as sketch. | DirectedOrthogonalLayouter | ||
| Method | Defined By | ||
|---|---|---|---|
DirectedOrthogonalLayouter(init:Boolean = true)
Creates a new instance of this class. | DirectedOrthogonalLayouter | ||
| appendStage(stage:LayoutStage):void
Appends a stage to the layout pipeline. | CanonicMultiStageLayouter | |
|
Returns a layout for the given layout graph. | CanonicMultiStageLayouter | |
|
Returns a layout for the given graph interface and layout. | CanonicMultiStageLayouter | |
| canLayout(graph:LayoutGraph):Boolean
Tests whether or not the given graph can be laid out by this layouter. | CanonicMultiStageLayouter | |
canLayoutCore(graph:LayoutGraph):Boolean [override]
| DirectedOrthogonalLayouter | ||
doLayout(graph:LayoutGraph):void [override] | DirectedOrthogonalLayouter | ||
|
Calculates a layout for the given graph interface and layout. | CanonicMultiStageLayouter | |
doLayoutCore(graph:LayoutGraph):void [override] | DirectedOrthogonalLayouter | ||
| enableOnlyCore():void
Disables all layout stages and performs only the core layouter. | CanonicMultiStageLayouter | |
| equals(o:Object):Boolean | YObject | |
getClass():Class [override] | DirectedOrthogonalLayouter | ||
| hashCode():int | YObject | |
[static]
Creates a new instance of this class. | DirectedOrthogonalLayouter | ||
| prependStage(stage:LayoutStage):void
Prepends a stage to the layout pipeline. | CanonicMultiStageLayouter | |
| removeStage(stage:LayoutStage):void
Removes a LayoutStage that has been previously added by the methods appendStage() or prependStage(). | CanonicMultiStageLayouter | |
| Method | Defined By | ||
|---|---|---|---|
| checkGroupNodeSize(layout:GraphLayout, node:Object):void
This method throws an com.yworks.bridge.util.IllegalArgumentException if the width/height of the given group node object is zero. | CanonicMultiStageLayouter | |
| checkNodeSize(layout:GraphLayout, node:Object):void
This method throws an com.yworks.bridge.util.IllegalArgumentException if the width/height of the given node object is zero. | CanonicMultiStageLayouter | |
Factory method that creates the default EdgeLayoutDescriptor. | DirectedOrthogonalLayouter | ||
| CanonicMultiStageLayouter | ||
Initializes this object. | DirectedOrthogonalLayouter | ||
| Constant | Defined By | ||
|---|---|---|---|
| DIRECTED_EDGE_DPKEY : Object = y.layout.orthogonal.DirectedOrthogonalLayouter.DIRECTED_EDGE_DPKEY [static]
DataProvider key that is used to mark edges that should be routed in a way that point in the main layout direction. | DirectedOrthogonalLayouter | ||
| EDGE_LAYOUT_DESCRIPTOR_DPKEY : Object = y.layout.orthogonal.OrthogonalLayouter.EDGE_LAYOUT_DESCRIPTOR_DPKEY [static]
com.yworks.yfiles.base.DataProvider key used to retrieve com.yworks.yfiles.layout.orthogonal.EdgeLayoutDescriptor instances for each edge in the graph. | DirectedOrthogonalLayouter | ||
| alignDegreeOneNodes | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesalignDegreeOneNodes:Boolean
Specifies whether the algorithm should try to align degree-one nodes that have the same neighbour.
The default is false.
public function get alignDegreeOneNodes():Boolean public function set alignDegreeOneNodes(value:Boolean):void| considerNodeLabels | property |
considerNodeLabels:Boolean
Getter:
Returns whether or not node labels are taken into account when calculating node positions (thereby preventing possible node/node label or node label/node label overlaps).
This method is a convenience method checks whether the label layouter (com.yworks.yfiles.layout.CanonicMultiStageLayouter.labelLayouter) is of type com.yworks.yfiles.layout.LabelLayoutTranslator and com.yworks.yfiles.layout.LabelLayoutTranslator.translateNodeLabels returns true. The default is false.
true. Note that setting this option may overwrite the currently set label layouter. 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.
public function get considerNodeLabels():Boolean public function set considerNodeLabels(value:Boolean):voidError — if the current label layouter is not of type com.yworks.yfiles.layout.LabelLayoutTranslator.
|
See also
| edgeLayoutDescriptor | property |
edgeLayoutDescriptor:EdgeLayoutDescriptor
Specifies the EdgeLayoutDescriptor instance used for all those edges, that do not have a specific layout descriptor assigned.
public function get edgeLayoutDescriptor():EdgeLayoutDescriptor public function set edgeLayoutDescriptor(value:EdgeLayoutDescriptor):voidReferenceError — if the argument is null
|
See also
| grid | property |
grid:intGetter: Returns the currently set grid spacing.
Setter: Sets the grid spacing to be used. By default a value of20 is set.
public function get grid():int public function set grid(value:int):void| integratedEdgeLabeling | property |
integratedEdgeLabeling:Boolean
Getter:
Returns whether integrated edge labeling is enabled.
This method is a convenience method that checks if the label layouter (com.yworks.yfiles.layout.CanonicMultiStageLayouter.labelLayouter) is of type com.yworks.yfiles.layout.LabelLayoutTranslator and com.yworks.yfiles.layout.LabelLayoutTranslator.translateEdgeLabels returns true. The default is false.
true
public function get integratedEdgeLabeling():Boolean public function set integratedEdgeLabeling(value:Boolean):voidError — if the current label layouter is not of type com.yworks.yfiles.layout.LabelLayoutTranslator.
|
See also
| optimizePerceivedBends | property |
optimizePerceivedBends:Boolean
Specifies whether the algorithm should perform a post processing algorithm to reduce perceived bends in the drawing.
The default is false.
public function get optimizePerceivedBends():Boolean public function set optimizePerceivedBends(value:Boolean):void| usePostprocessing | property |
usePostprocessing:BooleanSpecifies if an additional postprocessing step is used that improves compactness and reduces the number of edge bends. The postprocessing is enabled by default.
public function get usePostprocessing():Boolean public function set usePostprocessing(value:Boolean):void| useSketchDrawing | property |
useSketchDrawing:BooleanSpecifies if the existing drawing should be used as sketch.
public function get useSketchDrawing():Boolean public function set useSketchDrawing(value:Boolean):void| DirectedOrthogonalLayouter | () | Constructor |
public function DirectedOrthogonalLayouter(init:Boolean = true)Creates a new instance of this class.
Parametersinit:Boolean (default = true) |
| canLayoutCore | () | method |
override public function canLayoutCore(graph:LayoutGraph):Boolean
Parameters
graph:LayoutGraph |
Boolean — true for all graphs.
|
| createEdgeLayoutDescriptor | () | method |
protected function createEdgeLayoutDescriptor():EdgeLayoutDescriptor
Factory method that creates the default EdgeLayoutDescriptor.
May not return null!
EdgeLayoutDescriptor — a new EdgeLayoutDescriptor (new EdgeLayoutDescriptor())
|
| doLayout | () | method |
| doLayoutCore | () | method |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initDirectedOrthogonalLayouter | () | method |
protected final function initDirectedOrthogonalLayouter():void
Initializes this object. See the documentation of the corresponding factory method newDirectedOrthogonalLayouter() for details.
See also
| newDirectedOrthogonalLayouter | () | method |
public static function newDirectedOrthogonalLayouter():DirectedOrthogonalLayouterCreates a new instance of this class.
ReturnsDirectedOrthogonalLayouter |
| DIRECTED_EDGE_DPKEY | Constant |
public static const DIRECTED_EDGE_DPKEY:Object = y.layout.orthogonal.DirectedOrthogonalLayouter.DIRECTED_EDGE_DPKEYDataProvider key that is used to mark edges that should be routed in a way that point in the main layout direction. The main layout direction can be set by using method layoutOrientation .
See also
| EDGE_LAYOUT_DESCRIPTOR_DPKEY | Constant |
public static const EDGE_LAYOUT_DESCRIPTOR_DPKEY:Object = y.layout.orthogonal.OrthogonalLayouter.EDGE_LAYOUT_DESCRIPTOR_DPKEYcom.yworks.yfiles.base.DataProvider key used to retrieve com.yworks.yfiles.layout.orthogonal.EdgeLayoutDescriptor instances for each edge in the graph. Different settings will affect the routing of the edges during the layout.
See also