| Package | com.yworks.yfiles.layout |
| Class | public class PartitionLayouter_ChannelInterEdgeRouter |
| Inheritance | PartitionLayouter_ChannelInterEdgeRouter  YObject Object |
| Implements | PartitionLayouter_InterEdgeRouter |
See also
| Property | Defined By | ||
|---|---|---|---|
| channelEdgeRouter : ChannelEdgeRouter
Specifies the com.yworks.yfiles.layout.router.ChannelEdgeRouter instance used to route inter-edges. | PartitionLayouter_ChannelInterEdgeRouter | ||
| interEdgeDPKey : Object
Specifies the com.yworks.yfiles.base.DataProvider key which is used to register the inter-edge data provider passed to routeInterEdges() on the given graph. | PartitionLayouter_ChannelInterEdgeRouter | ||
| margin : Number
Getter:
Returns the maximum relative distance between an edge and its closest node for edges routed outside the bounding box of all graph nodes. | PartitionLayouter_ChannelInterEdgeRouter | ||
| routeInterEdgesOnly : Boolean
Getter:
Returns true if this ChannelInterEdgeRouter is configured to route inter-partition edges only. | PartitionLayouter_ChannelInterEdgeRouter | ||
| Method | Defined By | ||
|---|---|---|---|
PartitionLayouter_ChannelInterEdgeRouter(init:Boolean = true)
Creates a new instance of this class. | PartitionLayouter_ChannelInterEdgeRouter | ||
 | equals(o:Object):Boolean | YObject | |
getClass():Class [override] | PartitionLayouter_ChannelInterEdgeRouter | ||
| hashCode():int | YObject | |
[static]
Creates a new instance of this class. | PartitionLayouter_ChannelInterEdgeRouter | ||
Routes inter-edges of the partitioned graph. | PartitionLayouter_ChannelInterEdgeRouter | ||
| Method | Defined By | ||
|---|---|---|---|
Initializes this object. | PartitionLayouter_ChannelInterEdgeRouter | ||
| channelEdgeRouter | property |
Hide Inherited Public Methods
Show Inherited Public MethodschannelEdgeRouter:ChannelEdgeRouterSpecifies the com.yworks.yfiles.layout.router.ChannelEdgeRouter instance used to route inter-edges.
public function get channelEdgeRouter():ChannelEdgeRouter public function set channelEdgeRouter(value:ChannelEdgeRouter):voidSee also
| interEdgeDPKey | property |
interEdgeDPKey:ObjectSpecifies the com.yworks.yfiles.base.DataProvider key which is used to register the inter-edge data provider passed to routeInterEdges() on the given graph. Defaults to com.yworks.yfiles.layout.LayouterKeys.SELECTED_EDGES.
public function get interEdgeDPKey():Object public function set interEdgeDPKey(value:Object):voidSee also
| margin | property |
margin:NumberGetter: Returns the maximum relative distance between an edge and its closest node for edges routed outside the bounding box of all graph nodes. A negative value means that there is no restriction for the edge-node distance.
Setter: Specifies the maximum relative distance between an edge and its closest node for edges that are routed outside the bounding box of all graph nodes. The value is relative in the way that edges to the left or right of the nodes' bounding box must satisfydist(edge, bounding box) <= (bounding box width) * margin and edges above or below the nodes' bounding box must satisfy dist(edge, bounding box) <= (bounding box height) * margin. Passing in a negative value effectively allow edges to be arbitrarily far from their closest nodes. By default margin is set to -1.0.
public function get margin():Number public function set margin(value:Number):void| routeInterEdgesOnly | property |
routeInterEdgesOnly:Boolean
Getter:
Returns true if this ChannelInterEdgeRouter is configured to route inter-partition edges only.
By default, all edges are routed, i.e. routeInterEdgesOnly is set to false.
routeInterEdgesOnly is set to false.
public function get routeInterEdgesOnly():Boolean public function set routeInterEdgesOnly(value:Boolean):voidSee also
| PartitionLayouter_ChannelInterEdgeRouter | () | Constructor |
public function PartitionLayouter_ChannelInterEdgeRouter(init:Boolean = true)Creates a new instance of this class.
Parametersinit:Boolean (default = true) |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initPartitionLayouter_ChannelInterEdgeRouter | () | method |
protected final function initPartitionLayouter_ChannelInterEdgeRouter():void
Initializes this object. See the documentation of the corresponding factory method newPartitionLayouter_ChannelInterEdgeRouter() for details.
See also
| newPartitionLayouter_ChannelInterEdgeRouter | () | method |
public static function newPartitionLayouter_ChannelInterEdgeRouter():PartitionLayouter_ChannelInterEdgeRouterCreates a new instance of this class.
ReturnsPartitionLayouter_ChannelInterEdgeRouter |
| routeInterEdges | () | method |
public function routeInterEdges(graph:LayoutGraph, partitionIDDP:DataProvider, interEdgeDP:DataProvider):void
Routes inter-edges of the partitioned graph.
This implementation will register/deregister interEdgeDP on the specified input graph before/after doing any actual routing.
Parameters
graph:LayoutGraph — the input graph.
| |
partitionIDDP:DataProvider — the partition id for each node in the graph.
| |
interEdgeDP:DataProvider — holds a boolean value for each edge of the graph indicating if the edge is an inter-edge or not.
|
See also