An implementation of the IObstacleProvider interface that uses the edges and nodes of an IGraph as obstacles.
Remarks
The BridgeManager then calculates bridges for edge paths that cross these obstacles.
This class can be used to add bridge support via the BridgeManager to a rendered IGraph.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.view.GraphObstacleProvider
See Also
Properties
Gets or sets a value indicating whether to query the edges for an IObstacleProvider implementation.
Remarks
The default is
true.Gets or sets a value indicating whether to query the nodes for an IObstacleProvider implementation.
See Also
Methods
Helper method that retrieves the IGraph to use from the context
Remarks
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 to retrieve the implementation from.
Returns
Iterates over all edges and nodes to query an IObstacleProvider from the IModelItem's lookup.
Remarks
This method will depending on the queryEdges and queryNodes property query the items for an implementation of IObstacleProvider and concatenate all resulting GeneralPath obstacles into one path that will then be returned.
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 where the obstacles are queried for.
Returns
- ↪GeneralPath
- A path that is the concatenated path of all obstacles for the given context.