Package | com.yworks.yfiles.layout.router.polyline |
Class | public class SegmentGroup |
Inheritance | SegmentGroup YObject Object |
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
Property | Defined 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 |
Method | Defined By | ||
---|---|---|---|
Creates a new segment group. | SegmentGroup | ||
equals(o:Object):Boolean | YObject | ||
getClass():Class [override] | SegmentGroup | ||
hashCode():int [override] | SegmentGroup | ||
[static]
Creates a new segment group. | SegmentGroup |
Method | Defined By | ||
---|---|---|---|
Initializes this object. | SegmentGroup |
commonLocationRange | property |
commonLocationRange:Interval
[read-only] Returns the common location range for the segment infos in this group.
public function get commonLocationRange():Interval
commonSegmentInfo | property |
commonSegmentInfo:SegmentInfo
[read-only] Returns the common segment info representing the grouped segment infos.
public function get commonSegmentInfo():SegmentInfo
segmentInfos | property |
segmentInfos:List
[read-only] Returns the segment infos contained in this group.
public function get segmentInfos():List
SegmentGroup | () | Constructor |
public function SegmentGroup(commonLocationRange:Interval, segmentInfos:List, init:Boolean = true)
Creates a new segment group.
ParameterscommonLocationRange: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.
|
getClass | () | method |
override public function getClass():Class
ReturnsClass |
hashCode | () | method |
override public function hashCode():int
Returnsint |
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.
|
SegmentGroup |