Provides data for the item-clicked, item-double-clicked, item-left-clicked, item-left-double-clicked, item-right-clicked and item-right-double-clicked events.
Type Parameters
- T
- The type of the item this event carries.
Type Details
- yFiles module
- view
Constructors
ItemClickedEventArgs
(item: T, context: IInputModeContext, location: Point, buttons: PointerButtons, clickCount: number, evt: PointerEventArgs)Initializes a new instance of the ItemClickedEventArgs<T> class.
Parameters
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.
- buttons - PointerButtons
- The pointer button(s) that have changed.
- clickCount - number
- The number of clicks.
- evt - PointerEventArgs
- The original pointer event args.
Properties
Gets a value indicating whether the alt modifier was pressed at the time of the click.
Gets the number of clicks associated with this event.
Remarks
Defined in
Gets the context for the current event.
Gets a value indicating whether the control modifier was pressed at the time of the click.
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()
})Property Value
true if handled; false otherwise.Defined in
Gets the location of the click.
Gets a value indicating whether the meta modifier was pressed at the time of the click.
Gets the state of the modifiers at the time of the click.
Gets the pointer event args that caused this event.
Defined in
Gets the PointerButtons that have changed for this event.
Defined in
Gets the type of the pointer that was the source of this event.
Defined in
Gets a value indicating whether the shift modifier was pressed at the time of the click.