This class encapsulates the information that determines the route of a specific item within a specific PartitionCell.
Inheritance Hierarchy
EdgeCellInfo
Default Values of Properties
| enterSegmentIndex | 0 | |
| exitSegmentIndex | 0 |
Type Details
- yFiles module
- algorithms
Constructors
EdgeCellInfo
(item: any, cell: PartitionCell, enterInterval: OrthogonalInterval, exitInterval: OrthogonalInterval, enterDirection: Direction, exitDirection: Direction, enterSegmentNo: number)Creates a new EdgeCellInfo instance.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- item - any
- the item whose routing in the cell is described
- cell - PartitionCell
- the cell in which the item is routed
- enterInterval - OrthogonalInterval
- the interval that the item uses to enter the cell
- exitInterval - OrthogonalInterval
- the interval that the item uses to exit the cell
- enterDirection - Direction
- the direction in which the item enters the cell
- exitDirection - Direction
- the direction in which the item exits the cell
- enterSegmentNo - number
- the index of the item segment that enters the cell
Properties
Gets the PartitionCell within which the item is routed.
Property Value
the partition cell within which the item is routed
Gets the interval that is used to enter this cell.
Property Value
The interval that is used to enter this partition cell
Gets or sets the index of the segment that enters this cell.
Remarks
Values should be non-negative.
Default Value
The default value is
0.Property Value
the index of the segment that enters this cell
Throws
- Exception({ name: 'ArgumentError' })
- if the given index is negative
Gets the interval that is used to exit this cell.
Property Value
the interval that is used to exit this partition cell
Gets or sets the index of the segment that exits this cell.
Remarks
Values should be non-negative.
Default Value
The default value is
0.Property Value
the index of the segment that exits this cell
Throws
- Exception({ name: 'ArgumentError' })
- if the given index is negative
Gets the item that is routed within the partition cell.
Remarks
The item is either of type PathSearchRequest or LayoutEdge.
Property Value
the item that is routed within the partition cell
Gets the routing type within this cell.
Property Value
the routing type within this cell
Methods
Returns a string representation of the shape while crossing the PartitionCell.
Returns
- ↪string
- A string representation of the shape while crossing the partition cell