trilium
    Preparing search index...

    ​ Deprecated. Use JQuery.Event.

    interface JQueryMouseEventObject {
        altKey: boolean;
        AT_TARGET: 2;
        bubbles: boolean;
        BUBBLING_PHASE: 3;
        button: number;
        cancelable: boolean;
        cancelBubble: boolean;
        CAPTURING_PHASE: 1;
        clientX: number;
        clientY: number;
        composed: boolean;
        ctrlKey: boolean;
        currentTarget: Element;
        data: any;
        defaultPrevented: boolean;
        delegateTarget: Element;
        eventPhase: number;
        isTrusted: boolean;
        metaKey: boolean;
        namespace: string;
        NONE: 0;
        offsetX: number;
        offsetY: number;
        originalEvent: Event;
        pageX: number;
        pageY: number;
        relatedTarget: Element;
        result: any;
        returnValue: boolean;
        screenX: number;
        screenY: number;
        shiftKey: boolean;
        srcElement: null | EventTarget;
        target: Element;
        timeStamp: number;
        type: string;
        which: number;
        composedPath(): EventTarget[];
        initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
        isDefaultPrevented(): boolean;
        isImmediatePropagationStopped(): boolean;
        isPropagationStopped(): boolean;
        preventDefault(): any;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    altKey: boolean
    AT_TARGET: 2
    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.

    MDN Reference

    BUBBLING_PHASE: 3
    button: number
    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.

    MDN Reference

    cancelBubble: boolean

    MDN Reference

    CAPTURING_PHASE: 1
    clientX: number
    clientY: number
    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.

    MDN Reference

    ctrlKey: boolean
    currentTarget: Element

    The current DOM element within the event bubbling phase.

    <a href="https://api.jquery.com/event.currentTarget/">https://api.jquery.com/event.currentTarget/</a>

    data: any

    An optional object of data passed to an event method when the current executing handler is bound.

    <a href="https://api.jquery.com/event.data/">https://api.jquery.com/event.data/</a>

    defaultPrevented: boolean

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

    MDN Reference

    delegateTarget: Element

    The element where the currently-called jQuery event handler was attached.

    <a href="https://api.jquery.com/event.delegateTarget/">https://api.jquery.com/event.delegateTarget/</a>

    eventPhase: number

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

    MDN Reference

    isTrusted: boolean

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

    MDN Reference

    metaKey: boolean

    Indicates whether the META key was pressed when the event fired.

    <a href="https://api.jquery.com/event.metaKey/">https://api.jquery.com/event.metaKey/</a>

    namespace: string

    The namespace specified when the event was triggered.

    <a href="https://api.jquery.com/event.namespace/">https://api.jquery.com/event.namespace/</a>

    NONE: 0
    offsetX: number
    offsetY: number
    originalEvent: Event

    The browser's original Event object.

    <a href="https://api.jquery.com/category/events/event-object/">https://api.jquery.com/category/events/event-object/</a>

    pageX: number

    The mouse position relative to the left edge of the document.

    <a href="https://api.jquery.com/event.pageX/">https://api.jquery.com/event.pageX/</a>

    pageY: number

    The mouse position relative to the top edge of the document.

    <a href="https://api.jquery.com/event.pageY/">https://api.jquery.com/event.pageY/</a>

    relatedTarget: Element

    The other DOM element involved in the event, if any.

    <a href="https://api.jquery.com/event.relatedTarget/">https://api.jquery.com/event.relatedTarget/</a>

    result: any

    The last value returned by an event handler that was triggered by this event, unless the value was undefined.

    <a href="https://api.jquery.com/event.result/">https://api.jquery.com/event.result/</a>

    returnValue: boolean

    MDN Reference

    screenX: number
    screenY: number
    shiftKey: boolean
    srcElement: null | EventTarget

    MDN Reference

    target: Element

    The DOM element that initiated the event.

    <a href="https://api.jquery.com/event.target/">https://api.jquery.com/event.target/</a>

    timeStamp: number

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

    MDN Reference

    type: string

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

    MDN Reference

    which: number

    For key or mouse events, this property indicates the specific key or button that was pressed.

    <a href="https://api.jquery.com/event.which/">https://api.jquery.com/event.which/</a>

    Methods

    • 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[]

    • Parameters

      • type: string
      • Optionalbubbles: boolean
      • Optionalcancelable: boolean

      Returns void

      MDN Reference

    • Returns whether event.preventDefault() was ever called on this event object.

      Returns boolean

      <a href="https://api.jquery.com/event.isDefaultPrevented/">https://api.jquery.com/event.isDefaultPrevented/</a>

    • Returns whether event.stopImmediatePropagation() was ever called on this event object.

      Returns boolean

      <a href="https://api.jquery.com/event.isImmediatePropagationStopped/">https://api.jquery.com/event.isImmediatePropagationStopped/</a>

    • Returns whether event.stopPropagation() was ever called on this event object.

      Returns boolean

      <a href="https://api.jquery.com/event.isPropagationStopped/">https://api.jquery.com/event.isPropagationStopped/</a>

    • If this method is called, the default action of the event will not be triggered.

      Returns any

      <a href="https://api.jquery.com/event.preventDefault/">https://api.jquery.com/event.preventDefault/</a>

    • Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.

      Returns void

      <a href="https://api.jquery.com/event.stopImmediatePropagation/">https://api.jquery.com/event.stopImmediatePropagation/</a>

    • Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

      Returns void

      <a href="https://api.jquery.com/event.stopPropagation/">https://api.jquery.com/event.stopPropagation/</a>