Packagecom.yworks.yfiles.layout.organic
Classpublic class SplitEdgeLayoutStage
InheritanceSplitEdgeLayoutStage Inheritance YObject Inheritance Object
Implements LayoutStage

This layout stage replaces edges by a path of nodes before it calls a core layouter. After the core layouter is finished this stage transforms the substituted path of nodes back to the original edge. For each node in the path there will be a bend in the original edge. The coordinate of the bend will be the center coordinate of the corresponding path node.



Public Properties
 PropertyDefined By
  coreLayouter : Layouter
Specifies the core layouter.
SplitEdgeLayoutStage
  proxyNodeSize : Number
Specifies the size which is used as width/height for proxy nodes, i.e.
SplitEdgeLayoutStage
  splitEdgesDpKey : Object
Specifies the DataProvider key that determines which edges are to be split.
SplitEdgeLayoutStage
  splitNodesDpKey : Object
Specifies the DataProvider key to mark the nodes, that were created by splitting edges, for the core layouter.
SplitEdgeLayoutStage
  splitSegmentLength : Number
Specifies the split segment length.
SplitEdgeLayoutStage
Public Methods
 MethodDefined By
  
SplitEdgeLayoutStage(init:Boolean = true)
Creates a new instance of SplitEdgeLayouter
SplitEdgeLayoutStage
  
canLayout(graph:LayoutGraph):Boolean
Returns true
SplitEdgeLayoutStage
  
doLayout(graph:LayoutGraph):void
Assigns a new graph layout to the given layout graph
SplitEdgeLayoutStage
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
SplitEdgeLayoutStage
 Inherited
hashCode():int
YObject
  
[static] Creates a new instance of SplitEdgeLayouter
SplitEdgeLayoutStage
Protected Methods
 MethodDefined By
  
Initializes this object.
SplitEdgeLayoutStage
Property Detail
coreLayouterproperty
coreLayouter:Layouter

Specifies the core layouter.


Implementation
    public function get coreLayouter():Layouter
    public function set coreLayouter(value:Layouter):void
proxyNodeSizeproperty 
proxyNodeSize:Number

Specifies the size which is used as width/height for proxy nodes, i.e. nodes inserted by this layout stage.


Implementation
    public function get proxyNodeSize():Number
    public function set proxyNodeSize(value:Number):void
splitEdgesDpKeyproperty 
splitEdgesDpKey:Object

Specifies the DataProvider key that determines which edges are to be split.

By default, com.yworks.yfiles.layout.LayouterKeys.SELECTED_EDGES is used.

If no DataProvider is registered with this key, all edges will be split.


Implementation
    public function get splitEdgesDpKey():Object
    public function set splitEdgesDpKey(value:Object):void

Throws
IllegalArgumentException — if the specified key is null.

See also

splitNodesDpKeyproperty 
splitNodesDpKey:Object

Specifies the DataProvider key to mark the nodes, that were created by splitting edges, for the core layouter.

By default, com.yworks.yfiles.layout.LayouterKeys.SELECTED_NODES is used.

The layout algorithm ignores any previous information stored in this DataProvider during the layout process but restores it after the core layouter has finished.


Implementation
    public function get splitNodesDpKey():Object
    public function set splitNodesDpKey(value:Object):void

Throws
IllegalArgumentException — if the specified key is null.

See also

splitSegmentLengthproperty 
splitSegmentLength:Number

Specifies the split segment length. The split segment length determines the length of the path that will replace an original edge in the graph. The length of the original edge path divided by the given split segment length yields the number of nodes on the new node path.


Implementation
    public function get splitSegmentLength():Number
    public function set splitSegmentLength(value:Number):void
Constructor Detail
SplitEdgeLayoutStage()Constructor
public function SplitEdgeLayoutStage(init:Boolean = true)

Creates a new instance of SplitEdgeLayouter

Parameters
init:Boolean (default = true) — An internally used switch to help handle proper instance initialization in inheritance chains where classes can have multiple constructor-like factory methods. This parameter can safely be ignored/omitted when calling the constructor.
Method Detail
canLayout()method
public function canLayout(graph:LayoutGraph):Boolean

Returns true

Parameters

graph:LayoutGraph

Returns
Boolean
doLayout()method 
public function doLayout(graph:LayoutGraph):void

Assigns a new graph layout to the given layout graph

Parameters

graph:LayoutGraph

getClass()method 
override public function getClass():Class

Returns
Class
initSplitEdgeLayoutStage()method 
protected final function initSplitEdgeLayoutStage():void

Initializes this object. See the documentation of the corresponding factory method newSplitEdgeLayoutStage() for details.

See also

newSplitEdgeLayoutStage()method 
public static function newSplitEdgeLayoutStage():SplitEdgeLayoutStage

Creates a new instance of SplitEdgeLayouter

Returns
SplitEdgeLayoutStage