Class PointerWheel

A pointer wheel PointerEvent.

Has a focus type of Pointer and does not need focus.

Hierarchy

Constructors

constructor

Properties

alt ctrl deltaMode deltaX deltaY deltaZ focusType fromDrag needsFocus reversed shift target x y PageLinesError PagePercentError

Methods

cloneWithTarget correctOffset getDeltaPixels

Constructors

constructor

Properties

Readonly alt

alt: boolean

Is alt being pressed?

Readonly ctrl

ctrl: boolean

Is control being pressed?

Readonly deltaMode

deltaMode: PointerWheelMode

The mode of the delta values; how the delta values should be interpreted. See PointerWheelMode

Readonly deltaX

deltaX: number

Wheel event horizontal scroll amount. Not an integer. The value's interpretation depends on deltaMode.

Readonly deltaY

deltaY: number

Wheel event vertical scroll amount. Not an integer. The value's interpretation depends on deltaMode.

Readonly deltaZ

deltaZ: number

Wheel event depth scroll amount. Not an integer. The value's interpretation depends on deltaMode.

Readonly focusType

focusType: null | FocusType

The focus type of this event. Can be null.

If null, this event cannot be focused, since events are focused by their FocusType as a group.

Readonly fromDrag

fromDrag: boolean

Was this wheel event created from a pointer drag?

Readonly needsFocus

needsFocus: boolean

Can this event be dispatched without a target?

Readonly reversed

reversed: boolean

Is this event dispatched in reverse-order?

Readonly shift

shift: boolean

Is shift being pressed?

Readonly target

target: null | Widget

The target of this event. Can be null

Readonly x

x: number

Pointer event position's X coordinate in pixels. Not an integer.

Readonly y

y: number

Pointer event position's Y coordinate in pixels. Not an integer.

Static Readonly PageLinesError

PageLinesError: 3 = 3

The amount of lines to remove from a page scroll

Static Readonly PagePercentError

PagePercentError: 0.1 = 0.1

The percentage of a page to remove from a page scroll

Methods

cloneWithTarget

correctOffset

getDeltaPixels

  • Get the scroll delta in pixels, even if the deltaMode is not Pixel.

    Returns

    Returns a 3-tuple containing the x, y and z components, repectively, of the wheel event in pixels.

    Parameters

    • forceLimit: boolean

      Should the delta be limited by PageLinesError and PagePercentError, if deltaMode is not Page?

    • lineHeight: number

      The full height (line height with spacing) of a line, used for page deltaMode, or for limiting the delta

    • containerWidth: number

      The width of the container, used for page deltaMode, or for limiting the delta

    • containerHeight: number

      The height of the container, used for page deltaMode, or for limiting the delta

    • containerDepth: number = 0

      The depth of the container, used for page deltaMode, or for limiting the delta. Only used for custom containers/widgets with a Z-axis

    Returns [x: number, y: number, z: number]

Settings

Member Visibility

Theme

Generated using TypeDoc