This class encapsulates the information that determines the route of a specific item within a specific partition cell.
Default Values of Properties
enterSegmentGroup | null | The entering segment does not belong to any |
enterSegmentIndex | 0 | |
exitSegmentGroup | null | The exiting segment does not belong to any |
exitSegmentIndex | 0 |
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.EdgeCellInfo
Constructors
EdgeCellInfo
(item: Object, cell: PartitionCell, enterInterval: OrthogonalInterval, exitInterval: OrthogonalInterval, enterDirection: Direction, exitDirection: Direction, enterSegmentNo: number)Creates a new EdgeCellInfo instance.
Parameters
A map of options to pass to the method.
- item - Object
- 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 partition cell within which the item is routed.
Calculates the list of CellSegmentInfos for the segment parts that lie within the associated partition cell.
Gets the interval that is used to enter this cell.
Gets or sets the segment group containing the entering segment.
Remarks
Default Value
null
.The entering segment does not belong to any
See Also
Gets or sets the index of the segment that enters this cell.
Remarks
Default Value
0
.Throws
- Exception({ name: 'ArgumentError' })
- if the given index is negative
Gets the interval that is used to exit this cell.
Gets or sets the segment group containing the exiting segment.
Remarks
Default Value
null
.The exiting segment does not belong to any
See Also
Gets or sets the index of the segment that exits this cell.
Remarks
Default Value
0
.Throws
- Exception({ name: 'ArgumentError' })
- if the given index is negative
Gets the item that is routed within the partition cell.
Remarks
Gets the routing type within this cell.
Methods
Returns a string representation of the shape while crossing the partition cell.
Returns
- ↪string
- a string representation of the shape while crossing the partition cell