Packagecom.yworks.yfiles.layout.router
Classpublic class ReducedSphereOfActionStage
InheritanceReducedSphereOfActionStage Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

Performance optimization stage for com.yworks.yfiles.layout.router.OrthogonalEdgeRouter. This layout stage is applicable when only a subset of the edges in the input graph should be routed orthogonally.

See also

com.yworks.yfiles.layout.router.OrthogonalEdgeRouter


Public Properties
 PropertyDefined By
  activationThreshold : int
Specifies the activation threshold for this class.
ReducedSphereOfActionStage
 InheritedcoreLayouter : Layouter
Specifies the core layouter.
AbstractLayoutStage
Public Methods
 MethodDefined By
  
ReducedSphereOfActionStage(coreLayouter:Layouter, init:Boolean = true)
Creates a new instance of ReducedSphereOfActionStage.
ReducedSphereOfActionStage
  
canLayout(graph:LayoutGraph):Boolean
[override]
ReducedSphereOfActionStage
  
doLayout(graph:LayoutGraph):void
[override] Assigns orthogonal edge paths to the selected edges of a graph, efficiently.
ReducedSphereOfActionStage
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
ReducedSphereOfActionStage
 Inherited
hashCode():int
YObject
  
[static] Creates a new instance of ReducedSphereOfActionStage.
ReducedSphereOfActionStage
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.
ReducedSphereOfActionStage
Property Detail
activationThresholdproperty
activationThreshold:int

Specifies the activation threshold for this class. This stage will perform its optimization step only if the sum of the edges and nodes of the input graph is bigger than the activation threshold. By default the threshold value is set to 200.


Implementation
    public function get activationThreshold():int
    public function set activationThreshold(value:int):void
Constructor Detail
ReducedSphereOfActionStage()Constructor
public function ReducedSphereOfActionStage(coreLayouter:Layouter, init:Boolean = true)

Creates a new instance of ReducedSphereOfActionStage.

Parameters
coreLayouter:Layouter — the core layouter invoked by this stage. The coreLayouter must contain an instance of com.yworks.yfiles.layout.router.OrthogonalEdgeRouter its layout pipeline.
 
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.

See also

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

Assigns orthogonal edge paths to the selected edges of a graph, efficiently. Note that this stage will only have an optimizing effect if not all edges of the graph should be routed.

Precondition a LayoutStage of getCoreLayouter() must be an instance of OrthogonalEdgeRouter.

Parameters

graph:LayoutGraph

See also

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

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

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

Parameters

coreLayouter:Layouter

See also

newReducedSphereOfActionStage()method 
public static function newReducedSphereOfActionStage(coreLayouter:Layouter):ReducedSphereOfActionStage

Creates a new instance of ReducedSphereOfActionStage.

Parameters

coreLayouter:Layouter — the core layouter invoked by this stage. The coreLayouter must contain an instance of com.yworks.yfiles.layout.router.OrthogonalEdgeRouter its layout pipeline.

Returns
ReducedSphereOfActionStage

See also