Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WheelEvent

Wheel Events

Represents a mouse wheel event. See Pointers for more information on handling point input.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new WheelEvent(x: number, y: number, pageX: number, pageY: number, screenX: number, screenY: number, index: number, deltaX: number, deltaY: number, deltaZ: number, deltaMode: WheelDeltaMode, ev: any): WheelEvent

  • Parameters

    • x: number

      The x coordinate of the event (in world coordinates)

    • y: number

      The y coordinate of the event (in world coordinates)

    • pageX: number

      The x coordinate of the event (in document coordinates)

    • pageY: number

      The y coordinate of the event (in document coordinates)

    • screenX: number

      The x coordinate of the event (in screen coordinates)

    • screenY: number

      The y coordinate of the event (in screen coordinates)

    • index: number

      The index of the pointer (zero-based)

    • deltaX: number

      The type of pointer

    • deltaY: number

      The type of pointer

    • deltaZ: number

      The type of pointer

    • deltaMode: WheelDeltaMode

      The type of movement WheelDeltaMode

    • ev: any

      The raw DOM event being handled

    Returns WheelEvent

Properties

deltaMode

deltaMode: WheelDeltaMode

The type of movement WheelDeltaMode

deltaX

deltaX: number

The type of pointer

deltaY

deltaY: number

The type of pointer

deltaZ

deltaZ: number

The type of pointer

ev

ev: any

The raw DOM event being handled

index

index: number

The index of the pointer (zero-based)

other

other: T | null

Other target object for this event

pageX

pageX: number

The x coordinate of the event (in document coordinates)

pageY

pageY: number

The y coordinate of the event (in document coordinates)

screenX

screenX: number

The x coordinate of the event (in screen coordinates)

screenY

screenY: number

The y coordinate of the event (in screen coordinates)

target

target: Actor

Target object for this event.

x

x: number

The x coordinate of the event (in world coordinates)

y

y: number

The y coordinate of the event (in world coordinates)

Accessors

bubbles

  • get bubbles(): boolean
  • set bubbles(value: boolean): void

  • If set to false, prevents event from propagating to other actors. If true it will be propagated to all actors that apply.

    Returns boolean

  • If set to false, prevents event from propagating to other actors. If true it will be propagated to all actors that apply.

    Parameters

    • value: boolean

    Returns void

Methods

stopPropagation

  • stopPropagation(): void