Mintplex-Labs/nut.js
1
0
Fork 0
mirror of https://github.com/Mintplex-Labs/nut.js.git synced 2026-07-21 01:15:22 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
dbbbc09cd66ed652e0fa29f8a21d05bcaaffc8f5
nut.js/docs/classes/optionalsearchparameters.html
T
Simon Hofmann 605d7d5940 (#241) Updated docs
2021-06-24 23:18:43 +02:00

289 lines
14 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>OptionalSearchParameters | @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="optionalsearchparameters.html">OptionalSearchParameters</a>
</li>
</ul>
<h1>Class OptionalSearchParameters</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="optionalsearchparameters.html">OptionalSearchParameters</a> serves as a data class holding location parameters for image search</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">OptionalSearchParameters</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="optionalsearchparameters.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="optionalsearchparameters.html#abort" class="tsd-kind-icon">abort</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="optionalsearchparameters.html#confidence" class="tsd-kind-icon">confidence</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="optionalsearchparameters.html#searchmultiplescales" class="tsd-kind-icon">search<wbr>Multiple<wbr>Scales</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="optionalsearchparameters.html#searchregion" class="tsd-kind-icon">search<wbr>Region</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>Optional<wbr>Search<wbr>Parameters<span class="tsd-signature-symbol">(</span>searchRegion<span class="tsd-signature-symbol">?: </span><a href="region.html" class="tsd-signature-type">Region</a>, confidence<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>, searchMultipleScales<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span>, abort<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="optionalsearchparameters.html" class="tsd-signature-type">OptionalSearchParameters</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/3aa660c/lib/optionalsearchparameters.class.ts#L7">optionalsearchparameters.class.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="optionalsearchparameters.html">OptionalSearchParameters</a> class constructor</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> searchRegion: <a href="region.html" class="tsd-signature-type">Region</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional <a href="region.html">Region</a> to limit the search space to</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> confidence: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional confidence value to configure image match confidence</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> searchMultipleScales: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional flag to indicate if the search should be conducted at different scales</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> abort: <span class="tsd-signature-type">AbortSignal</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An {@link AbortSignal} to cancel an ongoing call to <code>waitFor</code></p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="optionalsearchparameters.html" class="tsd-signature-type">OptionalSearchParameters</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="abort" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> abort</h3>
<div class="tsd-signature tsd-kind-icon">abort<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AbortSignal</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/optionalsearchparameters.class.ts#L15">optionalsearchparameters.class.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An {@link AbortSignal} to cancel an ongoing call to <code>waitFor</code></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="confidence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> confidence</h3>
<div class="tsd-signature tsd-kind-icon">confidence<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 <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/optionalsearchparameters.class.ts#L15">optionalsearchparameters.class.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional confidence value to configure image match confidence</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="searchmultiplescales" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> search<wbr>Multiple<wbr>Scales</h3>
<div class="tsd-signature tsd-kind-icon">search<wbr>Multiple<wbr>Scales<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/optionalsearchparameters.class.ts#L15">optionalsearchparameters.class.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional flag to indicate if the search should be conducted at different scales</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="searchregion" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> search<wbr>Region</h3>
<div class="tsd-signature tsd-kind-icon">search<wbr>Region<span class="tsd-signature-symbol">:</span> <a href="region.html" class="tsd-signature-type">Region</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/optionalsearchparameters.class.ts#L15">optionalsearchparameters.class.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional <a href="region.html">Region</a> to limit the search space to</p>
</div>
</div>
</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="optionalsearchparameters.html" class="tsd-kind-icon">Optional<wbr>Search<wbr>Parameters</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="optionalsearchparameters.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="optionalsearchparameters.html#abort" class="tsd-kind-icon">abort</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="optionalsearchparameters.html#confidence" class="tsd-kind-icon">confidence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="optionalsearchparameters.html#searchmultiplescales" class="tsd-kind-icon">search<wbr>Multiple<wbr>Scales</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="optionalsearchparameters.html#searchregion" class="tsd-kind-icon">search<wbr>Region</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-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><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>
</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