com.yworks.yfiles.layout.router.polyline.EdgeInfo

	Property	Defined By
		edge : Edge [read-only] Returns the edge whose route is described by this info.	EdgeInfo
		edgeCellInfos : List [read-only] Returns a list of com.yworks.yfiles.layout.router.polyline.EdgeCellInfo s describing how the edge traverses each com.yworks.yfiles.layout.router.polyline.PartitionCell on its path.	EdgeInfo
		fixed : Boolean [read-only] Determines whether the path of this edge (edge) is fixed or shall be routed by the path search algorithm.	EdgeInfo
		strongSourcePort : YPoint Getter: Returns the location of the strong source port the edge uses.	EdgeInfo
		strongTargetPort : YPoint Getter: Returns the location of the strong target port the edge uses.	EdgeInfo

	Method	Defined By
		EdgeInfo(path:Path, configuration:PathSearchConfiguration, init:Boolean = true) Creates a new instance.	EdgeInfo
		calculateLineSegments():Vector.<Object> Returns an array of com.yworks.yfiles.geom.LineSegment s created from the calculated path points (calculatePathPoints()).	EdgeInfo
		calculatePathPoints():YList Returns a list of com.yworks.yfiles.geom.YPoint s containing the source port, bend and target port locations.	EdgeInfo
		equals(o:Object):Boolean	YObject
		getClass():Class [override]	EdgeInfo
		getEdgeCellInfo(entrance:CellEntrance):EdgeCellInfo Returns the com.yworks.yfiles.layout.router.polyline.EdgeCellInfo of the given com.yworks.yfiles.layout.router.polyline.CellEntrance in the path.	EdgeInfo
		getNextSegment(segment:SegmentInfo):SegmentInfo Returns the segment info of the segment following the segment of the given segment info.	EdgeInfo
		getPreviousSegment(segment:SegmentInfo):SegmentInfo Returns the segment info of the segment preceding the segment of the given segment info.	EdgeInfo
		getSegmentInfo(segmentIndex:int):SegmentInfo Returns the segment info the the segment with the given index.	EdgeInfo
		hashCode():int	YObject
		newEdgeInfo1(path:Path, configuration:PathSearchConfiguration):EdgeInfo [static] Creates a new instance.	EdgeInfo
		segmentCount():int Returns the number of segments of the edge.	EdgeInfo
		toString():String	EdgeInfo

	Method	Defined By
		initEdgeInfo1(path:Path, configuration:PathSearchConfiguration):void Initializes this object.	EdgeInfo

Property Detail

edge

property

edge:Edge [read-only]

Returns the edge whose route is described by this info.

Implementation
public function get edge():Edge

edgeCellInfos

property

edgeCellInfos:List [read-only]

Returns a list of com.yworks.yfiles.layout.router.polyline.EdgeCellInfo s describing how the edge traverses each com.yworks.yfiles.layout.router.polyline.PartitionCell on its path.

Implementation
public function get edgeCellInfos():List

fixed

property

fixed:Boolean [read-only]

Determines whether the path of this edge (edge) is fixed or shall be routed by the path search algorithm.

Implementation
public function get fixed():Boolean

See also

edge

strongSourcePort

property

strongSourcePort:YPoint

Getter: Returns the location of the strong source port the edge uses.

Setter: Sets the location of the strong source port the edge uses and updates the first com.yworks.yfiles.layout.router.polyline.SegmentInfo to use this fixed port location.

Implementation
public function get strongSourcePort():YPoint
public function set strongSourcePort(value:YPoint):void

Throws

IllegalArgumentException — If the first segment is already fixed and the given port location contradicts the segments fixed location.

strongTargetPort

property

strongTargetPort:YPoint

Getter: Returns the location of the strong target port the edge uses.

Setter: Sets the location of the strong target port the edge uses and updates the last com.yworks.yfiles.layout.router.polyline.SegmentInfo to use this fixed port location.

Implementation
public function get strongTargetPort():YPoint
public function set strongTargetPort(value:YPoint):void

Throws

IllegalArgumentException — If the last segment is already fixed and the given port location contradicts the segments fixed location.

Constructor Detail

EdgeInfo

()

Constructor

public function EdgeInfo(path:Path, configuration:PathSearchConfiguration, init:Boolean = true)

Creates a new instance.

Parameters

	`path:Path` — The path that shall be used to route the edge.

	`configuration:PathSearchConfiguration` — The configuration of the path search algorithm.

	`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

calculateLineSegments

()

method

public function calculateLineSegments():Vector.<Object>

Returns an array of com.yworks.yfiles.geom.LineSegment s created from the calculated path points (calculatePathPoints()).

Returns

Vector.<Object> — An array of LineSegments created from the calculated path points.

calculatePathPoints

()

method

public function calculatePathPoints():YList

Returns a list of com.yworks.yfiles.geom.YPoint s containing the source port, bend and target port locations.

Returns

YList — A list of YPoints containing the source port, bend and target port locations.

See also

com.yworks.yfiles.geom.YPoint

getClass

()

method

override public function getClass():Class

Returns

Class

getEdgeCellInfo

()

method

public function getEdgeCellInfo(entrance:CellEntrance):EdgeCellInfo

Returns the com.yworks.yfiles.layout.router.polyline.EdgeCellInfo of the given com.yworks.yfiles.layout.router.polyline.CellEntrance in the path.

Parameters

entrance:CellEntrance — The entrance to get the edge cell info for.

Returns

EdgeCellInfo — The EdgeCellInfo of the given CellEntrance in the path.

getNextSegment

()

method

public function getNextSegment(segment:SegmentInfo):SegmentInfo

Returns the segment info of the segment following the segment of the given segment info.

Parameters

segment:SegmentInfo — The segmentInfo for which the following segment info shall be returned.

Returns

SegmentInfo — The segment info of the segment following the segment of the given segment info.

getPreviousSegment

()

method

public function getPreviousSegment(segment:SegmentInfo):SegmentInfo

Returns the segment info of the segment preceding the segment of the given segment info.

Parameters

segment:SegmentInfo — The segmentInfo for which the previous segment info shall be returned.

Returns

SegmentInfo — The segment info of the segment preceding the segment of the given segment info.

getSegmentInfo

()

method

public function getSegmentInfo(segmentIndex:int):SegmentInfo

Returns the segment info the the segment with the given index.

Parameters

segmentIndex:int — The index of the edge segment to return the segment info for.

Returns

SegmentInfo — The segment info the the segment with the given index.

initEdgeInfo1

()

method

protected final function initEdgeInfo1(path:Path, configuration:PathSearchConfiguration):void

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

Parameters

	`path:Path`

	`configuration:PathSearchConfiguration`

See also

newEdgeInfo1()

newEdgeInfo1

()

method

public static function newEdgeInfo1(path:Path, configuration:PathSearchConfiguration):EdgeInfo

Creates a new instance.

Parameters

	`path:Path` — The path that shall be used to route the edge.

	`configuration:PathSearchConfiguration` — The configuration of the path search algorithm.

Returns

EdgeInfo

segmentCount

()

method

public function segmentCount():int

Returns the number of segments of the edge.

Returns

int — The number of segments of the edge.

toString

()

method

public function toString():String

Returns

String

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

yFiles FLEX Client Layout Extension 1.5 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
EdgeInfo	Properties \| Methods

Package	com.yworks.yfiles.layout.router.polyline
Class	public class EdgeInfo
Inheritance	EdgeInfo YObject Object