Pixi’VNClass: FederatedWheelEvent
Defined in: node_modules/pixi.js/lib/events/FederatedWheelEvent.d.ts:49
A specialized event class for wheel/scroll interactions in PixiJS applications. Extends FederatedMouseEvent to provide wheel-specific properties while maintaining compatibility with the DOM WheelEvent interface.
Key features:
- Provides scroll delta information
- Supports different scroll modes (pixel, line, page)
- Inherits mouse event properties
- Normalizes cross-browser wheel events
Example
// Basic wheel event handling
sprite.on('wheel', (event: FederatedWheelEvent) => {
// Get scroll amount
console.log('Vertical scroll:', event.deltaY);
console.log('Horizontal scroll:', event.deltaX);
// Check scroll mode
if (event.deltaMode === FederatedWheelEvent.DOM_DELTA_LINE) {
console.log('Scrolling by lines');
} else if (event.deltaMode === FederatedWheelEvent.DOM_DELTA_PAGE) {
console.log('Scrolling by pages');
} else {
console.log('Scrolling by pixels');
}
// Get scroll position
console.log('Scroll at:', event.global.x, event.global.y);
});
// Common use case: Zoom control
container.on('wheel', (event: FederatedWheelEvent) => {
// Prevent page scrolling
event.preventDefault();
// Zoom in/out based on scroll direction
const zoomFactor = 1 + (event.deltaY / 1000);
container.scale.set(container.scale.x * zoomFactor);
});
See
- FederatedMouseEvent For base mouse event functionality
- https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent DOM WheelEvent Interface
- EventSystem For the event management system
Standard
Extends
Implements
WheelEvent
Constructors
Constructor
> new FederatedWheelEvent(manager): FederatedWheelEvent
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:181
Parameters
manager
The event boundary which manages this event. Propagation can only occur within the boundary's jurisdiction.
Returns
FederatedWheelEvent
Inherited from
FederatedMouseEvent.constructor
Properties
altKey
> altKey: boolean
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:48
Whether the "alt" key was pressed when this mouse event occurred.
Implementation of
WheelEvent.altKey
Inherited from
AT_TARGET
> readonly AT_TARGET: 2 = 2
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:291
The event propagation phase AT_TARGET that indicates that the event is at the target.
Default
2
Advanced
Implementation of
WheelEvent.AT_TARGET
Inherited from
bubbles
> bubbles: boolean
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:107
Flags whether this event bubbles. This will take effect only if it is set before propagation.
Implementation of
WheelEvent.bubbles
Inherited from
BUBBLING_PHASE
> readonly BUBBLING_PHASE: 3 = 3
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:297
The event propagation phase BUBBLING_PHASE that indicates that the event is in the bubbling phase.
Default
3
Advanced
Implementation of
WheelEvent.BUBBLING_PHASE
Inherited from
FederatedMouseEvent.BUBBLING_PHASE
button
> button: number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:50
The specific button that was pressed in this mouse event.
Implementation of
WheelEvent.button
Inherited from
buttons
> buttons: number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:52
The button depressed when this event occurred.
Implementation of
WheelEvent.buttons
Inherited from
cancelable
> readonly cancelable: false = false
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:114
Flags whether this event can be canceled using FederatedEvent.preventDefault. This is always false (for now).
Implementation of
WheelEvent.cancelable
Inherited from
FederatedMouseEvent.cancelable
~~cancelBubble~~
> cancelBubble: boolean
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:109
Deprecated
since 7.0.0
Implementation of
WheelEvent.cancelBubble
Inherited from
FederatedMouseEvent.cancelBubble
CAPTURING_PHASE
> readonly CAPTURING_PHASE: 1 = 1
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:285
The event propagation phase CAPTURING_PHASE that indicates that the event is in the capturing phase.
Default
1
Advanced
Implementation of
WheelEvent.CAPTURING_PHASE
Inherited from
FederatedMouseEvent.CAPTURING_PHASE
client
> client: Point
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:62
The coordinates of the mouse event relative to the canvas.
Inherited from
ctrlKey
> ctrlKey: boolean
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:54
Whether the "control" key was pressed when this mouse event occurred.
Implementation of
WheelEvent.ctrlKey
Inherited from
currentTarget
> currentTarget: Container
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:123
The listeners of the event target that are being notified.
Implementation of
WheelEvent.currentTarget
Inherited from
FederatedMouseEvent.currentTarget
defaultPrevented
> defaultPrevented: boolean
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:125
Flags whether the default response of the user agent was prevent through this event.
Implementation of
WheelEvent.defaultPrevented
Inherited from
FederatedMouseEvent.defaultPrevented
deltaMode
> deltaMode: number
Defined in: node_modules/pixi.js/lib/events/FederatedWheelEvent.d.ts:54
The units of deltaX, deltaY, and deltaZ. This is one of DOM_DELTA_LINE,
DOM_DELTA_PAGE, DOM_DELTA_PIXEL.
Implementation of
WheelEvent.deltaMode
deltaX
> deltaX: number
Defined in: node_modules/pixi.js/lib/events/FederatedWheelEvent.d.ts:56
Horizontal scroll amount
Implementation of
WheelEvent.deltaX
deltaY
> deltaY: number
Defined in: node_modules/pixi.js/lib/events/FederatedWheelEvent.d.ts:58
Vertical scroll amount
Implementation of
WheelEvent.deltaY
deltaZ
> deltaZ: number
Defined in: node_modules/pixi.js/lib/events/FederatedWheelEvent.d.ts:60
z-axis scroll amount.
Implementation of
WheelEvent.deltaZ
detail
> detail: number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:78
This is the number of clicks that occurs in 200ms/click of each other.
Implementation of
WheelEvent.detail
Inherited from
eventPhase
> eventPhase: number
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:130
The propagation phase.
Default
Implementation of
WheelEvent.eventPhase
Inherited from
FederatedMouseEvent.eventPhase
global
> global: Point
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:92
The pointer coordinates in world space.
Inherited from
isTrusted
> isTrusted: boolean
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:132
Flags whether this is a user-trusted event
Implementation of
WheelEvent.isTrusted
Inherited from
layer
> layer: Point
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:166
The coordinates of the event relative to the nearest DOM layer. This is a non-standard property.
Inherited from
manager
> readonly manager: EventBoundary
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:154
The EventBoundary that manages this event. Null for root events.
Inherited from
metaKey
> metaKey: boolean
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:56
Whether the "meta" key was pressed when this mouse event occurred.
Implementation of
WheelEvent.metaKey
Inherited from
movement
> movement: Point
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:80
The movement in this pointer relative to the last mousemove event.
Inherited from
nativeEvent
> nativeEvent: MouseEvent | PointerEvent | PixiTouch
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:144
The native event that caused the foremost original event.
Inherited from
FederatedMouseEvent.nativeEvent
NONE
> readonly NONE: 0 = 0
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:279
The event propagation phase NONE that indicates that the event is not in any phase.
Default
0
Advanced
Implementation of
WheelEvent.NONE
Inherited from
offset
> offset: Point
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:86
The offset of the pointer coordinates w.r.t. target Container in world space. This is not supported at the moment.
Inherited from
originalEvent
> originalEvent: FederatedEvent<MouseEvent | PointerEvent | PixiTouch>
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:146
The original event that caused this event, if any.
Inherited from
FederatedMouseEvent.originalEvent
page
> page: Point
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:172
The coordinates of the event relative to the DOM document. This is a non-standard property.
Inherited from
path
> path: Container<ContainerChild>[]
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:152
The composed path of the event's propagation. The target is at the end.
Inherited from
propagationImmediatelyStopped
> propagationImmediatelyStopped: boolean
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:150
Flags whether propagation was immediately stopped.
Inherited from
FederatedMouseEvent.propagationImmediatelyStopped
propagationStopped
> propagationStopped: boolean
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:148
Flags whether propagation was stopped.
Inherited from
FederatedMouseEvent.propagationStopped
relatedTarget
> relatedTarget: EventTarget
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:58
This is currently not implemented in the Federated Events API.
Implementation of
WheelEvent.relatedTarget
Inherited from
FederatedMouseEvent.relatedTarget
~~returnValue~~
> returnValue: boolean
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:134
Deprecated
since 7.0.0
Implementation of
WheelEvent.returnValue
Inherited from
FederatedMouseEvent.returnValue
screen
> screen: Point
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:101
The pointer coordinates in the renderer's screen. This has slightly different semantics than native PointerEvent screenX/screenY.
Inherited from
shiftKey
> shiftKey: boolean
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:60
Whether the "shift" key was pressed when this mouse event occurred.
Implementation of
WheelEvent.shiftKey
Inherited from
~~srcElement~~
> srcElement: EventTarget
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:136
Deprecated
since 7.0.0
Implementation of
WheelEvent.srcElement
Inherited from
FederatedMouseEvent.srcElement
target
> target: Container
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:138
The event target that this will be dispatched to.
Implementation of
WheelEvent.target
Inherited from
timeStamp
> timeStamp: number
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:140
The timestamp of when the event was created.
Implementation of
WheelEvent.timeStamp
Inherited from
type
> type: string
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:142
The type of event, e.g. "mouseup".
Implementation of
WheelEvent.type
Inherited from
view
> view: Window
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:158
The global Window object.
Implementation of
WheelEvent.view
Inherited from
Accessors
clientX
Get Signature
> get clientX(): number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:64
Returns
number
Implementation of
WheelEvent.clientX
Inherited from
clientY
Get Signature
> get clientY(): number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:66
Returns
number
Implementation of
WheelEvent.clientY
Inherited from
data
Get Signature
> get data(): this
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:186
Fallback for the deprecated InteractionEvent.data.
Deprecated
since 7.0.0
Returns
this
Inherited from
globalX
Get Signature
> get globalX(): number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:94
Returns
number
Inherited from
globalY
Get Signature
> get globalY(): number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:96
Returns
number
Inherited from
layerX
Get Signature
> get layerX(): number
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:168
Returns
number
Implementation of
WheelEvent.layerX
Inherited from
layerY
Get Signature
> get layerY(): number
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:170
Returns
number
Implementation of
WheelEvent.layerY
Inherited from
movementX
Get Signature
> get movementX(): number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:82
Returns
number
Implementation of
WheelEvent.movementX
Inherited from
movementY
Get Signature
> get movementY(): number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:84
Returns
number
Implementation of
WheelEvent.movementY
Inherited from
offsetX
Get Signature
> get offsetX(): number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:88
Returns
number
Implementation of
WheelEvent.offsetX
Inherited from
offsetY
Get Signature
> get offsetY(): number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:90
Returns
number
Implementation of
WheelEvent.offsetY
Inherited from
pageX
Get Signature
> get pageX(): number
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:174
Returns
number
Implementation of
WheelEvent.pageX
Inherited from
pageY
Get Signature
> get pageY(): number
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:176
Returns
number
Implementation of
WheelEvent.pageY
Inherited from
screenX
Get Signature
> get screenX(): number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:106
The pointer coordinates in the renderer's screen. Alias for screen.x.
Returns
number
Implementation of
WheelEvent.screenX
Inherited from
screenY
Get Signature
> get screenY(): number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:111
The pointer coordinates in the renderer's screen. Alias for screen.y.
Returns
number
Implementation of
WheelEvent.screenY
Inherited from
x
Get Signature
> get x(): number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:71
Alias for this.clientX.
Returns
number
Implementation of
WheelEvent.x
Inherited from
y
Get Signature
> get y(): number
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:76
Alias for this.clientY.
Returns
number
Implementation of
WheelEvent.y
Inherited from
Methods
composedPath()
> composedPath(): Container<ContainerChild>[]
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:191
The propagation path for this event. Alias for EventBoundary.propagationPath.
Returns
Advanced
Implementation of
WheelEvent.composedPath
Inherited from
FederatedMouseEvent.composedPath
getLocalPosition()
> getLocalPosition<P>(container, point?, globalPos?): P
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:140
Converts global coordinates into container-local coordinates.
This method transforms coordinates from world space to a container's local space, useful for precise positioning and hit testing.
Type Parameters
P
Parameters
container
The Container to get local coordinates for
point?
P
Optional Point object to store the result. If not provided, a new Point will be created
globalPos?
Optional custom global coordinates. If not provided, the event's global position is used
Returns
P
The local coordinates as a Point object
Example
// Basic usage - get local coordinates relative to a container
sprite.on('pointermove', (event: FederatedMouseEvent) => {
// Get position relative to the sprite
const localPos = event.getLocalPosition(sprite);
console.log('Local position:', localPos.x, localPos.y);
});
// Using custom global coordinates
const customGlobal = new Point(100, 100);
sprite.on('pointermove', (event: FederatedMouseEvent) => {
// Transform custom coordinates
const localPos = event.getLocalPosition(sprite, undefined, customGlobal);
console.log('Custom local position:', localPos.x, localPos.y);
});
See
- Container.worldTransform For the transformation matrix
- Point For the point class used to store coordinates
Inherited from
FederatedMouseEvent.getLocalPosition
getModifierState()
> getModifierState(key): boolean
Defined in: node_modules/pixi.js/lib/events/FederatedMouseEvent.d.ts:145
Whether the modifier key was pressed when this event natively occurred.
Parameters
key
string
The modifier key.
Returns
boolean
Implementation of
WheelEvent.getModifierState
Inherited from
FederatedMouseEvent.getModifierState
preventDefault()
> preventDefault(): void
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:229
Prevent default behavior of both PixiJS and the user agent.
Returns
void
Example
sprite.on('click', (event) => {
// Prevent both browser's default click behavior
// and PixiJS's default handling
event.preventDefault();
// Custom handling
customClickHandler();
});
Remarks
- Only works if the native event is cancelable
- Does not stop event propagation
Implementation of
WheelEvent.preventDefault
Inherited from
FederatedMouseEvent.preventDefault
stopImmediatePropagation()
> stopImmediatePropagation(): void
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:249
Stop this event from propagating to any additional listeners, including those on the current target and any following targets in the propagation path.
Returns
void
Example
container.on('pointerdown', (event) => {
// Stop all further event handling
event.stopImmediatePropagation();
// These handlers won't be called:
// - Other pointerdown listeners on this container
// - Any pointerdown listeners on parent containers
});
Remarks
- Immediately stops all event propagation
- Prevents other listeners on same target from being called
- More aggressive than stopPropagation()
Implementation of
WheelEvent.stopImmediatePropagation
Inherited from
FederatedMouseEvent.stopImmediatePropagation
stopPropagation()
> stopPropagation(): void
Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:273
Stop this event from propagating to the next target in the propagation path. The rest of the listeners on the current target will still be notified.
Returns
void
Example
child.on('pointermove', (event) => {
// Handle event on child
updateChild();
// Prevent parent handlers from being called
event.stopPropagation();
});
// This won't be called if child handles the event
parent.on('pointermove', (event) => {
updateParent();
});
Remarks
- Stops event bubbling to parent containers
- Does not prevent other listeners on same target
- Less aggressive than stopImmediatePropagation()
Implementation of
WheelEvent.stopPropagation