Event arguments used by Tapped.
Inheritance Hierarchy
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.TapEventArgs
Constructors
Initializes a new instance of the TapEventArgs class.
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 in which the tap occurred.
- location - Point
- The location.
- tapCount - number
- The number of taps associated with this event.
- originalEvent - Event
- The original event.
Properties
Gets the context for the current event.
Defined in
Gets or sets a value indicating whether this TapEventArgs have been handled.
Remarks
Client code that is triggered by the event and does not want the event to become handled by other handles should set this property to true
to stop propagation of the event.
Note that this property needs to be set before the function synchronously returns. This means that setting the value in an async
function after the first await
or in an asynchronous callback, it cannot not be seen by the emitter of the event and the sender will consider the event as not being handled.
// wrong:
mode.addTappedListener(async (sender, args) => {
await something()
args.handled = true // will be set *after* all other event listeners have been invoked, only
})
// correct:
mode.addTappedListener(async (sender, args) => {
args.handled = true // will be set immediately and 'mode' will see the change
await something()
})
Gets the location of the tap.