PIXI.FederatedWheelEvent

class FederatedWheelEvent extends PIXI.FederatedMouseEvent implements WheelEvent

A PIXI.FederatedEvent for wheel events.

Constructor


new PIXI.FederatedWheelEvent() → {}

Summary


Properties from FederatedWheelEvent

number
deltaMode
number
deltaX

Horizontal scroll amount

number
deltaY

Vertical scroll amount

number
deltaZ

z-axis scroll amount.

number
DOM_DELTA_LINE = 0

Units specified in lines.

number
DOM_DELTA_PAGE = 1

Units specified in pages.

number
DOM_DELTA_PIXEL = 2

Units specified in pixels.

Properties inherited from FederatedMouseEvent

boolean
altKey

Whether the "alt" key was pressed when this mouse event occurred.

number
button

The specific button that was pressed in this mouse event.

number
buttons

The button depressed when this event occurred.

PIXI.Point
client

The coordinates of the mouse event relative to the canvas.

number
clientX
number
clientY
boolean
ctrlKey

Whether the "control" key was pressed when this mouse event occurred.

number
detail

This is the number of clicks that occurs in 200ms/click of each other.

PIXI.Point
global

The pointer coordinates in world space.

number
globalX
number
globalY
boolean
metaKey

Whether the "meta" key was pressed when this mouse event occurred.

PIXI.Point
movement

The movement in this pointer relative to the last mousemove event.

number
movementX
number
movementY
PIXI.Point
offset
number
offsetX
number
offsetY
EventTarget
relatedTarget

This is currently not implemented in the Federated Events API.

PIXI.Point
screen
number
screenX
number
screenY
boolean
shiftKey

Whether the "shift" key was pressed when this mouse event occurred.

number
x
number
y

Properties inherited from FederatedEvent

boolean
bubbles = true

Flags whether this event bubbles. This will take effect only if it is set before propagation.

boolean
cancelable = false
boolean
cancelBubble = true
boolean
composed = false
PIXI.FederatedEventTarget
currentTarget

The listeners of the event target that are being notified.

this
data
boolean
defaultPrevented = false

Flags whether the default response of the user agent was prevent through this event.

eventPhase = FederatedEvent.NONE
boolean
isTrusted

Flags whether this is a user-trusted event

PIXI.Point
layer

The coordinates of the evnet relative to the nearest DOM layer. This is a non-standard property.

number
layerX
number
layerY
PIXI.EventBoundary
manager

The EventBoundary that manages this event. Null for root events.

N
nativeEvent

The native event that caused the foremost original event.

PIXI.FederatedEvent<N>
originalEvent

The original event that caused this event, if any.

PIXI.Point
page

The coordinates of the event relative to the DOM document. This is a non-standard property.

number
pageX
number
pageY
PIXI.FederatedEventTarget[]
path

The composed path of the event's propagation. The target is at the end.

boolean
propagationImmediatelyStopped = false

Flags whether propagation was immediately stopped.

boolean
propagationStopped = false

Flags whether propagation was stopped.

boolean
returnValue
EventTarget
srcElement
PIXI.FederatedEventTarget
target

The event target that this will be dispatched to.

number
timeStamp

The timestamp of when the event was created.

string
type

The type of event, e.g. "mouseup".

WindowProxy
view

The global Window object.

number
which

Methods inherited from FederatedEvent

PIXI.FederatedEventTarget[]
composedPath()

The propagation path for this event. Alias for EventBoundary.propagationPath.

void
initEvent(_type: string, _bubbles: boolean, _cancelable: boolean)
void
preventDefault()

Prevent default behavior of PixiJS and the user agent.

void
stopImmediatePropagation()
void
stopPropagation()

Public Properties


deltaMode FederatedWheelEvent.ts:9
deltaMode: number

The units of deltaX, deltaY, and deltaZ. This is one of DOM_DELTA_LINE, DOM_DELTA_PAGE, DOM_DELTA_PIXEL.

deltaX FederatedWheelEvent.ts:15
deltaX: number

Horizontal scroll amount

deltaY FederatedWheelEvent.ts:18
deltaY: number

Vertical scroll amount

deltaZ FederatedWheelEvent.ts:21
deltaZ: number

z-axis scroll amount.

DOM_DELTA_LINE FederatedWheelEvent.ts:24
DOM_DELTA_LINE: number = 0

Units specified in lines.

DOM_DELTA_PAGE FederatedWheelEvent.ts:27
DOM_DELTA_PAGE: number = 1

Units specified in pages.

DOM_DELTA_PIXEL FederatedWheelEvent.ts:30
DOM_DELTA_PIXEL: number = 2

Units specified in pixels.


Powered by webdoc!