TableItemTappedEventArgs<T>

Show usages

Provides data for the ItemTapped and ItemDoubleTapped events.

Inheritance Hierarchy

EventArgs

InputModeEventArgs

TapEventArgs

ItemTappedEventArgs<T>

TableItemTappedEventArgs

Type Parameters

T: The type of the item this event carries.

Type Details

yfiles module: view-table
yfiles-umd modules: view-table, view
Legacy UMD name: yfiles.input.TableItemTappedEventArgs

Constructors

TableItemTappedEventArgs

(item: T, region: StripeSubregion, tableNode: INode, context: IInputModeContext, location: Point, clickCount: number)

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

Parameters

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

item - T: The item which is the subject of the event.
region - StripeSubregion: The specific region on a stripe where the click has occured.
tableNode - INode: The table node where item is associated.
context - IInputModeContext: The context in which the click or tap occurred.
location - Point: The location.
clickCount - number: The number of clicks.

Properties

context

: IInputModeContext

Gets the context for the current event.

Defined in

InputModeEventArgs

handled

: boolean

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()
})