C

CollectSnapResultsEventArgs

Event arguments for the collect-snap-results event.

Remarks

Event handlers can use the addSnapResult method to add snapping results for the current move operation.

Members

Show:

Constructors

Creates a new instance of the event arguments using the provided values for initialization.

Parameters

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.
readonlyfinal

Property Value

The context.
Gets the vector by which the mouse has been moved since initialization of the snapping process.
readonlyfinal

Property Value

The delta.
Gets the zoom invariant grid snap distance.
readonlyfinal
Gets the new (current) location of the mouse that is going to be manipulated by the snapping process.
readonlyfinal

Property Value

The new (current) location.
Gets the original location of the mouse at the beginning of the gesture.
readonlyfinal

Property Value

The original location.
Gets the zoom invariant snap distance.
readonlyfinal

Methods

Adds a SnapResult to the collection of snap results.
null values will be discarded.

Parameters

snapResult: SnapResult
The result to add.