Packagecom.yworks.yfiles.layout.router
Classpublic class EdgeGroupRouterStage
InheritanceEdgeGroupRouterStage Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

Layout stage for com.yworks.yfiles.layout.router.OrthogonalEdgeRouter that adds support for a bus-like routing style. Edges that connect to a common node can be marked as grouped by using the data provider keys com.yworks.yfiles.layout.PortConstraintKeys.SOURCE_GROUPID_KEY or com.yworks.yfiles.layout.PortConstraintKeys.TARGET_GROUPID_KEY . This stage tries to route grouped edges on a vertical or horizontal bus. The edges will connect to their common node at the same port coordinate. There are some limitations to this stage:

See also

com.yworks.yfiles.layout.router.OrthogonalEdgeRouter
com.yworks.yfiles.layout.PortConstraintKeys.SOURCE_GROUPID_KEY
com.yworks.yfiles.layout.PortConstraintKeys.TARGET_GROUPID_KEY


Public Properties
 PropertyDefined By
 InheritedcoreLayouter : Layouter
Specifies the core layouter.
AbstractLayoutStage
  minimalBusDistance : Number
Specifies the minimal distance between a bus formed by an edge group and the nodes the grouped edges connect to.
EdgeGroupRouterStage
Public Methods
 MethodDefined By
  
EdgeGroupRouterStage(coreLayouter:Layouter, init:Boolean = true)
EdgeGroupRouterStage
  
canLayout(graph:LayoutGraph):Boolean
[override]
EdgeGroupRouterStage
  
doLayout(graph:LayoutGraph):void
[override]
EdgeGroupRouterStage
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
EdgeGroupRouterStage
 Inherited
hashCode():int
YObject
  
[static]
EdgeGroupRouterStage
Protected Methods
 MethodDefined By
 Inherited
canLayoutCore(graph:LayoutGraph):Boolean
Queries the core layouter whether or not the given graph can be laid out.
AbstractLayoutStage
 Inherited
Invokes the layout routine of the core layouter.
AbstractLayoutStage
 Inherited
AbstractLayoutStage
 Inherited
AbstractLayoutStage
  
Initializes this object.
EdgeGroupRouterStage
Property Detail
minimalBusDistanceproperty
minimalBusDistance:Number

Specifies the minimal distance between a bus formed by an edge group and the nodes the grouped edges connect to. By default this value is set to 15.0.


Implementation
    public function get minimalBusDistance():Number
    public function set minimalBusDistance(value:Number):void
Constructor Detail
EdgeGroupRouterStage()Constructor
public function EdgeGroupRouterStage(coreLayouter:Layouter, init:Boolean = true)

Parameters
coreLayouter:Layouter
 
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
override public function canLayout(graph:LayoutGraph):Boolean

Parameters

graph:LayoutGraph

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

Parameters

graph:LayoutGraph

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

Returns
Class
initEdgeGroupRouterStage()method 
protected final function initEdgeGroupRouterStage(coreLayouter:Layouter):void

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

Parameters

coreLayouter:Layouter

See also

newEdgeGroupRouterStage()method 
public static function newEdgeGroupRouterStage(coreLayouter:Layouter):EdgeGroupRouterStage

Parameters

coreLayouter:Layouter

Returns
EdgeGroupRouterStage