Packagecom.yworks.yfiles.layout.router
Classpublic class ChannelEdgeRouter_OrthogonalShortestPathPathFinder
InheritanceChannelEdgeRouter_OrthogonalShortestPathPathFinder Inheritance OrthogonalEdgeRouter Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

This layouter is a s special version of com.yworks.yfiles.layout.router.OrthogonalEdgeRouter that can be used as a path finding strategy in com.yworks.yfiles.layout.router.ChannelEdgeRouter. It takes a bit longer than using the default path finding strategy com.yworks.yfiles.layout.router.OrthogonalPatternEdgeRouter but therefore will create no node crossings. It can be configured like OrthogonalEdgeRouter.

See also

com.yworks.yfiles.layout.router.OrthogonalEdgeRouter
com.yworks.yfiles.layout.router.ChannelEdgeRouter
com.yworks.yfiles.layout.router.OrthogonalPatternEdgeRouter


Public Properties
 PropertyDefined By
  affectedEdgesDPKey : Object
Getter: Returns the key of a DataProvider that defines the edges, that shall be affected Setter: Determines a key, that is registered on the graph and determines the edges which shall be affected by this router.
ChannelEdgeRouter_OrthogonalShortestPathPathFinder
 InheritedbadOrthogonal : Boolean
Getter: Returns whether bad edges should be drawn in an orthogonal fashion.
OrthogonalEdgeRouter
 InheritedcenterToSpaceRatio : Number
Getter: Returns the currently set ratio between the two complementary weighting strategies center driven and space driven.
OrthogonalEdgeRouter
 InheritedconsiderNodeLabels : Boolean
Specifies whether or not node labels are taken into account when calculating edge paths (thereby preventing possible edge/node label overlaps).
OrthogonalEdgeRouter
 InheritedcoreLayouter : Layouter
Specifies the core layouter.
AbstractLayoutStage
 InheritedcoupledDistances : Boolean
Getter: Returns whether the minimum distances are coupled.
OrthogonalEdgeRouter
 InheritedcrossingCost : Number
Specifies the cost for each edge crossing of a routed path.
OrthogonalEdgeRouter
 InheritedcustomBorderCapacity : int
Getter: Returns the currently set custom value for the capacity of the routing border around the graph's bounding box.
OrthogonalEdgeRouter
 InheritedenforceMonotonicPathRestrictions : Boolean
Getter: Returns whether monotonic path restrictions (set with monotonicPathRestriction) should be enforced.
OrthogonalEdgeRouter
 InheritedgridOrigin : YPoint
[read-only] Returns a grid point coordinate used when grid routing is enabled.
OrthogonalEdgeRouter
 InheritedgridRouting : Boolean
Specifies whether or not to route edge segments on grid lines.
OrthogonalEdgeRouter
 InheritedgridSpacing : int
Specifies the grid spacing that is used when grid routing is enabled.
OrthogonalEdgeRouter
 InheritedinnerPorts : Boolean
Specifies whether edge ports (that do not have a strong port constraint set) should lie inside the node's bounding box or on the node's border.
OrthogonalEdgeRouter
 InheritedlocalCrossingMinimization : Boolean
Getter: Returns whether the local crossing minimization strategy is enabled.
OrthogonalEdgeRouter
 InheritedminimumDistance : int
Specifies the minimum distance between edge segments.
OrthogonalEdgeRouter
 InheritedminimumDistanceToNode : int
Specifies the minimum distance between edge segments and nodes.
OrthogonalEdgeRouter
 InheritedmonotonicPathRestriction : int
Getter: Returns the specified kind of monotonic path restrictions.
OrthogonalEdgeRouter
 Inheritedrerouting : Boolean
Getter: Returns whether rerouting bad edges is enabled.
OrthogonalEdgeRouter
 InheritedroutingStyle : int
Getter: Returns the currently set routing style.
OrthogonalEdgeRouter
 InheritedselectedEdgesDpKey : Object
Specifies the DataProvider key to mark edges as selected.
OrthogonalEdgeRouter
 InheritedselectedNodesDpKey : Object
Specifies the DataProvider key to mark nodes as selected.
OrthogonalEdgeRouter
 InheritedsphereOfAction : int
Getter: Returns the currently set sphere of action specifier.
OrthogonalEdgeRouter
 InheriteduseCustomBorderCapacity : Boolean
Getter: Returns whether a custom value for the capacity of the routing border is used.
OrthogonalEdgeRouter
Public Methods
 MethodDefined By
  
ChannelEdgeRouter_OrthogonalShortestPathPathFinder
  
canLayout(graph:LayoutGraph):Boolean
[override]
ChannelEdgeRouter_OrthogonalShortestPathPathFinder
  
doLayout(graph:LayoutGraph):void
[override]
ChannelEdgeRouter_OrthogonalShortestPathPathFinder
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
ChannelEdgeRouter_OrthogonalShortestPathPathFinder
 Inherited
hashCode():int
YObject
  
[static]
ChannelEdgeRouter_OrthogonalShortestPathPathFinder
 Inherited
[static] Creates a new instance of the Orthogonal Edge Router.
OrthogonalEdgeRouter
 Inherited
[static] Convenience constructor to simultaneously set a core layout algorithm which will run before the orthogonal edge router.
OrthogonalEdgeRouter
 Inherited
setGridOrigin(x:int, y:int):void
Sets a grid point coordinate used when grid routing is enabled.
OrthogonalEdgeRouter
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
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.
OrthogonalEdgeRouter
 Inherited
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.
OrthogonalEdgeRouter
 Inherited
Invokes the layout routine of the core layouter.
AbstractLayoutStage
 Inherited
AbstractLayoutStage
 Inherited
AbstractLayoutStage
  
ChannelEdgeRouter_OrthogonalShortestPathPathFinder
 Inherited
Initializes this object.
OrthogonalEdgeRouter
 Inherited
Initializes this object.
OrthogonalEdgeRouter
Public Constants
 ConstantDefined By
 InheritedMONOTONIC_BOTH : int = 3
[static] Constant that specifies monotonic path restrictions for edges.
OrthogonalEdgeRouter
 InheritedMONOTONIC_HORIZONTAL : int = 2
[static] Constant that specifies monotonic path restrictions for edges.
OrthogonalEdgeRouter
 InheritedMONOTONIC_NONE : int = 0
[static] Constant that specifies monotonic path restrictions for edges.
OrthogonalEdgeRouter
 InheritedMONOTONIC_VERTICAL : int = 1
[static] Constant that specifies monotonic path restrictions for edges.
OrthogonalEdgeRouter
 InheritedROUTE_ALL_EDGES : int = 0
[static] Sphere of action specifier.
OrthogonalEdgeRouter
 InheritedROUTE_EDGES_AT_SELECTED_NODES : int = 4
[static] Sphere of action specifier.
OrthogonalEdgeRouter
 InheritedROUTE_SELECTED_EDGES : int = 2
[static] Sphere of action specifier.
OrthogonalEdgeRouter
 InheritedSTYLE_ADHOC : int
[static] Routing style specifier.
OrthogonalEdgeRouter
 InheritedSTYLE_BALANCED : int
[static] Routing style specifier.
OrthogonalEdgeRouter
 InheritedSTYLE_PREFERMIDDLE : int
[static] Routing style specifier.
OrthogonalEdgeRouter
 InheritedSTYLE_SHORTPATH : int
[static] Routing style specifier.
OrthogonalEdgeRouter
Property Detail
affectedEdgesDPKeyproperty
affectedEdgesDPKey:Object

Getter: Returns the key of a DataProvider that defines the edges, that shall be affected

Setter: Determines a key, that is registered on the graph and determines the edges which shall be affected by this router.


Implementation
    public function get affectedEdgesDPKey():Object
    public function set affectedEdgesDPKey(value:Object):void
Constructor Detail
ChannelEdgeRouter_OrthogonalShortestPathPathFinder()Constructor
public function ChannelEdgeRouter_OrthogonalShortestPathPathFinder(init:Boolean = true)



Parameters
init:Boolean (default = true)
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
initChannelEdgeRouter_OrthogonalShortestPathPathFinder()method 
protected final function initChannelEdgeRouter_OrthogonalShortestPathPathFinder():void

newChannelEdgeRouter_OrthogonalShortestPathPathFinder()method 
public static function newChannelEdgeRouter_OrthogonalShortestPathPathFinder():ChannelEdgeRouter_OrthogonalShortestPathPathFinder

Returns
ChannelEdgeRouter_OrthogonalShortestPathPathFinder