Options
All
  • Public
  • Public/Protected
  • All
Menu

Provides event properties that are specific to modifications to the Document Object Model (DOM) hierarchy and nodes.

deprecated

DOM4 [DOM] provides a new mechanism using a MutationObserver interface which addresses the use cases that mutation events solve, but in a more performant manner. Thus, this specification describes mutation events for reference and completeness of legacy behavior, but deprecates the use of the MutationEvent interface.

Hierarchy

  • Event
    • MutationEvent

Index

Properties

ADDITION: number
AT_TARGET: number
BUBBLING_PHASE: number
CAPTURING_PHASE: number
MODIFICATION: number
NONE: number
REMOVAL: number
attrChange: number
deprecated
attrName: string
deprecated
bubbles: boolean

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.

cancelBubble: boolean
deprecated
cancelable: boolean

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.

composed: boolean

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.

currentTarget: null | EventTarget

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

defaultPrevented: boolean

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

eventPhase: number

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

isTrusted: boolean

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

newValue: string
deprecated
prevValue: string
deprecated
relatedNode: null | internal.Node
deprecated
returnValue: boolean
deprecated
srcElement: null | EventTarget
deprecated
target: null | EventTarget

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

timeStamp: number

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

type: string

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

Methods

  • composedPath(): EventTarget[]
  • 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.

    Returns EventTarget[]

  • initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void
  • deprecated

    Parameters

    • type: string
    • Optional bubbles: boolean
    • Optional cancelable: boolean

    Returns void

  • initMutationEvent(typeArg: string, bubblesArg?: boolean, cancelableArg?: boolean, relatedNodeArg?: null | internal.Node, prevValueArg?: string, newValueArg?: string, attrNameArg?: string, attrChangeArg?: number): void
  • deprecated

    Parameters

    • typeArg: string
    • Optional bubblesArg: boolean
    • Optional cancelableArg: boolean
    • Optional relatedNodeArg: null | internal.Node
    • Optional prevValueArg: string
    • Optional newValueArg: string
    • Optional attrNameArg: string
    • Optional attrChangeArg: number

    Returns void

  • preventDefault(): void
  • 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.

    Returns void

  • stopImmediatePropagation(): void
  • 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.

    Returns void

  • stopPropagation(): void
  • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

    Returns void

Generated using TypeDoc