PIXI.FederatedMouseEvent

class FederatedMouseEvent extends PIXI.FederatedEvent implements MouseEvent

A PIXI.FederatedEvent for mouse events.

Constructor

new PIXI.FederatedMouseEvent() → {}

Summary

Properties 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

Methods from FederatedMouseEvent

boolean

getModifierState(key: string)

void

initMouseEvent(_typeArg: string, _canBubbleArg: boolean, _cancelableArg: boolean, _viewArg: Window, _detailArg: number, _screenXArg: number, _screenYArg: number, _clientXArg: number, _clientYArg: number, _ctrlKeyArg: boolean, _altKeyArg: boolean, _shiftKeyArg: boolean, _metaKeyArg: boolean, _buttonArg: number, _relatedTargetArg: EventTarget)

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

altKey FederatedMouseEvent.ts:12

altKey: boolean

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

button FederatedMouseEvent.ts:15

button: number

The specific button that was pressed in this mouse event.

buttons FederatedMouseEvent.ts:18

buttons: number

The button depressed when this event occurred.

client FederatedMouseEvent.ts:33

client: PIXI.Point

The coordinates of the mouse event relative to the canvas.

clientX FederatedMouseEvent.ts:36

clientX: number

clientY FederatedMouseEvent.ts:39

clientY: number

ctrlKey FederatedMouseEvent.ts:21

ctrlKey: boolean

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

detail FederatedMouseEvent.ts:54

detail: number

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

global FederatedMouseEvent.ts:78

global: PIXI.Point

The pointer coordinates in world space.

globalX FederatedMouseEvent.ts:81

globalX: number

globalY FederatedMouseEvent.ts:84

globalY: number

metaKey FederatedMouseEvent.ts:24

metaKey: boolean

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

movement FederatedMouseEvent.ts:57

movement: PIXI.Point

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

movementX FederatedMouseEvent.ts:60

movementX: number

movementY FederatedMouseEvent.ts:63

movementY: number

offset FederatedMouseEvent.ts:66

offset: PIXI.Point

The offset of the pointer coordinates w.r.t. target DisplayObject in world space. This is not supported at the moment.

offsetX FederatedMouseEvent.ts:72

offsetX: number

offsetY FederatedMouseEvent.ts:75

offsetY: number

relatedTarget FederatedMouseEvent.ts:27

relatedTarget: EventTarget

This is currently not implemented in the Federated Events API.

screen FederatedMouseEvent.ts:87

screen: PIXI.Point

The pointer coordinates in the renderer's screen. This has slightly different semantics than native PointerEvent screenX/screenY.

screenX FederatedMouseEvent.ts:93

screenX: number

The pointer coordinates in the renderer's screen. Alias for screen.x.

screenY FederatedMouseEvent.ts:99

screenY: number

The pointer coordinates in the renderer's screen. Alias for screen.y.

shiftKey FederatedMouseEvent.ts:30

shiftKey: boolean

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

x FederatedMouseEvent.ts:42

x: number

Alias for this.clientX.

y FederatedMouseEvent.ts:48

y: number

Alias for this.clientY.

Public Methods

getModifierState FederatedMouseEvent.ts:105

getModifierState(key: string) → {boolean}

Whether the modifier key was pressed when this event natively occurred.

Parameters:
Name	Type	Description
key	string	The modifier key.

Returns:
Type	Description
boolean

initMouseEvent (deprecated) FederatedMouseEvent.ts:114

initMouseEvent(_typeArg: string, _canBubbleArg: boolean, _cancelableArg: boolean, _viewArg: Window, _detailArg: number, _screenXArg: number, _screenYArg: number, _clientXArg: number, _clientYArg: number, _ctrlKeyArg: boolean, _altKeyArg: boolean, _shiftKeyArg: boolean, _metaKeyArg: boolean, _buttonArg: number, _relatedTargetArg: EventTarget) → {void}

Not supported.

Parameters:
Name	Type	Description
_typeArg	string
_canBubbleArg	boolean
_cancelableArg	boolean
_viewArg	Window
_detailArg	number
_screenXArg	number
_screenYArg	number
_clientXArg	number
_clientYArg	number
_ctrlKeyArg	boolean
_altKeyArg	boolean
_shiftKeyArg	boolean
_metaKeyArg	boolean
_buttonArg	number
_relatedTargetArg	EventTarget

Returns:
Type	Description
void