An interface for classes that can yield IHandle implementations for the source and target ends of an IEdge.
Inheritance Hierarchy
IEdgePortHandleProvider
Remarks
This interface will be queried by the default implementation of the IHandleProvider that is in the lookup of an IEdge. It is recommended to use this interface instead of the more generic IHandleProvider interface, because other generic code can then use this interface to gain access to a specific IHandle more easily.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.IEdgePortHandleProvider
See Also
Methods
Gets an IHandle implementation for one end of the provided edge.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - IInputModeContext
- The context in which the handle will be used.
- edge - IEdge
- The edge for which an handle is needed.
- sourceHandle - boolean
- if set to
truethe handle for the source side/port should be returned.
Returns
- ↪IHandle
- The handle to use for the provided side or
null.
Static Methods
Creates an implementation of the interface IEdgePortHandleProvider by using the given function as implementation for its getHandle method.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- getHandle - function(IInputModeContext, IEdge, boolean):IHandle
- A function for IEdgePortHandleProvider's single abstract method getHandle.
Returns
- ↪IEdgePortHandleProvider
- An instance of the IEdgePortHandleProvider interface based on the given function.