This class describes the obstacles that are used by implementations of IObstaclePartition to subdivide an area into PartitionCells.
Inheritance Hierarchy
Obstacle
Default Values of Properties
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.Obstacle
Constructors
Creates a new Obstacle instance with the given bounds and additional data.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- bounds - YRectangle
- the bounds of the obstacle
- data - Object
- the additional data associated to the obstacle
Properties
Gets the bounds of the obstacle.
Gets or sets the cost penalty for entering this obstacle during a PathSearch.
Default Value
The default value is
0.Entering this obstacle does not induce any penalty.
Throws
- Exception({ name: 'ArgumentError' })
- if the cost is negative