EventRecognizers

Show usages

Provides implementation singletons and utility methods for event recognizers.

Inheritance Hierarchy

EventRecognizers

Type Details

yFiles module: view

Constants

ALT_DOWN

: function(EventArgs, unknown):boolean

An event recognizer for the key-down event of the Alt key.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

ALT_IS_DOWN

: function(EventArgs, unknown):boolean

An event recognizer that recognizes when the Alt modifier is active.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

ALT_UP

: function(EventArgs, unknown):boolean

An event recognizer for the key-up event of the Alt key.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

ALWAYS

: function(EventArgs, unknown):boolean

An event recognizer that will always return true;

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

CTRL_DOWN

: function(EventArgs, unknown):boolean

An event recognizer for the key-down event of the Control key.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

CTRL_IS_DOWN

: function(EventArgs, unknown):boolean

An event recognizer that recognizes when the Ctrl modifier is active.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

CTRL_UP

: function(EventArgs, unknown):boolean

An event recognizer for the key-up event of the Control key.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

ESCAPE_DOWN

: function(EventArgs, unknown):boolean

An event recognizer for the key down event of the Escape key.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

META_DOWN

: function(EventArgs, unknown):boolean

An event recognizer for the key-down event of the Meta key.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

META_IS_DOWN

: function(EventArgs, unknown):boolean

An event recognizer that recognizes when the Meta modifier is active.

Remarks

Meta maps to the Windows key on Windows platforms and the Command key on Mac.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

META_UP

: function(EventArgs, unknown):boolean

An event recognizer for the key-up event of the Meta key.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

MOUSE_DOWN

: function(EventArgs, unknown):boolean

An event recognizer that identifies MOUSE and PEN down events.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

MOUSE_DRAG

: function(EventArgs, unknown):boolean

An event recognizer that identifies MOUSE and PEN drags.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

MOUSE_LEFT_CLICK

: function(EventArgs, unknown):boolean

An event recognizer that identifies clicks with the left mouse button or the PEN.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

MOUSE_LEFT_DOUBLE_CLICK

: function(EventArgs, unknown):boolean

An event recognizer that identifies double clicks with the left mouse button or the PEN.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

MOUSE_LEFT_DOWN

: function(EventArgs, unknown):boolean

An event recognizer that identifies down events of the left mouse button and of the PEN_CONTACT of a PEN.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

MOUSE_LEFT_DRAG

: function(EventArgs, unknown):boolean

An event recognizer that identifies drag events with the left mouse button or the PEN_CONTACT of a PEN.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

MOUSE_LEFT_UP

: function(EventArgs, unknown):boolean

An event recognizer that identifies up events of the left mouse button and of the PEN_CONTACT of a PEN.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

MOUSE_MOVE

: function(EventArgs, unknown):boolean

An event recognizer that identifies MOUSE and PEN movements that are not drags.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

MOUSE_OR_STYLUS_LONG_PRESS

: function(EventArgs, unknown):boolean

An event recognizer that identifies long presses of the primary touch pointer.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

MOUSE_UP

: function(EventArgs, unknown):boolean

An event recognizer that identifies MOUSE and PEN up events.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

NEVER

: function(EventArgs, unknown):boolean

An event recognizer that will always return false;

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

SHIFT_DOWN

: function(EventArgs, unknown):boolean

An event recognizer for the key-down event of the Shift key.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

SHIFT_IS_DOWN

: function(EventArgs, unknown):boolean

An event recognizer that recognizes when the Shift modifier is active.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

SHIFT_UP

: function(EventArgs, unknown):boolean

An event recognizer for the key-up event of the Shift key.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

TOUCH_PRIMARY_DOUBLE_TAP

: function(EventArgs, unknown):boolean

An event recognizer that identifies double-taps of the primary touch pointer.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

TOUCH_PRIMARY_DOWN

: function(EventArgs, unknown):boolean

An event recognizer that identifies down events of the primary touch pointer.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

TOUCH_PRIMARY_DRAG

: function(EventArgs, unknown):boolean

An event recognizer that identifies movements (DRAG) of the primary touch point.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

TOUCH_PRIMARY_LONG_PRESS

: function(EventArgs, unknown):boolean

An event recognizer that identifies long presses of the primary touch pointer.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

TOUCH_PRIMARY_LONG_REST

: function(EventArgs, unknown):boolean

An event recognizer that identifies long rest events of the primary touch pointer.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

TOUCH_PRIMARY_TAP

: function(EventArgs, unknown):boolean

An event recognizer that identifies taps of the primary touch pointer.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

TOUCH_PRIMARY_UP

: function(EventArgs, unknown):boolean

An event recognizer that identifies up events of the primary touch pointer.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

Static Methods

createKeyEventRecognizer

(type: KeyEventType, data: string, modifiers?: ModifierKeys) : function(EventArgs, unknown):boolean

Creates an event recognizer for a given key and type using a given set of modifiers.

Parameters

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

type - KeyEventType: The type of the event.
data - string: The key that is subject of the event.
modifiers - ModifierKeys: The state of the modifiers that must be set. This is NONE if not set.

Returns

↪function(EventArgs, unknown):boolean

The new event recognizer.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

createPointerEventRecognizer

(pointerTypes?: PointerType[], eventTypes?: PointerEventType[], buttons?: PointerButtons, changedButtons?: PointerButtons, clickCount?: number, modifiers?: ModifierKeys, changedModifiers?: ModifierKeys) : function(EventArgs, unknown):boolean

Creates an event recognizer for the given arguments.

Remarks

A null arguments is ignored in the event detection.

ParametersOptions Overload

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

pointerTypes - PointerType[]: Any one of the pointerTypes must be present in the event.
eventTypes - PointerEventType[]: Any one of the eventTypes must be present in the event.
buttons - PointerButtons: All buttons that must be set in the event.
changedButtons - PointerButtons: All changedButtons that must be set in the event.
clickCount - number: The clickCount of the event.
modifiers - ModifierKeys: All modifiers that must be set in the event.
changedModifiers - ModifierKeys: All changedModifiers that must be set in the event.

Returns

↪function(EventArgs, unknown):boolean

A recognizer that detects events with the given arguments.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

inverse

(recognizer: function(EventArgs, unknown):boolean) : function(EventArgs, unknown):boolean

Creates an event recognizer instance that yields the boolean inverse of the given event recognizer.

Parameters

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

recognizer - function(EventArgs, unknown):boolean

The recognizer to invert.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

Returns

↪function(EventArgs, unknown):boolean

An implementation that performs the logical negation for the argument.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

Examples

Recognizes left mouse down events without the Shift key pressed.

const moveInputMode = graphEditorInputMode.moveSelectedItemsInputMode
moveInputMode.hoverRecognizer = (evt, sender) =>
  evt instanceof PointerEventArgs &&
  evt.pointerType === PointerType.MOUSE &&
  evt.eventType === PointerEventType.DOWN &&
  (evt.changedButtons & PointerButtons.MOUSE_LEFT) !== 0 &&
  !EventRecognizers.SHIFT_IS_DOWN(evt, sender)