| Package | com.yworks.yfiles.layout.router |
| Class | public class ChannelEdgeRouter |
| Inheritance | ChannelEdgeRouter  AbstractLayoutStage YObject Object |
See also
| Property | Defined By | ||
|---|---|---|---|
 | coreLayouter : Layouter
Specifies the core layouter. | AbstractLayoutStage | |
| edgeDistributionStrategy : Layouter
Getter:
Returns the currently used edge distribution strategy of this router. | ChannelEdgeRouter | ||
| pathFinderStrategy : Layouter
Getter:
Returns the currently used path finder strategy of this router. | ChannelEdgeRouter | ||
| Method | Defined By | ||
|---|---|---|---|
ChannelEdgeRouter(init:Boolean = true) | ChannelEdgeRouter | ||
canLayout(graph:LayoutGraph):Boolean [override] | ChannelEdgeRouter | ||
doLayout(graph:LayoutGraph):void [override] | ChannelEdgeRouter | ||
| equals(o:Object):Boolean | YObject | |
getClass():Class [override] | ChannelEdgeRouter | ||
| hashCode():int | YObject | |
[static] | ChannelEdgeRouter | ||
| Method | Defined By | ||
|---|---|---|---|
| canLayoutCore(graph:LayoutGraph):Boolean
Queries the core layouter whether or not the given graph can be laid out. | AbstractLayoutStage | |
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. | ChannelEdgeRouter | ||
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. | ChannelEdgeRouter | ||
| doLayoutCore(graph:LayoutGraph):void
Invokes the layout routine of the core layouter. | AbstractLayoutStage | |
| initAbstractLayoutStage1():void | AbstractLayoutStage | |
| initAbstractLayoutStage2(core:Layouter):void | AbstractLayoutStage | |
initChannelEdgeRouter():void
Initializes this object. | ChannelEdgeRouter | ||
| Constant | Defined By | ||
|---|---|---|---|
| AFFECTED_EDGES : Object = y.layout.router.ChannelEdgeRouter.AFFECTED_EDGES [static]
This field is used as the key to add a DataProvider to the graph, which specifies the edges, that are affected by the edge routing. | ChannelEdgeRouter | ||
| edgeDistributionStrategy | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesedgeDistributionStrategy:LayouterGetter: Returns the currently used edge distribution strategy of this router.
Setter: Sets the strategy with which overlapping edge segments will be distributed in their provided channel. Note: when exchanging only one of the strategies, make sure, that their algorithms will use the same (sub)set of graph objects. The strategies bound to this router by default will us key AFFECTED_EDGES to determine the affected edges. public function get edgeDistributionStrategy():Layouter public function set edgeDistributionStrategy(value:Layouter):voidSee also
| pathFinderStrategy | property |
pathFinderStrategy:LayouterGetter: Returns the currently used path finder strategy of this router.
Setter: Sets the strategy for path finding. Path finding means routing the edges in a first approach. Note: when exchanging only one of the strategies, make sure, that their algorithms will use the same (sub)set of graph objects. The strategies bound to this router by default will us key AFFECTED_EDGES to determine the affected edges. public function get pathFinderStrategy():Layouter public function set pathFinderStrategy(value:Layouter):voidSee also
| ChannelEdgeRouter | () | Constructor |
public function ChannelEdgeRouter(init:Boolean = true)Parameters
init:Boolean (default = true) |
| canLayout | () | method |
override public function canLayout(graph:LayoutGraph):BooleanParameters
graph:LayoutGraph |
Boolean |
| checkGroupNodeSize | () | method |
protected function checkGroupNodeSize(layout:GraphLayout, node:Object):voidThis method throws an com.yworks.bridge.util.IllegalArgumentException if the width/height of the given group node object is zero. It is called by the doLayout() method for each group node object in the input graph.
Parameters
layout:GraphLayout — a graph layout object.
| |
node:Object — the group node object to test.
|
IllegalArgumentException — thrown if the width/height of the group node object is zero.
|
See also
| checkNodeSize | () | method |
protected function checkNodeSize(layout:GraphLayout, node:Object):voidThis method throws an com.yworks.bridge.util.IllegalArgumentException if the width/height of the given node object is zero. It is called by the doLayout() method for each node object in the input graph.
Parameters
layout:GraphLayout — a graph layout object.
| |
node:Object — the node object to test.
|
IllegalArgumentException — thrown if the width/height of the node object is zero.
|
See also
| doLayout | () | method |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initChannelEdgeRouter | () | method |
protected final function initChannelEdgeRouter():void
Initializes this object. See the documentation of the corresponding factory method newChannelEdgeRouter() for details.
See also
| newChannelEdgeRouter | () | method |
| AFFECTED_EDGES | Constant |
public static const AFFECTED_EDGES:Object = y.layout.router.ChannelEdgeRouter.AFFECTED_EDGESThis field is used as the key to add a DataProvider to the graph, which specifies the edges, that are affected by the edge routing.