| Package | com.yworks.yfiles.layout.router.polyline |
| Class | public class PathSearchResult |
| Inheritance | PathSearchResult  YObject Object |
See also
| Method | Defined By | ||
|---|---|---|---|
PathSearchResult(configuration:PathSearchConfiguration, init:Boolean = true)
Creates a new instance. | PathSearchResult | ||
 | equals(o:Object):Boolean | YObject | |
getClass():Class [override] | PathSearchResult | ||
Returns an com.yworks.yfiles.layout.router.polyline.EdgeInfo for the given path. | PathSearchResult | ||
Returns an com.yworks.yfiles.layout.router.polyline.EdgeInfo for the given edge. | PathSearchResult | ||
Returns the earlier registered found path for the edge. | PathSearchResult | ||
| hashCode():int | YObject | |
[static]
Creates a new instance. | PathSearchResult | ||
Sets a found path for an edge. | PathSearchResult | ||
| Method | Defined By | ||
|---|---|---|---|
initPathSearchResult(configuration:PathSearchConfiguration):void
Initializes this object. | PathSearchResult | ||
| PathSearchResult | () | Constructor |
Hide Inherited Public Methods
Show Inherited Public Methodspublic function PathSearchResult(configuration:PathSearchConfiguration, init:Boolean = true)Creates a new instance.
Parametersconfiguration:PathSearchConfiguration — The configuration used for the path search.
| |
init:Boolean (default = true) |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| getEdgeInfo | () | method |
public function getEdgeInfo(path:Path):EdgeInfoReturns an com.yworks.yfiles.layout.router.polyline.EdgeInfo for the given path.
If no com.yworks.yfiles.layout.router.polyline.EdgeInfo has been created for this path by this context before, a new one is instantiated, otherwise the stored one is returned.
Parameters
path:Path — The path to return the com.yworks.yfiles.layout.router.polyline.EdgeInfo for.
|
EdgeInfo — An com.yworks.yfiles.layout.router.polyline.EdgeInfo describing this path.
|
See also
| getEdgeInfo2 | () | method |
public function getEdgeInfo2(edge:Edge):EdgeInfoReturns an com.yworks.yfiles.layout.router.polyline.EdgeInfo for the given edge.
If the given edge shall be routed but no path has been set for, yet, null is returned. If no com.yworks.yfiles.layout.router.polyline.EdgeInfo has been created for the path by this context before, a new one is instantiated, otherwise the stored one is returned.
Parameters
edge:Edge — The edge to return the com.yworks.yfiles.layout.router.polyline.EdgeInfo.
|
EdgeInfo — An com.yworks.yfiles.layout.router.polyline.EdgeInfo describing this the path of the edge.
|
See also
| getPath | () | method |
public function getPath(edge:Edge):PathReturns the earlier registered found path for the edge.
Parameters
edge:Edge — The edge to provide the found path for.
|
Path — The earlier registered found path for the edge or null, if no path has been registered, yet.
|
| initPathSearchResult | () | method |
protected final function initPathSearchResult(configuration:PathSearchConfiguration):void
Initializes this object. See the documentation of the corresponding factory method newPathSearchResult() for details.
Parameters
configuration:PathSearchConfiguration |
See also
| newPathSearchResult | () | method |
public static function newPathSearchResult(configuration:PathSearchConfiguration):PathSearchResultCreates a new instance.
Parameters
configuration:PathSearchConfiguration — The configuration used for the path search.
|
PathSearchResult |
| setPath | () | method |
public function setPath(edge:Edge, path:Path):voidSets a found path for an edge.
Parameters
edge:Edge — The edge to set the path for.
| |
path:Path — The found path.
|