ItemClickedEventArgs<T>

Show usages

Provides data for the ItemClicked, ItemDoubleClicked, ItemLeftClicked, ItemLeftDoubleClicked, ItemRightClicked and ItemRightDoubleClicked events.

Inheritance Hierarchy

EventArgs

InputModeEventArgs

ClickEventArgs

ItemClickedEventArgs

TableItemClickedEventArgs<T>

Type Parameters

T: The type of the item this event carries.

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.input.ItemClickedEventArgs

Constructors

ItemClickedEventArgs

(item: T, context: IInputModeContext, location: Point, modifiers?: ModifierKeys, mouseButtons?: MouseButtons, clickCount?: number)

Initializes a new instance of the ItemClickedEventArgs<T> class.

ParametersOptions Overload

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

item - T: The item which is the subject of the event.
context - IInputModeContext: The context in which the click or tap occurred.
location - Point: The location.
modifiers - ModifierKeys: State of the modifiers.
mouseButtons - MouseButtons: The mouse button(s) that have changed.
clickCount - number: The number of clicks.

Properties

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.

Defined in

ClickEventArgs

context

: IInputModeContext

Gets the context for the current event.

Defined in

InputModeEventArgs

handled

: boolean

Gets or sets a value indicating whether this ClickEventArgs 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.addItemClickedListener(async (sender, args) => {
  await something()
  args.handled = true // will be set *after* all other event listeners have been invoked, only
})

// correct:
mode.addItemClickedListener(async (sender, args) => {
  args.handled = true // will be set immediately and 'mode' will see the change
  await something()
})