Queried by the GraphSnapContext to add OrthogonalSnapLines to its collections during the initialization phase.
Inheritance Hierarchy
ISnapLineProvider
Remarks
Implementations of this interface are queried by GraphSnapContext for each item that is not modified during the edit using the lookup of the respective item.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.ISnapLineProvider
See Also
Methods
Called by the GraphSnapContext when a drag is about to start.
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 which holds the settings for the snap lines. Note that implementations should not change the state of the context explicitly.
- evt - CollectGraphSnapLinesEventArgs
- The argument to use for adding snap lines.
- item - IModelItem
- The item to add snap lines for.
Static Methods
create
(addSnapLines: function(GraphSnapContext, CollectGraphSnapLinesEventArgs, IModelItem):void) : ISnapLineProviderCreates an implementation of the interface ISnapLineProvider by using the given function as implementation for its addSnapLines method.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- addSnapLines - function(GraphSnapContext, CollectGraphSnapLinesEventArgs, IModelItem):void
- A function for ISnapLineProvider's single abstract method addSnapLines.
Returns
- ↪ISnapLineProvider
- An instance of the ISnapLineProvider interface based on the given function.