A SegmentInfo holds information about the possible location of an orthogonal edge segment.
Remarks
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.SegmentInfo
Constructors
SegmentInfo
(edge: Edge, segmentIndex: number, direction: Direction, locationRange: Interval, minExtension: Interval, maxExtension: Interval, cellSegmentInfos: IList<Object>)Creates a new instance of SegmentInfo with the given information.
Parameters
A map of options to pass to the method.
- edge - Edge
- the edge 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
- cellSegmentInfos - IList<Object>
- the list of CellSegmentInfo objects upon which this segment info is built
Creates a new instance of SegmentInfo using a LineSegment to describe the edge segment.
Parameters
A map of options to pass to the method.
- edge - Edge
- the edge to which the segment of this info belongs
- segmentIndex - number
- the index of the segment to which this info belongs
- segment - LineSegment
- a line segment describing the edge segment
Properties
Gets or sets whether or not this edge segment has the restriction of a strong PortConstraint.
Gets the Direction to which the segment of this info points.
Defined in
Gets the edge to which the segment of this info belongs.
Gets whether or not this segment info is fixed, i.e., a fixed location has been determined within its location range.
Defined in
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
Defined in
Gets the range, i.e., the interval within which the segment should be placed.
Remarks
Defined in
Gets the maximum extension that this segment can span.
Remarks
Defined in
Gets the minimum known extension of the segment, i.e., the minimum interval that this segment will cover in any case.
Remarks
Defined in
Gets or sets the preferred placement of this segment within its location range.
Sets the segment group for this segment info and its associated CellSegmentInfos.
Gets the index of the segment of this info.
Defined in
Gets whether or not the associated segment is vertical.
Defined in
Methods
Returns the number of CellSegmentInfo of this segment info.
Returns
- ↪number
- the number of CellSegmentInfo of this segment info
Returns the CellSegmentInfo at the given index of this segment info.
Parameters
A map of options to pass to the method.
- index - number
- the index of the CellSegmentInfo to return
Returns
- ↪CellSegmentInfo
- the CellSegmentInfo at the given index of this segment info
Returns a string representation of this SegmentInfoBase object.