This class stores information about the part of an item segment that lies inside a specified partition cell.
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.CellSegmentInfo
Constructors
CellSegmentInfo
(item: Object, segmentIndex: number, direction: Direction, locationRange: Interval, minExtension: Interval, maxExtension: Interval, cell: PartitionCell)Creates a new CellSegmentInfo instance.
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 part is known to intersect
- maxExtension - Interval
- the maximum interval in extension direction this segment part will span
- cell - PartitionCell
- the partition cell within which this part of the edge segment lies
Properties
Gets the partition cell within which this part of the edge segment lies.
Gets the direction to which the segment of this info points.
Overrides
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.
Gets or sets the segment group to which this segment info belongs.
Remarks
See Also
Defined in
Gets the index of the segment of this info.
Defined in
Gets whether or not the associated segment is vertical.
Defined in
Methods
Returns a string representation of this SegmentInfoBase object.