Event arguments for the CollectSnapResults event.
Inheritance Hierarchy
EventArgs
InputModeEventArgs
CollectSnapResultsEventArgs
Remarks
Event handlers can use the addSnapResult method to add snapping results for the current move operation.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.CollectSnapResultsEventArgs
Constructors
CollectSnapResultsEventArgs
(context: IInputModeContext, originalLocation: Point, newLocation: Point, snapDistance: number, gridSnapDistance: number, snapResults: ICollection<SnapResult>)Creates a new instance of the event arguments using the provided values for initialization.
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 for which the event is queried.
- originalLocation - Point
- The original location of the mouse at the beginning of the gesture.
- newLocation - Point
- The new (current) location of the mouse.
- snapDistance - number
- The zoom invariant snap distance.
- gridSnapDistance - number
- The zoom invariant grid snap distance.
- snapResults - ICollection<SnapResult>
- The collection to store the snap results in.
Properties
Gets the context for the current event.
Defined in
Gets the vector by which the mouse has been moved since initialization of the snapping process.
Gets the new (current) location of the mouse that is going to be manipulated by the snapping process.
Gets the original location of the mouse at the beginning of the gesture.
Methods
Adds a SnapResult to the collection of snap results.
Remarks
null values will be discarded.Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- snapResult - SnapResult
- The result to add.