Packagecom.yworks.yfiles.layout.router.polyline
Classpublic class PathSearchConfiguration
InheritancePathSearchConfiguration Inheritance YObject Inheritance Object

Contains the basic configuration used by path search algorithms.


Public Properties
 PropertyDefined By
  edgeRouter : EdgeRouter
[read-only] Returns the orthogonal layout algorithm using this configuration.
PathSearchConfiguration
  graph : LayoutGraph
[read-only] Returns the graph of the edge whose path is searched.
PathSearchConfiguration
  grouping : GraphGrouping
[read-only] Returns the grouping information of the graph.
PathSearchConfiguration
  restOfComputingTime : LongImpl
[read-only] Returns the remaining time in that the calculation of the algorithm should be completed.
PathSearchConfiguration
Public Methods
 MethodDefined By
  
PathSearchConfiguration(graph:LayoutGraph, grouping:GraphGrouping, edgeRouter:EdgeRouter, init:Boolean = true)
Creates a new configuration used for a path search.
PathSearchConfiguration
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
PathSearchConfiguration
 Inherited
hashCode():int
YObject
  
newPathSearchConfiguration(graph:LayoutGraph, grouping:GraphGrouping, edgeRouter:EdgeRouter):PathSearchConfiguration
[static] Creates a new configuration used for a path search.
PathSearchConfiguration
Protected Methods
 MethodDefined By
  
initPathSearchConfiguration(graph:LayoutGraph, grouping:GraphGrouping, edgeRouter:EdgeRouter):void
Initializes this object.
PathSearchConfiguration
Property Detail
edgeRouterproperty
edgeRouter:EdgeRouter  [read-only]

Returns the orthogonal layout algorithm using this configuration.


Implementation
    public function get edgeRouter():EdgeRouter
graphproperty 
graph:LayoutGraph  [read-only]

Returns the graph of the edge whose path is searched.


Implementation
    public function get graph():LayoutGraph
groupingproperty 
grouping:GraphGrouping  [read-only]

Returns the grouping information of the graph.


Implementation
    public function get grouping():GraphGrouping
restOfComputingTimeproperty 
restOfComputingTime:LongImpl  [read-only]

Returns the remaining time in that the calculation of the algorithm should be completed.


Implementation
    public function get restOfComputingTime():LongImpl
Constructor Detail
PathSearchConfiguration()Constructor
public function PathSearchConfiguration(graph:LayoutGraph, grouping:GraphGrouping, edgeRouter:EdgeRouter, init:Boolean = true)

Creates a new configuration used for a path search.

Parameters
graph:LayoutGraph — The graph of the edges whose path will be searched.
 
grouping:GraphGrouping — The grouping information of the graph.
 
edgeRouter:EdgeRouter — The orthogonal layout algorithm using this configuration.
 
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.
Method Detail
getClass()method
override public function getClass():Class

Returns
Class
initPathSearchConfiguration()method 
protected final function initPathSearchConfiguration(graph:LayoutGraph, grouping:GraphGrouping, edgeRouter:EdgeRouter):void

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

Parameters

graph:LayoutGraph
 
grouping:GraphGrouping
 
edgeRouter:EdgeRouter

See also

newPathSearchConfiguration()
newPathSearchConfiguration()method 
public static function newPathSearchConfiguration(graph:LayoutGraph, grouping:GraphGrouping, edgeRouter:EdgeRouter):PathSearchConfiguration

Creates a new configuration used for a path search.

Parameters

graph:LayoutGraph — The graph of the edges whose path will be searched.
 
grouping:GraphGrouping — The grouping information of the graph.
 
edgeRouter:EdgeRouter — The orthogonal layout algorithm using this configuration.

Returns
PathSearchConfiguration




Wed Oct 7 2015, 04:43 PM +02:00