Tools/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2025-07-27 18:12:29 +08:00
Code Issues Packages Projects Releases Wiki Activity
Notes/docs/Script API/interfaces/Frontend_Script_API._internal_.Event.html
Elian Doran 84c2ebd7f3
docs(api): pin common classes
2025-04-13 18:48:04 +03:00

142 lines
124 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Event | trilium</title><meta name="description" content="Documentation for trilium"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">trilium</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/Frontend_Script_API.html">Frontend Script API</a></li><li><a href="../modules/Frontend_Script_API._internal_.html">&lt;internal&gt;</a></li><li><a href="" aria-current="page">Event</a></li></ul><h1>Interface Event</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>jQuery's event system normalizes the event object according to W3C standards. The event object is guaranteed to be passed to the event handler (no checks for window.event required). It normalizes the target, relatedTarget, which, metaKey and pageX/Y properties and provides both stopPropagation() and preventDefault() methods.</p>
<p>Those properties are all documented, and accompanied by examples, on the <code>&lt;a href=&quot;http://api.jquery.com/category/events/event-object/&quot;&gt;Event object&lt;/a&gt;</code> page.</p>
<p>The standard events in the Document Object Model are: <code>blur</code>, <code>focus</code>, <code>load</code>, <code>resize</code>, <code>scroll</code>, <code>unload</code>, <code>beforeunload</code>, <code>click</code>, <code>dblclick</code>, <code>mousedown</code>, <code>mouseup</code>, <code>mousemove</code>, <code>mouseover</code>, <code>mouseout</code>, <code>mouseenter</code>, <code>mouseleave</code>, <code>change</code>, <code>select</code>, <code>submit</code>, <code>keydown</code>, <code>keypress</code>, and <code>keyup</code>. Since the DOM event names have predefined meanings for some elements, using them for other purposes is not recommended. jQuery's event model can trigger an event by any name on an element, and it is propagated up the DOM tree to which that element belongs, if any.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
<li><code>&lt;a href=&quot;https://api.jquery.com/category/events/event-object/&quot;&gt;https://api.jquery.com/category/events/event-object/&lt;/a&gt;</code></li>
<li><code>&lt;a href=&quot;Frontend_Script_API._internal_.TriggeredEvent.html&quot; class=&quot;tsd-kind-interface&quot;&gt;TriggeredEvent&lt;/a&gt;</code></li>
</ul>
</div></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Event</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#altkey">altKey</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#bubbles">bubbles</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#button">button</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#buttons">buttons</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#cancelable">cancelable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#changedtouches">changedTouches</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">TouchList</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#char">char</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#charcode">charCode</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#clientx">clientX</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#clienty">clientY</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#ctrlkey">ctrlKey</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#detail">detail</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#eventphase">eventPhase</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#key">key</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#keycode">keyCode</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#metakey">metaKey</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#offsetx">offsetX</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#offsety">offsetY</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#pagex">pageX</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#pagey">pageY</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#pointerid">pointerId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#pointertype">pointerType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#screenx">screenX</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#screeny">screenY</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#shiftkey">shiftKey</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#targettouches">targetTouches</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">TouchList</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#timestamp">timeStamp</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#toelement">toElement</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#touches">touches</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">TouchList</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#view">view</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Window</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#which">which</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#isdefaultprevented-1">isDefaultPrevented</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#isimmediatepropagationstopped-1">isImmediatePropagationStopped</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#ispropagationstopped-1">isPropagationStopped</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#preventdefault-1">preventDefault</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#stopimmediatepropagation-1">stopImmediatePropagation</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#stoppropagation-1">stopPropagation</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="7117"><h4>Hierarchy (<a href="../hierarchy.html#Frontend Script API.<internal>.Event">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Event</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="Frontend_Script_API._internal_.TriggeredEvent.html" class="tsd-signature-type tsd-kind-interface">TriggeredEvent</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4748</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#altkey" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>alt<wbr/>Key</span></a>
<a href="#bubbles" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bubbles</span></a>
<a href="#button" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>button</span></a>
<a href="#buttons" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>buttons</span></a>
<a href="#cancelable" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cancelable</span></a>
<a href="#changedtouches" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>changed<wbr/>Touches</span></a>
<a href="#char" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>char</span></a>
<a href="#charcode" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>char<wbr/>Code</span></a>
<a href="#clientx" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clientX</span></a>
<a href="#clienty" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clientY</span></a>
<a href="#ctrlkey" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ctrl<wbr/>Key</span></a>
<a href="#detail" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>detail</span></a>
<a href="#eventphase" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event<wbr/>Phase</span></a>
<a href="#key" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a>
<a href="#keycode" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key<wbr/>Code</span></a>
<a href="#metakey" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>meta<wbr/>Key</span></a>
<a href="#offsetx" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>offsetX</span></a>
<a href="#offsety" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>offsetY</span></a>
<a href="#pagex" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pageX</span></a>
<a href="#pagey" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pageY</span></a>
<a href="#pointerid" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pointer<wbr/>Id</span></a>
<a href="#pointertype" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pointer<wbr/>Type</span></a>
<a href="#screenx" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>screenX</span></a>
<a href="#screeny" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>screenY</span></a>
<a href="#shiftkey" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shift<wbr/>Key</span></a>
<a href="#targettouches" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target<wbr/>Touches</span></a>
<a href="#timestamp" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>Stamp</span></a>
<a href="#toelement" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Element</span></a>
<a href="#touches" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>touches</span></a>
<a href="#type" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
<a href="#view" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>view</span></a>
<a href="#which" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>which</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#isdefaultprevented" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Default<wbr/>Prevented</span></a>
<a href="#isimmediatepropagationstopped" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Immediate<wbr/>Propagation<wbr/>Stopped</span></a>
<a href="#ispropagationstopped" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Propagation<wbr/>Stopped</span></a>
<a href="#preventdefault" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prevent<wbr/>Default</span></a>
<a href="#stopimmediatepropagation" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Immediate<wbr/>Propagation</span></a>
<a href="#stoppropagation" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Propagation</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="altkey"><span>alt<wbr/>Key</span><a href="#altkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">altKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4926</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="bubbles"><span>bubbles</span><a href="#bubbles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bubbles</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4754</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="button"><span>button</span><a href="#button" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">button</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4765</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="buttons"><span>buttons</span><a href="#buttons" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">buttons</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4766</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="cancelable"><span>cancelable</span><a href="#cancelable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cancelable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4755</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="changedtouches"><span>changed<wbr/>Touches</span><a href="#changedtouches" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">changedTouches</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">TouchList</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4865</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="char"><span class="deprecated">char</span><a href="#char" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">char</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4856</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="charcode"><span class="deprecated">char<wbr/>Code</span><a href="#charcode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">charCode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4858</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="clientx"><span>clientX</span><a href="#clientx" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clientX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4767</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="clienty"><span>clientY</span><a href="#clienty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clientY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4768</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="ctrlkey"><span>ctrl<wbr/>Key</span><a href="#ctrlkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ctrlKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4927</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="detail"><span>detail</span><a href="#detail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4760</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="eventphase"><span>event<wbr/>Phase</span><a href="#eventphase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">eventPhase</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4756</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="key"><span>key</span><a href="#key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4859</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="keycode"><span class="deprecated">key<wbr/>Code</span><a href="#keycode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">keyCode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-2">Deprecated<a href="#deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4861</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="metakey"><span>meta<wbr/>Key</span><a href="#metakey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">metaKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates whether the META key was pressed when the event fired.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-1">See<a href="#see-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>&lt;a href=&quot;https://api.jquery.com/event.metaKey/&quot;&gt;https://api.jquery.com/event.metaKey/&lt;/a&gt;</code></p>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since">Since<a href="#since" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.0.4</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--determine-whether-the-meta-key-was-pressed-when-the-event-fired">Example: ​ ````Determine whether the META key was pressed when the event fired.<a href="#example--determine-whether-the-meta-key-was-pressed-when-the-event-fired" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><span class="hl-10">&lt;!</span><span class="hl-11">doctype</span><span class="hl-1"> </span><span class="hl-12">html</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">html</span><span class="hl-1"> </span><span class="hl-12">lang</span><span class="hl-1">=</span><span class="hl-13">&quot;en&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">meta</span><span class="hl-1"> </span><span class="hl-12">charset</span><span class="hl-1">=</span><span class="hl-13">&quot;utf-8&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><span class="hl-1">event.metaKey demo</span><span class="hl-10">&lt;/</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">style</span><span class="hl-10">&gt;</span><br/><span class="hl-14">body</span><span class="hl-15"> {</span><br/><span class="hl-12">background-color</span><span class="hl-15">: </span><span class="hl-16">#eef</span><span class="hl-15">;</span><br/><span class="hl-15">}</span><br/><span class="hl-14">div</span><span class="hl-15"> {</span><br/><span class="hl-12">padding</span><span class="hl-15">: </span><span class="hl-9">20px</span><span class="hl-15">;</span><br/><span class="hl-15">}</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">style</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-15"> </span><span class="hl-12">src</span><span class="hl-15">=</span><span class="hl-13">&quot;https://code.jquery.com/jquery-3.3.1.js&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">button</span><span class="hl-1"> </span><span class="hl-12">value</span><span class="hl-1">=</span><span class="hl-13">&quot;Test&quot;</span><span class="hl-1"> </span><span class="hl-12">name</span><span class="hl-1">=</span><span class="hl-13">&quot;Test&quot;</span><span class="hl-1"> </span><span class="hl-12">id</span><span class="hl-1">=</span><span class="hl-13">&quot;checkMetaKey&quot;</span><span class="hl-10">&gt;</span><span class="hl-1">Click me!</span><span class="hl-10">&lt;/</span><span class="hl-11">button</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-1"> </span><span class="hl-12">id</span><span class="hl-1">=</span><span class="hl-13">&quot;display&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;#checkMetaKey&quot;</span><span class="hl-15"> ).</span><span class="hl-0">click</span><span class="hl-15">(</span><span class="hl-2">function</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> ) {</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;#display&quot;</span><span class="hl-15"> ).</span><span class="hl-0">text</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-5">metaKey</span><span class="hl-15"> );</span><br/><span class="hl-15">});</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">html</span><span class="hl-10">&gt;</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4964</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="offsetx"><span>offsetX</span><a href="#offsetx" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">offsetX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4769</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="offsety"><span>offsetY</span><a href="#offsety" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">offsetY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4770</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="pagex"><span>pageX</span><a href="#pagex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pageX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The mouse position relative to the left edge of the document.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-2">See<a href="#see-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>&lt;a href=&quot;https://api.jquery.com/event.pageX/&quot;&gt;https://api.jquery.com/event.pageX/&lt;/a&gt;</code></p>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-1">Since<a href="#since-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.0.4</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--show-the-mouse-position-relative-to-the-left-and-top-edges-of-the-document-within-this-iframe">Example: ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe).<a href="#example--show-the-mouse-position-relative-to-the-left-and-top-edges-of-the-document-within-this-iframe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><span class="hl-10">&lt;!</span><span class="hl-11">doctype</span><span class="hl-1"> </span><span class="hl-12">html</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">html</span><span class="hl-1"> </span><span class="hl-12">lang</span><span class="hl-1">=</span><span class="hl-13">&quot;en&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">meta</span><span class="hl-1"> </span><span class="hl-12">charset</span><span class="hl-1">=</span><span class="hl-13">&quot;utf-8&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><span class="hl-1">event.pageX demo</span><span class="hl-10">&lt;/</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">style</span><span class="hl-10">&gt;</span><br/><span class="hl-14">body</span><span class="hl-15"> {</span><br/><span class="hl-12">background-color</span><span class="hl-15">: </span><span class="hl-16">#eef</span><span class="hl-15">;</span><br/><span class="hl-15">}</span><br/><span class="hl-14">div</span><span class="hl-15"> {</span><br/><span class="hl-12">padding</span><span class="hl-15">: </span><span class="hl-9">20px</span><span class="hl-15">;</span><br/><span class="hl-15">}</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">style</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-15"> </span><span class="hl-12">src</span><span class="hl-15">=</span><span class="hl-13">&quot;https://code.jquery.com/jquery-3.3.1.js&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-1"> </span><span class="hl-12">id</span><span class="hl-1">=</span><span class="hl-13">&quot;log&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-5">document</span><span class="hl-15"> ).</span><span class="hl-0">on</span><span class="hl-15">( </span><span class="hl-3">&quot;mousemove&quot;</span><span class="hl-15">, </span><span class="hl-2">function</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> ) {</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;#log&quot;</span><span class="hl-15"> ).</span><span class="hl-0">text</span><span class="hl-15">( </span><span class="hl-3">&quot;pageX: &quot;</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-5">pageX</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-3">&quot;, pageY: &quot;</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-5">pageY</span><span class="hl-15"> );</span><br/><span class="hl-15">});</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">html</span><span class="hl-10">&gt;</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4806</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="pagey"><span>pageY</span><a href="#pagey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pageY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The mouse position relative to the top edge of the document.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-3">See<a href="#see-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>&lt;a href=&quot;https://api.jquery.com/event.pageY/&quot;&gt;https://api.jquery.com/event.pageY/&lt;/a&gt;</code></p>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-2">Since<a href="#since-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.0.4</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--show-the-mouse-position-relative-to-the-left-and-top-edges-of-the-document-within-this-iframe-1">Example: ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe).<a href="#example--show-the-mouse-position-relative-to-the-left-and-top-edges-of-the-document-within-this-iframe-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><span class="hl-10">&lt;!</span><span class="hl-11">doctype</span><span class="hl-1"> </span><span class="hl-12">html</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">html</span><span class="hl-1"> </span><span class="hl-12">lang</span><span class="hl-1">=</span><span class="hl-13">&quot;en&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">meta</span><span class="hl-1"> </span><span class="hl-12">charset</span><span class="hl-1">=</span><span class="hl-13">&quot;utf-8&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><span class="hl-1">event.pageY demo</span><span class="hl-10">&lt;/</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">style</span><span class="hl-10">&gt;</span><br/><span class="hl-14">body</span><span class="hl-15"> {</span><br/><span class="hl-12">background-color</span><span class="hl-15">: </span><span class="hl-16">#eef</span><span class="hl-15">;</span><br/><span class="hl-15">}</span><br/><span class="hl-14">div</span><span class="hl-15"> {</span><br/><span class="hl-12">padding</span><span class="hl-15">: </span><span class="hl-9">20px</span><span class="hl-15">;</span><br/><span class="hl-15">}</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">style</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-15"> </span><span class="hl-12">src</span><span class="hl-15">=</span><span class="hl-13">&quot;https://code.jquery.com/jquery-3.3.1.js&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-1"> </span><span class="hl-12">id</span><span class="hl-1">=</span><span class="hl-13">&quot;log&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-5">document</span><span class="hl-15"> ).</span><span class="hl-0">on</span><span class="hl-15">( </span><span class="hl-3">&quot;mousemove&quot;</span><span class="hl-15">, </span><span class="hl-2">function</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> ) {</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;#log&quot;</span><span class="hl-15"> ).</span><span class="hl-0">text</span><span class="hl-15">( </span><span class="hl-3">&quot;pageX: &quot;</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-5">pageX</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-3">&quot;, pageY: &quot;</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-5">pageY</span><span class="hl-15"> );</span><br/><span class="hl-15">});</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">html</span><span class="hl-10">&gt;</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4842</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="pointerid"><span>pointer<wbr/>Id</span><a href="#pointerid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pointerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4850</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="pointertype"><span>pointer<wbr/>Type</span><a href="#pointertype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pointerType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4851</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="screenx"><span>screenX</span><a href="#screenx" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">screenX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4843</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="screeny"><span>screenY</span><a href="#screeny" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">screenY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4844</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="shiftkey"><span>shift<wbr/>Key</span><a href="#shiftkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">shiftKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4965</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="targettouches"><span>target<wbr/>Touches</span><a href="#targettouches" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">targetTouches</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">TouchList</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4866</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="timestamp"><span>time<wbr/>Stamp</span><a href="#timestamp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">timeStamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The difference in milliseconds between the time the browser created the event and January 1, 1970.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-4">See<a href="#see-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>&lt;a href=&quot;https://api.jquery.com/event.timeStamp/&quot;&gt;https://api.jquery.com/event.timeStamp/&lt;/a&gt;</code></p>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-3">Since<a href="#since-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.2.6</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--display-the-time-since-the-click-handler-last-executed">Example: ​ ````Display the time since the click handler last executed.<a href="#example--display-the-time-since-the-click-handler-last-executed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><span class="hl-10">&lt;!</span><span class="hl-11">doctype</span><span class="hl-1"> </span><span class="hl-12">html</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">html</span><span class="hl-1"> </span><span class="hl-12">lang</span><span class="hl-1">=</span><span class="hl-13">&quot;en&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">meta</span><span class="hl-1"> </span><span class="hl-12">charset</span><span class="hl-1">=</span><span class="hl-13">&quot;utf-8&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><span class="hl-1">event.timeStamp demo</span><span class="hl-10">&lt;/</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">style</span><span class="hl-10">&gt;</span><br/><span class="hl-14">div</span><span class="hl-15"> {</span><br/><span class="hl-12">height</span><span class="hl-15">: </span><span class="hl-9">100px</span><span class="hl-15">;</span><br/><span class="hl-12">width</span><span class="hl-15">: </span><span class="hl-9">300px</span><span class="hl-15">;</span><br/><span class="hl-12">margin</span><span class="hl-15">: </span><span class="hl-9">10px</span><span class="hl-15">;</span><br/><span class="hl-12">background-color</span><span class="hl-15">: </span><span class="hl-16">#ffd</span><span class="hl-15">;</span><br/><span class="hl-12">overflow</span><span class="hl-15">: </span><span class="hl-16">auto</span><span class="hl-15">;</span><br/><span class="hl-15">}</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">style</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-15"> </span><span class="hl-12">src</span><span class="hl-15">=</span><span class="hl-13">&quot;https://code.jquery.com/jquery-3.3.1.js&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><span class="hl-1">Click.</span><span class="hl-10">&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-2">var</span><span class="hl-15"> </span><span class="hl-5">last</span><span class="hl-15">, </span><span class="hl-5">diff</span><span class="hl-15">;</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;div&quot;</span><span class="hl-15"> ).</span><span class="hl-0">click</span><span class="hl-15">(</span><span class="hl-2">function</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> ) {</span><br/><span class="hl-4">if</span><span class="hl-15"> ( </span><span class="hl-5">last</span><span class="hl-15"> ) {</span><br/><span class="hl-5">diff</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-5">timeStamp</span><span class="hl-15"> </span><span class="hl-1">-</span><span class="hl-15"> </span><span class="hl-5">last</span><span class="hl-15">;</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;div&quot;</span><span class="hl-15"> ).</span><span class="hl-0">append</span><span class="hl-15">( </span><span class="hl-3">&quot;time since last event: &quot;</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-5">diff</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-3">&quot;&lt;br&gt;&quot;</span><span class="hl-15"> );</span><br/><span class="hl-15">} </span><span class="hl-4">else</span><span class="hl-15"> {</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;div&quot;</span><span class="hl-15"> ).</span><span class="hl-0">append</span><span class="hl-15">( </span><span class="hl-3">&quot;Click again.&lt;br&gt;&quot;</span><span class="hl-15"> );</span><br/><span class="hl-15">}</span><br/><span class="hl-5">last</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-5">timeStamp</span><span class="hl-15">;</span><br/><span class="hl-15">});</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">html</span><span class="hl-10">&gt;</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:5012</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="toelement"><span class="deprecated">to<wbr/>Element</span><a href="#toelement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toElement</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Element</span></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-3">Deprecated<a href="#deprecated-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4846</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="touches"><span>touches</span><a href="#touches" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">touches</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">TouchList</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4867</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Describes the nature of the event.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-5">See<a href="#see-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>&lt;a href=&quot;https://api.jquery.com/event.type/&quot;&gt;https://api.jquery.com/event.type/&lt;/a&gt;</code></p>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-4">Since<a href="#since-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.0</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--on-all-anchor-clicks-alert-the-event-type">Example: ​ ````On all anchor clicks, alert the event type.<a href="#example--on-all-anchor-clicks-alert-the-event-type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-0">$</span><span class="hl-1">( </span><span class="hl-3">&quot;a&quot;</span><span class="hl-1"> ).</span><span class="hl-0">click</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">event</span><span class="hl-1"> ) {</span><br/><span class="hl-0">alert</span><span class="hl-1">( </span><span class="hl-5">event</span><span class="hl-1">.</span><span class="hl-5">type</span><span class="hl-1"> ); </span><span class="hl-6">// &quot;click&quot;</span><br/><span class="hl-1">});</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:5024</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="view"><span>view</span><a href="#view" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">view</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Window</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4761</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="which"><span>which</span><a href="#which" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">which</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>For key or mouse events, this property indicates the specific key or button that was pressed.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-6">See<a href="#see-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>&lt;a href=&quot;https://api.jquery.com/event.which/&quot;&gt;https://api.jquery.com/event.which/&lt;/a&gt;</code></p>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-5">Since<a href="#since-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.1.3</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--log-which-key-was-depressed-html-----eventwhich-demo----------whichkey-on-keydown-function-event----log-html-eventtype------eventwhich--------example--log-which-mouse-button-was-depressed">Example: ​ ````Log which key was depressed.
```html
&lt;!doctype html&gt;
&lt;html lang=&quot;en&quot;&gt;
&lt;head&gt;
&lt;meta charset=&quot;utf-8&quot;&gt;
&lt;title&gt;event.which demo&lt;/title&gt;
&lt;script src=&quot;https://code.jquery.com/jquery-3.3.1.js&quot;&gt;&lt;/script&gt;
&lt;/head&gt;
&lt;body&gt;
​
&lt;input id=&quot;whichkey&quot; value=&quot;type something&quot;&gt;
&lt;div id=&quot;log&quot;&gt;&lt;/div&gt;
​
&lt;script&gt;
$( &quot;#whichkey&quot; ).on( &quot;keydown&quot;, function( event ) {
$( &quot;#log&quot; ).html( event.type + &quot;: &quot; + event.which );
});
&lt;/script&gt;
​
&lt;/body&gt;
&lt;/html&gt;
```
@example ​ ````Log which mouse button was depressed.<a href="#example--log-which-key-was-depressed-html-----eventwhich-demo----------whichkey-on-keydown-function-event----log-html-eventtype------eventwhich--------example--log-which-mouse-button-was-depressed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><span class="hl-10">&lt;!</span><span class="hl-11">doctype</span><span class="hl-1"> </span><span class="hl-12">html</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">html</span><span class="hl-1"> </span><span class="hl-12">lang</span><span class="hl-1">=</span><span class="hl-13">&quot;en&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">meta</span><span class="hl-1"> </span><span class="hl-12">charset</span><span class="hl-1">=</span><span class="hl-13">&quot;utf-8&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><span class="hl-1">event.which demo</span><span class="hl-10">&lt;/</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-15"> </span><span class="hl-12">src</span><span class="hl-15">=</span><span class="hl-13">&quot;https://code.jquery.com/jquery-3.3.1.js&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">input</span><span class="hl-1"> </span><span class="hl-12">id</span><span class="hl-1">=</span><span class="hl-13">&quot;whichkey&quot;</span><span class="hl-1"> </span><span class="hl-12">value</span><span class="hl-1">=</span><span class="hl-13">&quot;click here&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-1"> </span><span class="hl-12">id</span><span class="hl-1">=</span><span class="hl-13">&quot;log&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;#whichkey&quot;</span><span class="hl-15"> ).</span><span class="hl-0">on</span><span class="hl-15">( </span><span class="hl-3">&quot;mousedown&quot;</span><span class="hl-15">, </span><span class="hl-2">function</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> ) {</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;#log&quot;</span><span class="hl-15"> ).</span><span class="hl-0">html</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-5">type</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-3">&quot;: &quot;</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-5">which</span><span class="hl-15"> );</span><br/><span class="hl-15">});</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">html</span><span class="hl-10">&gt;</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:4922</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="isdefaultprevented"><span>is<wbr/>Default<wbr/>Prevented</span><a href="#isdefaultprevented" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="isdefaultprevented-1"><span class="tsd-kind-call-signature">isDefaultPrevented</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isdefaultprevented-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether event.preventDefault() was ever called on this event object.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-7">See<a href="#see-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>&lt;a href=&quot;https://api.jquery.com/event.isDefaultPrevented/&quot;&gt;https://api.jquery.com/event.isDefaultPrevented/&lt;/a&gt;</code></p>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-6">Since<a href="#since-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.3</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--checks-whether-eventpreventdefault-was-called">Example: ​ ````Checks whether event.preventDefault() was called.<a href="#example--checks-whether-eventpreventdefault-was-called" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-0">$</span><span class="hl-1">( </span><span class="hl-3">&quot;a&quot;</span><span class="hl-1"> ).</span><span class="hl-0">click</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">event</span><span class="hl-1"> ) {</span><br/><span class="hl-0">alert</span><span class="hl-1">( </span><span class="hl-5">event</span><span class="hl-1">.</span><span class="hl-0">isDefaultPrevented</span><span class="hl-1">() ); </span><span class="hl-6">// false</span><br/><span class="hl-5">event</span><span class="hl-1">.</span><span class="hl-0">preventDefault</span><span class="hl-1">();</span><br/><span class="hl-0">alert</span><span class="hl-1">( </span><span class="hl-5">event</span><span class="hl-1">.</span><span class="hl-0">isDefaultPrevented</span><span class="hl-1">() ); </span><span class="hl-6">// true</span><br/><span class="hl-1">});</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:5038</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="isimmediatepropagationstopped"><span>is<wbr/>Immediate<wbr/>Propagation<wbr/>Stopped</span><a href="#isimmediatepropagationstopped" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="isimmediatepropagationstopped-1"><span class="tsd-kind-call-signature">isImmediatePropagationStopped</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isimmediatepropagationstopped-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether event.stopImmediatePropagation() was ever called on this event object.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-8">See<a href="#see-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>&lt;a href=&quot;https://api.jquery.com/event.isImmediatePropagationStopped/&quot;&gt;https://api.jquery.com/event.isImmediatePropagationStopped/&lt;/a&gt;</code></p>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-7">Since<a href="#since-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.3</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--checks-whether-eventstopimmediatepropagation-was-called">Example: ​ ````Checks whether event.stopImmediatePropagation() was called.<a href="#example--checks-whether-eventstopimmediatepropagation-was-called" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><span class="hl-10">&lt;!</span><span class="hl-11">doctype</span><span class="hl-1"> </span><span class="hl-12">html</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">html</span><span class="hl-1"> </span><span class="hl-12">lang</span><span class="hl-1">=</span><span class="hl-13">&quot;en&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">meta</span><span class="hl-1"> </span><span class="hl-12">charset</span><span class="hl-1">=</span><span class="hl-13">&quot;utf-8&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><span class="hl-1">event.isImmediatePropagationStopped demo</span><span class="hl-10">&lt;/</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-15"> </span><span class="hl-12">src</span><span class="hl-15">=</span><span class="hl-13">&quot;https://code.jquery.com/jquery-3.3.1.js&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">button</span><span class="hl-10">&gt;</span><span class="hl-1">click me</span><span class="hl-10">&lt;/</span><span class="hl-11">button</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-1"> </span><span class="hl-12">id</span><span class="hl-1">=</span><span class="hl-13">&quot;stop-log&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-2">function</span><span class="hl-15"> </span><span class="hl-0">immediatePropStopped</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> ) {</span><br/><span class="hl-2">var</span><span class="hl-15"> </span><span class="hl-5">msg</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-3">&quot;&quot;</span><span class="hl-15">;</span><br/><span class="hl-4">if</span><span class="hl-15"> ( </span><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-0">isImmediatePropagationStopped</span><span class="hl-15">() ) {</span><br/><span class="hl-5">msg</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-3">&quot;called&quot;</span><span class="hl-15">;</span><br/><span class="hl-15">} </span><span class="hl-4">else</span><span class="hl-15"> {</span><br/><span class="hl-5">msg</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-3">&quot;not called&quot;</span><span class="hl-15">;</span><br/><span class="hl-15">}</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;#stop-log&quot;</span><span class="hl-15"> ).</span><span class="hl-0">append</span><span class="hl-15">( </span><span class="hl-3">&quot;&lt;div&gt;&quot;</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-5">msg</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-3">&quot;&lt;/div&gt;&quot;</span><span class="hl-15"> );</span><br/><span class="hl-15">}</span><br/><span class="hl-15">​</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;button&quot;</span><span class="hl-15"> ).</span><span class="hl-0">click</span><span class="hl-15">(</span><span class="hl-2">function</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> ) {</span><br/><span class="hl-0">immediatePropStopped</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> );</span><br/><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-0">stopImmediatePropagation</span><span class="hl-15">();</span><br/><span class="hl-0">immediatePropStopped</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> );</span><br/><span class="hl-15">});</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">html</span><span class="hl-10">&gt;</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:5079</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="ispropagationstopped"><span>is<wbr/>Propagation<wbr/>Stopped</span><a href="#ispropagationstopped" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="ispropagationstopped-1"><span class="tsd-kind-call-signature">isPropagationStopped</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#ispropagationstopped-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns whether event.stopPropagation() was ever called on this event object.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-9">See<a href="#see-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>&lt;a href=&quot;https://api.jquery.com/event.isPropagationStopped/&quot;&gt;https://api.jquery.com/event.isPropagationStopped/&lt;/a&gt;</code></p>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-8">Since<a href="#since-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.3</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--checks-whether-eventstoppropagation-was-called">Example: ​ ````Checks whether event.stopPropagation() was called<a href="#example--checks-whether-eventstoppropagation-was-called" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><span class="hl-10">&lt;!</span><span class="hl-11">doctype</span><span class="hl-1"> </span><span class="hl-12">html</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">html</span><span class="hl-1"> </span><span class="hl-12">lang</span><span class="hl-1">=</span><span class="hl-13">&quot;en&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">meta</span><span class="hl-1"> </span><span class="hl-12">charset</span><span class="hl-1">=</span><span class="hl-13">&quot;utf-8&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><span class="hl-1">event.isPropagationStopped demo</span><span class="hl-10">&lt;/</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-15"> </span><span class="hl-12">src</span><span class="hl-15">=</span><span class="hl-13">&quot;https://code.jquery.com/jquery-3.3.1.js&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">button</span><span class="hl-10">&gt;</span><span class="hl-1">click me</span><span class="hl-10">&lt;/</span><span class="hl-11">button</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-1"> </span><span class="hl-12">id</span><span class="hl-1">=</span><span class="hl-13">&quot;stop-log&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-2">function</span><span class="hl-15"> </span><span class="hl-0">propStopped</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> ) {</span><br/><span class="hl-2">var</span><span class="hl-15"> </span><span class="hl-5">msg</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-3">&quot;&quot;</span><span class="hl-15">;</span><br/><span class="hl-4">if</span><span class="hl-15"> ( </span><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-0">isPropagationStopped</span><span class="hl-15">() ) {</span><br/><span class="hl-5">msg</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-3">&quot;called&quot;</span><span class="hl-15">;</span><br/><span class="hl-15">} </span><span class="hl-4">else</span><span class="hl-15"> {</span><br/><span class="hl-5">msg</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-3">&quot;not called&quot;</span><span class="hl-15">;</span><br/><span class="hl-15">}</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;#stop-log&quot;</span><span class="hl-15"> ).</span><span class="hl-0">append</span><span class="hl-15">( </span><span class="hl-3">&quot;&lt;div&gt;&quot;</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-5">msg</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-3">&quot;&lt;/div&gt;&quot;</span><span class="hl-15"> );</span><br/><span class="hl-15">}</span><br/><span class="hl-15">​</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;button&quot;</span><span class="hl-15"> ).</span><span class="hl-0">click</span><span class="hl-15">(</span><span class="hl-2">function</span><span class="hl-15">(</span><span class="hl-5">event</span><span class="hl-15">) {</span><br/><span class="hl-0">propStopped</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> );</span><br/><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-0">stopPropagation</span><span class="hl-15">();</span><br/><span class="hl-0">propStopped</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> );</span><br/><span class="hl-15">});</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">html</span><span class="hl-10">&gt;</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:5120</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="preventdefault"><span>prevent<wbr/>Default</span><a href="#preventdefault" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="preventdefault-1"><span class="tsd-kind-call-signature">preventDefault</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#preventdefault-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>If this method is called, the default action of the event will not be triggered.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-10">See<a href="#see-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>&lt;a href=&quot;https://api.jquery.com/event.preventDefault/&quot;&gt;https://api.jquery.com/event.preventDefault/&lt;/a&gt;</code></p>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-9">Since<a href="#since-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.0</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--cancel-the-default-action-navigation-of-the-click">Example: ​ ````Cancel the default action (navigation) of the click.<a href="#example--cancel-the-default-action-navigation-of-the-click" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><span class="hl-10">&lt;!</span><span class="hl-11">doctype</span><span class="hl-1"> </span><span class="hl-12">html</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">html</span><span class="hl-1"> </span><span class="hl-12">lang</span><span class="hl-1">=</span><span class="hl-13">&quot;en&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">meta</span><span class="hl-1"> </span><span class="hl-12">charset</span><span class="hl-1">=</span><span class="hl-13">&quot;utf-8&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><span class="hl-1">event.preventDefault demo</span><span class="hl-10">&lt;/</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-15"> </span><span class="hl-12">src</span><span class="hl-15">=</span><span class="hl-13">&quot;https://code.jquery.com/jquery-3.3.1.js&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">a</span><span class="hl-1"> </span><span class="hl-12">href</span><span class="hl-1">=</span><span class="hl-13">&quot;https://jquery.com&quot;</span><span class="hl-10">&gt;</span><span class="hl-1">default click action is prevented</span><span class="hl-10">&lt;/</span><span class="hl-11">a</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-1"> </span><span class="hl-12">id</span><span class="hl-1">=</span><span class="hl-13">&quot;log&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;a&quot;</span><span class="hl-15"> ).</span><span class="hl-0">click</span><span class="hl-15">(</span><span class="hl-2">function</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> ) {</span><br/><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-0">preventDefault</span><span class="hl-15">();</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;&lt;div&gt;&quot;</span><span class="hl-15"> )</span><br/><span class="hl-15">.</span><span class="hl-0">append</span><span class="hl-15">( </span><span class="hl-3">&quot;default &quot;</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-5">type</span><span class="hl-15"> </span><span class="hl-1">+</span><span class="hl-15"> </span><span class="hl-3">&quot; prevented&quot;</span><span class="hl-15"> )</span><br/><span class="hl-15">.</span><span class="hl-0">appendTo</span><span class="hl-15">( </span><span class="hl-3">&quot;#log&quot;</span><span class="hl-15"> );</span><br/><span class="hl-15">});</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">html</span><span class="hl-10">&gt;</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:5152</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="stopimmediatepropagation"><span>stop<wbr/>Immediate<wbr/>Propagation</span><a href="#stopimmediatepropagation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="stopimmediatepropagation-1"><span class="tsd-kind-call-signature">stopImmediatePropagation</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#stopimmediatepropagation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-11">See<a href="#see-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>&lt;a href=&quot;https://api.jquery.com/event.stopImmediatePropagation/&quot;&gt;https://api.jquery.com/event.stopImmediatePropagation/&lt;/a&gt;</code></p>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-10">Since<a href="#since-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.3</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--prevents-other-event-handlers-from-being-called">Example: ​ ````Prevents other event handlers from being called.<a href="#example--prevents-other-event-handlers-from-being-called" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><span class="hl-10">&lt;!</span><span class="hl-11">doctype</span><span class="hl-1"> </span><span class="hl-12">html</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">html</span><span class="hl-1"> </span><span class="hl-12">lang</span><span class="hl-1">=</span><span class="hl-13">&quot;en&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">meta</span><span class="hl-1"> </span><span class="hl-12">charset</span><span class="hl-1">=</span><span class="hl-13">&quot;utf-8&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><span class="hl-1">event.stopImmediatePropagation demo</span><span class="hl-10">&lt;/</span><span class="hl-11">title</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">style</span><span class="hl-10">&gt;</span><br/><span class="hl-14">p</span><span class="hl-15"> {</span><br/><span class="hl-12">height</span><span class="hl-15">: </span><span class="hl-9">30px</span><span class="hl-15">;</span><br/><span class="hl-12">width</span><span class="hl-15">: </span><span class="hl-9">150px</span><span class="hl-15">;</span><br/><span class="hl-12">background-color</span><span class="hl-15">: </span><span class="hl-16">#ccf</span><span class="hl-15">;</span><br/><span class="hl-15">}</span><br/><span class="hl-14">div</span><span class="hl-15"> {</span><br/><span class="hl-12">height</span><span class="hl-15">: </span><span class="hl-9">30px</span><span class="hl-15">;</span><br/><span class="hl-12">width</span><span class="hl-15">: </span><span class="hl-9">150px</span><span class="hl-15">;</span><br/><span class="hl-12">background-color</span><span class="hl-15">: </span><span class="hl-16">#cfc</span><span class="hl-15">;</span><br/><span class="hl-15">}</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">style</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-15"> </span><span class="hl-12">src</span><span class="hl-15">=</span><span class="hl-13">&quot;https://code.jquery.com/jquery-3.3.1.js&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">head</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">p</span><span class="hl-10">&gt;</span><span class="hl-1">paragraph</span><span class="hl-10">&lt;/</span><span class="hl-11">p</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><span class="hl-1">division</span><span class="hl-10">&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;p&quot;</span><span class="hl-15"> ).</span><span class="hl-0">click</span><span class="hl-15">(</span><span class="hl-2">function</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> ) {</span><br/><span class="hl-5">event</span><span class="hl-15">.</span><span class="hl-0">stopImmediatePropagation</span><span class="hl-15">();</span><br/><span class="hl-15">});</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;p&quot;</span><span class="hl-15"> ).</span><span class="hl-0">click</span><span class="hl-15">(</span><span class="hl-2">function</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> ) {</span><br/><span class="hl-6">// This function won&#39;t be executed</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-2">this</span><span class="hl-15"> ).</span><span class="hl-0">css</span><span class="hl-15">( </span><span class="hl-3">&quot;background-color&quot;</span><span class="hl-15">, </span><span class="hl-3">&quot;#f00&quot;</span><span class="hl-15"> );</span><br/><span class="hl-15">});</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">&quot;div&quot;</span><span class="hl-15"> ).</span><span class="hl-0">click</span><span class="hl-15">(</span><span class="hl-2">function</span><span class="hl-15">( </span><span class="hl-5">event</span><span class="hl-15"> ) {</span><br/><span class="hl-6">// This function will be executed</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-2">this</span><span class="hl-15"> ).</span><span class="hl-0">css</span><span class="hl-15">( </span><span class="hl-3">&quot;background-color&quot;</span><span class="hl-15">, </span><span class="hl-3">&quot;#f00&quot;</span><span class="hl-15"> );</span><br/><span class="hl-15">});</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-1">​</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">html</span><span class="hl-10">&gt;</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:5201</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="stoppropagation"><span>stop<wbr/>Propagation</span><a href="#stoppropagation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="stoppropagation-1"><span class="tsd-kind-call-signature">stopPropagation</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#stoppropagation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-12">See<a href="#see-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>&lt;a href=&quot;https://api.jquery.com/event.stopPropagation/&quot;&gt;https://api.jquery.com/event.stopPropagation/&lt;/a&gt;</code></p>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-11">Since<a href="#since-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.0</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--kill-the-bubbling-on-the-click-event">Example: ​ ````Kill the bubbling on the click event.<a href="#example--kill-the-bubbling-on-the-click-event" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-0">$</span><span class="hl-1">( </span><span class="hl-3">&quot;p&quot;</span><span class="hl-1"> ).</span><span class="hl-0">click</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">event</span><span class="hl-1"> ) {</span><br/><span class="hl-5">event</span><span class="hl-1">.</span><span class="hl-0">stopPropagation</span><span class="hl-1">();</span><br/><span class="hl-6">// Do something</span><br/><span class="hl-1">});</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:5214</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#altkey" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>alt<wbr/>Key</span></a><a href="#bubbles" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bubbles</span></a><a href="#button" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>button</span></a><a href="#buttons" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>buttons</span></a><a href="#cancelable" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cancelable</span></a><a href="#changedtouches" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>changed<wbr/>Touches</span></a><a href="#char" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>char</span></a><a href="#charcode" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>char<wbr/>Code</span></a><a href="#clientx" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clientX</span></a><a href="#clienty" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clientY</span></a><a href="#ctrlkey" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ctrl<wbr/>Key</span></a><a href="#detail" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>detail</span></a><a href="#eventphase" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event<wbr/>Phase</span></a><a href="#key" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a><a href="#keycode" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key<wbr/>Code</span></a><a href="#metakey" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>meta<wbr/>Key</span></a><a href="#offsetx" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>offsetX</span></a><a href="#offsety" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>offsetY</span></a><a href="#pagex" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pageX</span></a><a href="#pagey" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pageY</span></a><a href="#pointerid" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pointer<wbr/>Id</span></a><a href="#pointertype" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pointer<wbr/>Type</span></a><a href="#screenx" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>screenX</span></a><a href="#screeny" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>screenY</span></a><a href="#shiftkey" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shift<wbr/>Key</span></a><a href="#targettouches" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target<wbr/>Touches</span></a><a href="#timestamp" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>Stamp</span></a><a href="#toelement" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Element</span></a><a href="#touches" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>touches</span></a><a href="#type" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#view" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>view</span></a><a href="#which" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>which</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#isdefaultprevented" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Default<wbr/>Prevented</span></a><a href="#isimmediatepropagationstopped" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Immediate<wbr/>Propagation<wbr/>Stopped</span></a><a href="#ispropagationstopped" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Propagation<wbr/>Stopped</span></a><a href="#preventdefault" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prevent<wbr/>Default</span></a><a href="#stopimmediatepropagation" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Immediate<wbr/>Propagation</span></a><a href="#stoppropagation" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Propagation</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">trilium</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
Reference in New Issue View Git Blame Copy Permalink