Skip to content

FederatedEvent

Defined in: src/full-types.d.ts:28

Source

obsidian-typings/src/pixi-js/augmentations/FederatedEvent.d.ts

Extends

Type Parameters

N extends UIEvent | PixiTouch = UIEvent | PixiTouch

Properties

AT_TARGET

readonly AT_TARGET: 2

Defined in: lib.dom.d.ts:8602

Inherited from

UIEvent.AT_TARGET


bubbles

readonly bubbles: boolean

Defined in: lib.dom.d.ts:8497

Returns true or false depending on how event was initialized. True if event goes through its target’s ancestors in reverse tree order, and false otherwise.

MDN Reference

Inherited from

UIEvent.bubbles


BUBBLING_PHASE

readonly BUBBLING_PHASE: 3

Defined in: lib.dom.d.ts:8603

Inherited from

UIEvent.BUBBLING_PHASE


cancelable

readonly cancelable: boolean

Defined in: lib.dom.d.ts:8509

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

MDN Reference

Inherited from

UIEvent.cancelable


cancelBubble

cancelBubble: boolean

Defined in: lib.dom.d.ts:8503

Inherited from

UIEvent.cancelBubble


CAPTURING_PHASE

readonly CAPTURING_PHASE: 1

Defined in: lib.dom.d.ts:8601

Inherited from

UIEvent.CAPTURING_PHASE


composed

readonly composed: boolean

Defined in: lib.dom.d.ts:8515

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

MDN Reference

Inherited from

UIEvent.composed


currentTarget

readonly currentTarget: null | EventTarget

Defined in: lib.dom.d.ts:8521

Returns the object whose event listener’s callback is currently being invoked.

MDN Reference

Inherited from

UIEvent.currentTarget


defaultPrevented

readonly defaultPrevented: boolean

Defined in: lib.dom.d.ts:8527

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

MDN Reference

Inherited from

UIEvent.defaultPrevented


detail

readonly detail: number

Defined in: lib.dom.d.ts:23192

MDN Reference

Inherited from

UIEvent.detail


doc

doc: Document

Defined in: obsidian.d.ts:230

Inherited from

UIEvent.doc


eventPhase

readonly eventPhase: number

Defined in: lib.dom.d.ts:8533

Returns the event’s phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

MDN Reference

Inherited from

UIEvent.eventPhase


isTrusted

readonly isTrusted: boolean

Defined in: lib.dom.d.ts:8539

Returns true if event was dispatched by the user agent, and false otherwise.

MDN Reference

Inherited from

UIEvent.isTrusted


NONE

readonly NONE: 0

Defined in: lib.dom.d.ts:8600

Inherited from

UIEvent.NONE


returnValue

returnValue: boolean

Defined in: lib.dom.d.ts:8545

Inherited from

UIEvent.returnValue


srcElement

readonly srcElement: null | EventTarget

Defined in: lib.dom.d.ts:8551

Inherited from

UIEvent.srcElement


target

readonly target: null | EventTarget

Defined in: lib.dom.d.ts:8557

Returns the object to which event is dispatched (its target).

MDN Reference

Inherited from

UIEvent.target


targetNode

targetNode: null | Node

Defined in: obsidian.d.ts:228

Inherited from

UIEvent.targetNode


timeStamp

readonly timeStamp: number

Defined in: lib.dom.d.ts:8563

Returns the event’s timestamp as the number of milliseconds measured relative to the time origin.

MDN Reference

Inherited from

UIEvent.timeStamp


type

readonly type: string

Defined in: lib.dom.d.ts:8569

Returns the type of event, e.g. “click”, “hashchange”, or “submit”.

MDN Reference

Inherited from

UIEvent.type


view

readonly view: null | Window

Defined in: lib.dom.d.ts:23194

MDN Reference

Inherited from

UIEvent.view


which

readonly which: number

Defined in: lib.dom.d.ts:23200

Inherited from

UIEvent.which


win

win: Window

Defined in: obsidian.d.ts:229

Inherited from

UIEvent.win

Methods

composedPath()

composedPath(): EventTarget[]

Defined in: lib.dom.d.ts:8575

Returns the invocation target objects of event’s path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root’s mode is “closed” that are not reachable from event’s currentTarget.

MDN Reference

Returns

EventTarget[]

Inherited from

UIEvent.composedPath


initEvent()

initEvent(type, bubbles?, cancelable?): void

Defined in: lib.dom.d.ts:8581

Parameters

type

string

bubbles?

boolean

cancelable?

boolean

Returns

void

Inherited from

UIEvent.initEvent


initUIEvent()

initUIEvent(typeArg, bubblesArg?, cancelableArg?, viewArg?, detailArg?): void

Defined in: lib.dom.d.ts:23206

Parameters

typeArg

string

bubblesArg?

boolean

cancelableArg?

boolean

viewArg?

null | Window

detailArg?

number

Returns

void

Inherited from

UIEvent.initUIEvent


instanceOf()

instanceOf<T>(type): this is T

Defined in: obsidian.d.ts:236

Cross-window capable instanceof check, a drop-in replacement for instanceof checks on UIEvents.

Type Parameters

T

Parameters

type

(…data) => T

Returns

this is T

Inherited from

UIEvent.instanceOf


preventDefault()

preventDefault(): void

Defined in: lib.dom.d.ts:8587

If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

MDN Reference

Returns

void

Inherited from

UIEvent.preventDefault


stopImmediatePropagation()

stopImmediatePropagation(): void

Defined in: lib.dom.d.ts:8593

Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

MDN Reference

Returns

void

Inherited from

UIEvent.stopImmediatePropagation


stopPropagation()

stopPropagation(): void

Defined in: lib.dom.d.ts:8599

When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

MDN Reference

Returns

void

Inherited from

UIEvent.stopPropagation