ClickEventArgs

Show usages

Event arguments used by clicked and handleClick.

Inheritance Hierarchy

EventArgs

InputModeEventArgs

ClickEventArgs

ItemClickedEventArgs<T>

TableItemClickedEventArgs<T>

Type Details

yFiles module: view

Constructors

ClickEventArgs

(context: IInputModeContext, location: Point, buttons: PointerButtons, clickCount: number, evt: PointerEventArgs)

Initializes a new instance of the ClickEventArgs class.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The context in which the click occurred.
location - Point: The location.
buttons - PointerButtons: The buttons.
clickCount - number: The number of clicks associated with this event.
evt - PointerEventArgs: The original pointer event args.

Properties

altKey

: boolean

Gets a value indicating whether the alt modifier was pressed at the time of the click.

Property Value

true if the alt modifier was pressed; otherwise, false.

clickCount

: number

Gets the number of clicks associated with this event.

Remarks

This can be used to distinguish between single and multiple clicks. Note that for compatibility reasons, a negative value means that no click count has been provided at event creation time.

context

: IInputModeContext

Gets the context for the current event.

Property Value

The context.

Defined in

InputModeEventArgs

ctrlKey

: boolean

Gets a value indicating whether the control modifier was pressed at the time of the click.

Property Value

true if the control modifier was pressed; otherwise, false.

handled

: boolean

Gets or sets a value indicating whether this instance has been handled.

Remarks

Client code that is triggered by the event and does not want the event to become handled by other handlers 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.addEventListener('item-clicked', async (evt) => {
  await something()
  evt.handled = true // will be set *after* all other event listeners have been invoked, only
})

// correct:
mode.addEventListener('item-clicked', async (evt) => {
  evt.handled = true // will be set immediately and 'mode' will see the change
  await something()
})