Mintplex-Labs/nut.js
1
0
Fork 0
mirror of https://github.com/Mintplex-Labs/nut.js.git synced 2026-07-22 09:55:22 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
6fe5ce13e17321ceaee3c696bb236900a663deb2
nut.js/docs/classes/mouse.html
T
Simon Hofmann 6fe5ce13e1 (#40) Typedoc update
2020-05-04 17:48:01 +02:00

649 lines
36 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Mouse | @nut-tree/nut-js</title>
<meta name="description" content="Documentation for @nut-tree/nut-js">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@nut-tree/nut-js</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="mouse.html">Mouse</a>
</li>
</ul>
<h1>Class Mouse</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html">Mouse</a> class provides methods to emulate mouse input</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Mouse</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="mouse.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mouse.html#drag" class="tsd-kind-icon">drag</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mouse.html#getposition" class="tsd-kind-icon">get<wbr>Position</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mouse.html#leftclick" class="tsd-kind-icon">left<wbr>Click</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mouse.html#move" class="tsd-kind-icon">move</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mouse.html#pressbutton" class="tsd-kind-icon">press<wbr>Button</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mouse.html#releasebutton" class="tsd-kind-icon">release<wbr>Button</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mouse.html#rightclick" class="tsd-kind-icon">right<wbr>Click</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mouse.html#scrolldown" class="tsd-kind-icon">scroll<wbr>Down</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mouse.html#scrollleft" class="tsd-kind-icon">scroll<wbr>Left</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mouse.html#scrollright" class="tsd-kind-icon">scroll<wbr>Right</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mouse.html#scrollup" class="tsd-kind-icon">scroll<wbr>Up</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mouse.html#setposition" class="tsd-kind-icon">set<wbr>Position</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal tsd-parent-kind-class"><a href="mouse.html#config" class="tsd-kind-icon">config</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Mouse<span class="tsd-signature-symbol">(</span>native<span class="tsd-signature-symbol">: </span><a href="nativeadapter.html" class="tsd-signature-type">NativeAdapter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mouse.html" class="tsd-signature-type">Mouse</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L24">mouse.class.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html">Mouse</a> class constructor</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>native: <a href="nativeadapter.html" class="tsd-signature-type">NativeAdapter</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="nativeadapter.html">NativeAdapter</a> instance which bundles access to mouse, keyboard and clipboard</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="mouse.html" class="tsd-signature-type">Mouse</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="drag" class="tsd-anchor"></a>
<h3>drag</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">drag<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L178">mouse.class.ts:178</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html#drag">drag</a> drags the mouse along a certain path
In summary, <a href="mouse.html#drag">drag</a> presses and holds the left mouse button, moves the mouse and releases the left button</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <a href="point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The path of <a href="point.html">Point</a>s to drag along</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getposition" class="tsd-anchor"></a>
<h3>get<wbr>Position</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Position<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L52">mouse.class.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html#getposition">getPosition</a> returns a <a href="point.html">Point</a> representing the current mouse position</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="leftclick" class="tsd-anchor"></a>
<h3>left<wbr>Click</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">left<wbr>Click<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L82">mouse.class.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html#leftclick">leftClick</a> performs a click with the left mouse button</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="move" class="tsd-anchor"></a>
<h3>move</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">move<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span>, movementType<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">linear</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L61">mouse.class.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html#move">move</a> moves the mouse cursor along a given path of <a href="point.html">Point</a>s, according to a movement type</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <a href="point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
<p>Array of <a href="point.html">Point</a>s to follow</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> movementType: <span class="tsd-signature-type">linear</span><span class="tsd-signature-symbol"> = linear</span></h5>
<div class="tsd-comment tsd-typography">
<p>Defines the type of mouse movement. Would allow to configured acceleration etc. (Default: <a href="../globals.html#linear">linear</a>, no acceleration)</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="pressbutton" class="tsd-anchor"></a>
<h3>press<wbr>Button</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">press<wbr>Button<span class="tsd-signature-symbol">(</span>btn<span class="tsd-signature-symbol">: </span><a href="../enums/button.html" class="tsd-signature-type">Button</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L196">mouse.class.ts:196</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html#pressbutton">pressButton</a> presses and holds a mouse button</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>btn: <a href="../enums/button.html" class="tsd-signature-type">Button</a></h5>
<div class="tsd-comment tsd-typography">
<p>The <a href="../enums/button.html">Button</a> to press and hold</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="releasebutton" class="tsd-anchor"></a>
<h3>release<wbr>Button</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">release<wbr>Button<span class="tsd-signature-symbol">(</span>btn<span class="tsd-signature-symbol">: </span><a href="../enums/button.html" class="tsd-signature-type">Button</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L211">mouse.class.ts:211</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html#releasebutton">releaseButton</a> releases a mouse button previously pressed via <a href="mouse.html#pressbutton">pressButton</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>btn: <a href="../enums/button.html" class="tsd-signature-type">Button</a></h5>
<div class="tsd-comment tsd-typography">
<p>The <a href="../enums/button.html">Button</a> to release</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="rightclick" class="tsd-anchor"></a>
<h3>right<wbr>Click</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">right<wbr>Click<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L93">mouse.class.ts:93</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html#rightclick">rightClick</a> performs a click with the right mouse button</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="scrolldown" class="tsd-anchor"></a>
<h3>scroll<wbr>Down</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">scroll<wbr>Down<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L110">mouse.class.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html#scrolldown">scrollDown</a> scrolls down for a given amount of &quot;steps&quot;
Please note that the actual scroll distance of a single &quot;step&quot; is OS dependent</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>amount: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The amount of &quot;steps&quot; to scroll</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="scrollleft" class="tsd-anchor"></a>
<h3>scroll<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">scroll<wbr>Left<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L144">mouse.class.ts:144</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html#scrollleft">scrollLeft</a> scrolls left for a given amount of &quot;steps&quot;
Please note that the actual scroll distance of a single &quot;step&quot; is OS dependent</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>amount: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The amount of &quot;steps&quot; to scroll</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="scrollright" class="tsd-anchor"></a>
<h3>scroll<wbr>Right</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">scroll<wbr>Right<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L161">mouse.class.ts:161</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html#scrollright">scrollRight</a> scrolls right for a given amount of &quot;steps&quot;
Please note that the actual scroll distance of a single &quot;step&quot; is OS dependent</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>amount: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The amount of &quot;steps&quot; to scroll</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="scrollup" class="tsd-anchor"></a>
<h3>scroll<wbr>Up</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">scroll<wbr>Up<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L127">mouse.class.ts:127</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html#scrollup">scrollUp</a> scrolls up for a given amount of &quot;steps&quot;
Please note that the actual scroll distance of a single &quot;step&quot; is OS dependent</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>amount: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The amount of &quot;steps&quot; to scroll</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="setposition" class="tsd-anchor"></a>
<h3>set<wbr>Position</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Position<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L38">mouse.class.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="mouse.html#setposition">setPosition</a> instantly moves the mouse cursor to a given <a href="point.html">Point</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>target: <a href="point.html" class="tsd-signature-type">Point</a></h5>
<div class="tsd-comment tsd-typography">
<p><a href="point.html">Point</a> to move the cursor to</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="mouse.html" class="tsd-signature-type">Mouse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-class">
<a name="config" class="tsd-anchor"></a>
<h3>config</h3>
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L14">mouse.class.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Config object for <a href="mouse.html">Mouse</a> class</p>
</div>
</div>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="config.autodelayms" class="tsd-anchor"></a>
<h3>auto<wbr>Delay<wbr>Ms</h3>
<div class="tsd-signature tsd-kind-icon">auto<wbr>Delay<wbr>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 100</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L18">mouse.class.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Configures the delay between single mouse events</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="config.mousespeed" class="tsd-anchor"></a>
<h3>mouse<wbr>Speed</h3>
<div class="tsd-signature tsd-kind-icon">mouse<wbr>Speed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1000</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f986636/lib/mouse.class.ts#L23">mouse.class.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Configures the speed in pixels/second for mouse movement</p>
</div>
</div>
</section>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="mouse.html" class="tsd-kind-icon">Mouse</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="mouse.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="mouse.html#drag" class="tsd-kind-icon">drag</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="mouse.html#getposition" class="tsd-kind-icon">get<wbr>Position</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="mouse.html#leftclick" class="tsd-kind-icon">left<wbr>Click</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="mouse.html#move" class="tsd-kind-icon">move</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="mouse.html#pressbutton" class="tsd-kind-icon">press<wbr>Button</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="mouse.html#releasebutton" class="tsd-kind-icon">release<wbr>Button</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="mouse.html#rightclick" class="tsd-kind-icon">right<wbr>Click</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="mouse.html#scrolldown" class="tsd-kind-icon">scroll<wbr>Down</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="mouse.html#scrollleft" class="tsd-kind-icon">scroll<wbr>Left</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="mouse.html#scrollright" class="tsd-kind-icon">scroll<wbr>Right</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="mouse.html#scrollup" class="tsd-kind-icon">scroll<wbr>Up</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="mouse.html#setposition" class="tsd-kind-icon">set<wbr>Position</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-class">
<a href="mouse.html#config" class="tsd-kind-icon">config</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink