This class stores location information for orthogonal item segments.
Remarks
Default Values of Properties
| location | 0 | No fixed location for the segment info has been set. |
| preferredAlignment | ANY | The segment can be placed anywhere within its location range. |
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.SegmentInfoBase
Constructors
SegmentInfoBase
(item: Object, segmentIndex: number, direction: Direction, locationRange: Interval, minExtension: Interval, maxExtension: Interval)Creates a new instance of SegmentInfoBase.
Parameters
A map of options to pass to the method.
- item - Object
- the item to which the segment of this info belongs
- segmentIndex - number
- the index of the segment to which this info belongs
- direction - Direction
- the direction to which the segment of this info points
- locationRange - Interval
- the range within which the common location of this segment has to lie
- minExtension - Interval
- the minimum interval in extension direction this segment is known to intersect
- maxExtension - Interval
- the maximum interval in extension direction this segment will span
Creates a new instance of SegmentInfoBase using a line segment to describe the edge segment.
Remarks
Parameters
A map of options to pass to the method.
- item - Object
- the item to which this segment info belongs
- segmentIndex - number
- the index of the segment to which this info belongs
- segment - LineSegment
- a line segment describing the item segment
Properties
Gets whether or not this segment info is fixed, i.e., a fixed location has been determined within its location range.
Gets or sets the fixed location within the location range for this segment info.
Remarks
Default Value
0.No fixed location for the segment info has been set.
Throws
- Exception({ name: 'InvalidOperationError' })
- if the segment info already has a fixed location
- Exception({ name: 'ArgumentError' })
- if the given location does not lie within the location range
See Also
Sample Graphs
Gets the range, i.e., the interval within which the segment should be placed.
Remarks
Gets the maximum extension that this segment can span.
Remarks
Gets the minimum known extension of the segment, i.e., the minimum interval that this segment will cover in any case.
Remarks
Gets or sets the segment group to which this segment info belongs.
Remarks
See Also
Methods
Returns a string representation of this SegmentInfoBase object.
Returns
- ↪string
- a string representation of this SegmentInfoBase object