Represents a group of segments of different edges that shall be combined at their common source or target.
Inheritance Hierarchy
SegmentGroup
Remarks
Grouped edges have the same source or target group ID assigned in the IDataProvider registered with the graph with SOURCE_GROUP_ID_DP_KEY or TARGET_GROUP_ID_DP_KEY keys.
The SegmentGroup contains the common location range for the edge group and provides a common segment info representing the grouped segments.
Type Details
- yfiles module
- router-polyline
- yfiles-umd modules
- layout-area, layout-multipage, layout-orthogonal-compact, layout, router-bus, router-polyline
- Legacy UMD name
- yfiles.router.SegmentGroup
Constructors
Creates a new instance of SegmentGroup that contains the given segments and a range to place them.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- commonLocationRange - Interval
- the location range of the given SegmentInfos
- segmentInfos - IList<Object>
- the list containing the grouped SegmentInfos
Properties
Gets the common SegmentInfo representing the grouped segments.
Remarks
The returned segment info is used for placing the common segment. The coordinates are applied to all edges in the bundle later.
Gets the list of SegmentInfos contained in this group.
Methods
Returns the hash code for this SegmentGroup.
Returns
- ↪number
- the hash code for this SegmentGroup