Implementations of this interface can provide a path that is used to determine bridges by BridgeManager.
Inheritance Hierarchy
Remarks
Typically the ILookup implementation of styles will return an implementation of this interface.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.view.IObstacleProvider
See Also
Methods
Returns a path representing obstacles that would need bridges.
Remarks
For performance reasons the implementation should only return a non-
null GeneralPath if it might be visible in the provided clip.Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - IRenderContext
- The context for which the obstacles are queried.
Returns
- ↪GeneralPath
- A path that describes the obstacles or
nullif there are no obstacles for the given context.
Static Methods
Creates an implementation of the interface IObstacleProvider by using the given function as implementation for its getObstacles method.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- getObstacles - function(IRenderContext):GeneralPath
- A function for IObstacleProvider's single abstract method getObstacles.
Returns
- ↪IObstacleProvider
- An instance of the IObstacleProvider interface based on the given function.