MouseWheelBehaviors

Specifies constants that define the effect of turning the mouse wheel in a CanvasComponent.

Remarks

If ZOOM and SCROLL are both set, scrolling will be the default behavior. The control will zoom with the Control key is pressed. ZOOM and SCROLL can be combined with ONLY_WHEN_FOCUSED to activate this behavior only when the control has focus.

Type Details

yFiles module: view

Constants

NONE

: number

The mouse wheel has no effect.

ONLY_WHEN_FOCUSED

: number

Can be combined with ZOOM or SCROLL to perform the action only when the control has focus.

SCROLL

: number

The mouse wheel scrolls the view.

Remarks

Scrolling defaults to scrolling vertically. Pressing Shift while scrolling will scroll horizontally instead. No modifier key is required if bidirectional wheel events are available (e.g. touchpad or two-axis mouse wheel).

This constant can be combined with ZOOM to allow both at the same time with different modifiers. In that case scrolling will be the default behavior. The control will zoom if the Control key is pressed. On touchpads, this combination enables bidirectional panning with two fingers and pinch zooming.

ZOOM

: number

Turning the mouse wheel or pinching on a touchpad changes the zoom factor.

Remarks

This constant can be combined with SCROLL to allow both at the same time with different modifiers. In that case scrolling will be the default behavior. The control will zoom if the Control key is pressed. On touchpads, this combination enables bidirectional panning with two fingers and pinch zooming.

Static Methods

from

(value: MouseWheelBehaviors) : MouseWheelBehaviors

Converts the given argument to an enum constant of this enum type.

Remarks

Most notably, this method can convert an enum constant's name into the enum constant itself.

Parameters

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

value - MouseWheelBehaviors: The value to convert to an enum constant.

Returns

↪MouseWheelBehaviors: The enum constant that corresponds to the given argument.

getName

(value: MouseWheelBehaviors) : string

Returns the name of the given enum constant.

Parameters

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

value - MouseWheelBehaviors: The numeric value of an enum constant.

Returns

↪string: The name of the enum constant.

Throws

Exception({ name: 'Error' }): If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.