| Package | com.yworks.yfiles.layout.router.polyline |
| Class | public class PolylineLayoutStage |
| Inheritance | PolylineLayoutStage  AbstractLayoutStage YObject Object |
See also
| Property | Defined By | ||
|---|---|---|---|
 | coreLayouter : Layouter
Specifies the core layouter. | AbstractLayoutStage | |
| maximumNonOrthogonalSegmentRatio : Number
Specifies the maximum segment length ratio at each end of an orthogonal segment that may get converted into a (non-orthogonal) polyline segment. | PolylineLayoutStage | ||
| minimalNodeToEdgeDistance : Number
Specifies the minimal distance between edges and node bounds. | PolylineLayoutStage | ||
| preferredPolylineSegmentLength : Number
Specifies the preferred segment length for (non-orthogonal) polyline segments. | PolylineLayoutStage | ||
| selectedEdgesDpKey : Object
Specifies the data provider key used to look up the selected state of the edges of the graph to be laid out. | PolylineLayoutStage | ||
| selectedNodesDpKey : Object
Specifies the data provider key used to look up the selected state of the nodes of the graph to be laid out. | PolylineLayoutStage | ||
| sphereOfAction : int
Determines the (sub-)set of edges to be routed polylinear. | PolylineLayoutStage | ||
| Method | Defined By | ||
|---|---|---|---|
PolylineLayoutStage(init:Boolean = true) | PolylineLayoutStage | ||
canLayout(graph:LayoutGraph):Boolean [override] | PolylineLayoutStage | ||
doLayout(graph:LayoutGraph):void [override] | PolylineLayoutStage | ||
| equals(o:Object):Boolean | YObject | |
getClass():Class [override] | PolylineLayoutStage | ||
| hashCode():int | YObject | |
[static] | PolylineLayoutStage | ||
[static]
Initializes this layout stage with the given core layouter. | PolylineLayoutStage | ||
| Method | Defined By | ||
|---|---|---|---|
| canLayoutCore(graph:LayoutGraph):Boolean
Queries the core layouter whether or not the given graph can be laid out. | AbstractLayoutStage | |
| doLayoutCore(graph:LayoutGraph):void
Invokes the layout routine of the core layouter. | AbstractLayoutStage | |
| initAbstractLayoutStage1():void | AbstractLayoutStage | |
| initAbstractLayoutStage2(core:Layouter):void | AbstractLayoutStage | |
initPolylineLayoutStage1():void
Initializes this object. | PolylineLayoutStage | ||
initPolylineLayoutStage2(coreLayouter:Layouter):void
Initializes this object. | PolylineLayoutStage | ||
| Constant | Defined By | ||
|---|---|---|---|
| ROUTE_ALL_EDGES : int = 0 [static]
Sphere of action specifier. | PolylineLayoutStage | ||
| ROUTE_EDGES_AT_SELECTED_NODES : int = 4 [static]
Sphere of action specifier. | PolylineLayoutStage | ||
| ROUTE_SELECTED_EDGES : int = 2 [static]
Sphere of action specifier. | PolylineLayoutStage | ||
| maximumNonOrthogonalSegmentRatio | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesmaximumNonOrthogonalSegmentRatio:NumberSpecifies the maximum segment length ratio at each end of an orthogonal segment that may get converted into a (non-orthogonal) polyline segment. Default is 0.5.
public function get maximumNonOrthogonalSegmentRatio():Number public function set maximumNonOrthogonalSegmentRatio(value:Number):voidIllegalArgumentException — If the ratio is out of bounds.
|
| minimalNodeToEdgeDistance | property |
minimalNodeToEdgeDistance:NumberSpecifies the minimal distance between edges and node bounds. Default is 10.
public function get minimalNodeToEdgeDistance():Number public function set minimalNodeToEdgeDistance(value:Number):voidIllegalArgumentException — If distance is less than 0.
|
| preferredPolylineSegmentLength | property |
preferredPolylineSegmentLength:NumberSpecifies the preferred segment length for (non-orthogonal) polyline segments. Default is 50.
public function get preferredPolylineSegmentLength():Number public function set preferredPolylineSegmentLength(value:Number):voidIllegalArgumentException — If length is less than 0.
|
| selectedEdgesDpKey | property |
selectedEdgesDpKey:ObjectSpecifies the data provider key used to look up the selected state of the edges of the graph to be laid out. By default, com.yworks.yfiles.layout.LayouterKeys.SELECTED_EDGES is used.
If the sphere of action is set to ROUTE_SELECTED_EDGES, only the selected keys are routed while all other edges are considered to have fixed routes.
public function get selectedEdgesDpKey():Object public function set selectedEdgesDpKey(value:Object):voidIllegalArgumentException — if the specified key is null.
|
See also
| selectedNodesDpKey | property |
selectedNodesDpKey:ObjectSpecifies the data provider key used to look up the selected state of the nodes of the graph to be laid out. By default, com.yworks.yfiles.layout.LayouterKeys.SELECTED_NODES is used.
If the sphere of action is set to ROUTE_EDGES_AT_SELECTED_NODES, only edges of selected nodes are routed while all other edges are considered to have fixed routes.
public function get selectedNodesDpKey():Object public function set selectedNodesDpKey(value:Object):voidIllegalArgumentException — if the specified key is null.
|
See also
| sphereOfAction | property |
sphereOfAction:intDetermines the (sub-)set of edges to be routed polylinear. Default setting is ROUTE_ALL_EDGES.
public function get sphereOfAction():int public function set sphereOfAction(value:int):voidIllegalArgumentException — if the given argument is not one of the above constants.
|
See also
| PolylineLayoutStage | () | Constructor |
public function PolylineLayoutStage(init:Boolean = true)Parameters
init:Boolean (default = true) |
| canLayout | () | method |
override public function canLayout(graph:LayoutGraph):BooleanParameters
graph:LayoutGraph |
Boolean |
| doLayout | () | method |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initPolylineLayoutStage1 | () | method |
protected final function initPolylineLayoutStage1():void
Initializes this object. See the documentation of the corresponding factory method newPolylineLayoutStage1() for details.
See also
| initPolylineLayoutStage2 | () | method |
protected final function initPolylineLayoutStage2(coreLayouter:Layouter):void
Initializes this object. See the documentation of the corresponding factory method newPolylineLayoutStage2() for details.
Parameters
coreLayouter:Layouter |
See also
| newPolylineLayoutStage1 | () | method |
| newPolylineLayoutStage2 | () | method |
public static function newPolylineLayoutStage2(coreLayouter:Layouter):PolylineLayoutStageInitializes this layout stage with the given core layouter.
Parameters
coreLayouter:Layouter — The core layouter to wrap with this layout stage.
|
PolylineLayoutStage |
| ROUTE_ALL_EDGES | Constant |
public static const ROUTE_ALL_EDGES:int = 0Sphere of action specifier. Route all edges of the input graph.
See also
| ROUTE_EDGES_AT_SELECTED_NODES | Constant |
public static const ROUTE_EDGES_AT_SELECTED_NODES:int = 4Sphere of action specifier. Route only edges connected to selected nodes. The selection state of a node is determined by a boolean value returned by the data provider associated with the data provider key selectedNodesDpKey.
See also
| ROUTE_SELECTED_EDGES | Constant |
public static const ROUTE_SELECTED_EDGES:int = 2Sphere of action specifier. Route only selected edges of the input graph. The selection state of an edge is determined by a boolean value returned by the data provider associated with the data provider key selectedEdgesDpKey.
See also