Packagecom.yworks.yfiles.layout.router.polyline
Classpublic class SegmentGroup
InheritanceSegmentGroup Inheritance YObject Inheritance Object

Represents a group of segments of different edges, that shall be combined at the common source or target side.

Grouped edges have the same source or target group id assigned in the data provider registered at the graph with the com.yworks.yfiles.layout.PortConstraintKeys.SOURCE_GROUPID_KEY or com.yworks.yfiles.layout.PortConstraintKeys.TARGET_GROUPID_KEY key.

The segment group contains the common location range for the edge group and provides a common segment info representing the grouped segment infos.

See also

com.yworks.yfiles.layout.PortConstraintKeys.SOURCE_GROUPID_KEY
com.yworks.yfiles.layout.PortConstraintKeys.TARGET_GROUPID_KEY


Public Properties
 PropertyDefined By
  commonLocationRange : Interval
[read-only] Returns the common location range for the segment infos in this group.
SegmentGroup
  commonSegmentInfo : SegmentInfo
[read-only] Returns the common segment info representing the grouped segment infos.
SegmentGroup
  segmentInfos : List
[read-only] Returns the segment infos contained in this group.
SegmentGroup
Public Methods
 MethodDefined By
  
SegmentGroup(commonLocationRange:Interval, segmentInfos:List, init:Boolean = true)
Creates a new segment group.
SegmentGroup
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
SegmentGroup
  
hashCode():int
[override]
SegmentGroup
  
newSegmentGroup(commonLocationRange:Interval, segmentInfos:List):SegmentGroup
[static] Creates a new segment group.
SegmentGroup
Protected Methods
 MethodDefined By
  
initSegmentGroup(commonLocationRange:Interval, segmentInfos:List):void
Initializes this object.
SegmentGroup
Property Detail
commonLocationRangeproperty
commonLocationRange:Interval  [read-only]

Returns the common location range for the segment infos in this group.


Implementation
    public function get commonLocationRange():Interval
commonSegmentInfoproperty 
commonSegmentInfo:SegmentInfo  [read-only]

Returns the common segment info representing the grouped segment infos.


Implementation
    public function get commonSegmentInfo():SegmentInfo
segmentInfosproperty 
segmentInfos:List  [read-only]

Returns the segment infos contained in this group.


Implementation
    public function get segmentInfos():List
Constructor Detail
SegmentGroup()Constructor
public function SegmentGroup(commonLocationRange:Interval, segmentInfos:List, init:Boolean = true)

Creates a new segment group.

Parameters
commonLocationRange:Interval — The location range of the segment infos.
 
segmentInfos:List — A list containing the grouped segment infos.
 
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
hashCode()method 
override public function hashCode():int

Returns
int
initSegmentGroup()method 
protected final function initSegmentGroup(commonLocationRange:Interval, segmentInfos:List):void

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

Parameters

commonLocationRange:Interval
 
segmentInfos:List

See also

newSegmentGroup()method 
public static function newSegmentGroup(commonLocationRange:Interval, segmentInfos:List):SegmentGroup

Creates a new segment group.

Parameters

commonLocationRange:Interval — The location range of the segment infos.
 
segmentInfos:List — A list containing the grouped segment infos.

Returns
SegmentGroup