Interface for classes that help during snapping of parts of edges.
Inheritance Hierarchy
IEdgeSnapResultProvider
Remarks
An implementation of this class is obtained from the lookup of the IEdges which are being edited during an operation where graph snapping is involved.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.IEdgeSnapResultProvider
See Also
Methods
collectSnapResults
(context: GraphSnapContext, evt: CollectSnapResultsEventArgs, movementInfos: IListEnumerable<MovementInfo>, edge: IEdge)Called to during the snapping operation whenever snap results are collected.
Remarks
This method will be called for each collection of the results.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - GraphSnapContext
- The context that is using this instance.
- evt - CollectSnapResultsEventArgs
- The event argument to obtain the necessary information from and add results to.
- movementInfos - IListEnumerable<MovementInfo>
- The movement infos that describe the
edge. - edge - IEdge
- The edge for which the SnapResults should be collected.
Static Methods
create
(collectSnapResults: function(GraphSnapContext, CollectSnapResultsEventArgs, IListEnumerable<MovementInfo>, IEdge):void) : IEdgeSnapResultProviderCreates an implementation of the interface IEdgeSnapResultProvider 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, IListEnumerable<MovementInfo>, IEdge):void
- A function for IEdgeSnapResultProvider's single abstract method collectSnapResults.
Returns
- ↪IEdgeSnapResultProvider
- An instance of the IEdgeSnapResultProvider interface based on the given function.