Interface that is used by the GraphSnapContext for port to collect a number of SnapResults during the move/edit operation.
Inheritance Hierarchy
IPortSnapResultProvider
Remarks
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.IPortSnapResultProvider
See Also
Methods
collectSnapResults
(context: GraphSnapContext, evt: CollectSnapResultsEventArgs, suggestedLocation: Point, port: IPort)Called when a node is dragged to add SnapResults for OrthogonalSnapLines to which this bend can potentially snap.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - GraphSnapContext
- The snap context which manages the snap lines and the settings.
- evt - CollectSnapResultsEventArgs
- The event argument to obtain the necessary information from and add results to.
- suggestedLocation - Point
- The location of the bend if the bend would not snap.
- port - IPort
- The port that is being moved
Static Methods
create
(collectSnapResults: function(GraphSnapContext, CollectSnapResultsEventArgs, Point, IPort):void) : IPortSnapResultProviderCreates an implementation of the interface IPortSnapResultProvider by using the given function as implementation for its collectSnapResults method.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- collectSnapResults - function(GraphSnapContext, CollectSnapResultsEventArgs, Point, IPort):void
- A function for IPortSnapResultProvider's single abstract method collectSnapResults.
Returns
- ↪IPortSnapResultProvider
- An instance of the IPortSnapResultProvider interface based on the given function.