MouseEventRecognizers

Show usages

Provides commonly used predefined event recognizers that deal with MouseEventArgs.

Inheritance Hierarchy

MouseEventRecognizers

Remarks

EventRecognizers are convertible, see EventRecognizers.

Type Details

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

Constants

CLICK

: function(any, EventArgs):boolean

An event recognizer that identifies button clicks.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

DOWN

: function(any, EventArgs):boolean

An event recognizer that identifies mousedown events.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

DRAG

: function(any, EventArgs):boolean

An event recognizer that identifies mouse drag events.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

ENTER

: function(any, EventArgs):boolean

An event recognizer that identifies when the mouse has entered the control.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

IS_DOWN

: function(any, EventArgs):boolean

An event recognizer that identifies if any mouse button is currently down.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

LEAVE

: function(any, EventArgs):boolean

An event recognizer that identifies when the has left the control.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

LEFT_CLICK

: function(any, EventArgs):boolean

An event recognizer that identifies left mouse button clicks.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

LEFT_DOUBLE_CLICK

: function(any, EventArgs):boolean

An event recognizer that identifies left mouse button double clicks.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

LEFT_DOWN

: function(any, EventArgs):boolean

An event recognizer that identifies mousedown events of left mouse button.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

LEFT_DRAG

: function(any, EventArgs):boolean

An event recognizer that identifies left mouse button drags.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

LEFT_IS_DOWN

: function(any, EventArgs):boolean

An event recognizer that identifies if the left mouse button is currently down.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

LEFT_UP

: function(any, EventArgs):boolean

An event recognizer that identifies mouseup events of left mouse button.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

LOST_CAPTURE

: function(any, EventArgs):boolean

An event recognizer that identifies mouse input capture lost events.

Remarks

This event will occur often, especially after all mouse buttons have been released. More relevant for IInputModes is the LOST_CAPTURE_DURING_DRAG event recognizer.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

LOST_CAPTURE_DURING_DRAG

: function(any, EventArgs):boolean

An event recognizer that identifies mouse input capture lost events while at least one mouse button was pressed.

Remarks

Since the mouse capture has been lost, the necessary UP events will never be triggered. This recognizer is useful for identifying this situation.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

MIDDLE_CLICK

: function(any, EventArgs):boolean

An event recognizer that identifies middle mouse button clicks.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

MIDDLE_DOUBLE_CLICK

: function(any, EventArgs):boolean

An event recognizer that identifies middle mouse button double clicks.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

MIDDLE_DRAG

: function(any, EventArgs):boolean

An event recognizer that identifies middle mouse button drags.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

MIDDLE_IS_DOWN

: function(any, EventArgs):boolean

An event recognizer that identifies if the middle mouse button is currently down.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

MOVE

: function(any, EventArgs):boolean

An event recognizer that identifies mouse movements that are not drags.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

MOVE_OR_DRAG

: function(any, EventArgs):boolean

An event recognizer that identifies mouse movements.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

MULTI_CLICK

: function(any, EventArgs):boolean

An event recognizer that identifies button multi-clicks.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

RIGHT_CLICK

: function(any, EventArgs):boolean

An event recognizer that identifies right mouse button clicks.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

RIGHT_DOUBLE_CLICK

: function(any, EventArgs):boolean

An event recognizer that identifies right mouse button double clicks.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

RIGHT_DOWN

: function(any, EventArgs):boolean

An event recognizer that identifies mousedown events of right mouse button.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

RIGHT_DRAG

: function(any, EventArgs):boolean

An event recognizer that identifies right mouse button drags.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

RIGHT_IS_DOWN

: function(any, EventArgs):boolean

An event recognizer that identifies if the right mouse button is currently down.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

RIGHT_UP

: function(any, EventArgs):boolean

An event recognizer that identifies mouseup events of right mouse button.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

UP

: function(any, EventArgs):boolean

An event recognizer that identifies mouseup events.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

MouseEventRecognizers

Remarks

Type Details

See Also

Constants

CLICK

Signature Details

Parameters

Returns

DOWN

Signature Details

Parameters

Returns

DRAG

Signature Details

Parameters

Returns

ENTER

Signature Details

Parameters

Returns

IS_DOWN

Signature Details

Parameters

Returns

LEAVE

Signature Details

Parameters

Returns

LEFT_CLICK

Signature Details

Parameters

Returns

LEFT_DOUBLE_CLICK

Signature Details

Parameters

Returns

LEFT_DOWN

Signature Details

Parameters

Returns

LEFT_DRAG

Signature Details

Parameters

Returns

LEFT_IS_DOWN

Signature Details

Parameters

Returns

LEFT_UP

Signature Details

Parameters

Returns

LOST_CAPTURE

Remarks

Signature Details

Parameters

Returns

LOST_CAPTURE_DURING_DRAG

Remarks

Signature Details

Parameters

Returns

MIDDLE_CLICK

Signature Details

Parameters

Returns

MIDDLE_DOUBLE_CLICK

Signature Details

Parameters

Returns

MIDDLE_DRAG

Signature Details

Parameters

Returns

MIDDLE_IS_DOWN

Signature Details

Parameters

Returns

MOVE