scandit-sdk
Version:
Scandit Barcode Scanner SDK for the Web
858 lines • 53 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ScanSettings | Scandit Barcode Scanner SDK for the Web</title>
<meta name="description" content="">
<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.js" 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">Scandit Barcode Scanner SDK for the Web</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>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="scansettings.html">ScanSettings</a>
</li>
</ul>
<h1>Class ScanSettings</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 configuration object for scanning options.</p>
</div>
<p>Modified ScanSettings need to be applied to a scanner via
<a href="barcodepicker.html#applyscansettings">BarcodePicker.applyScanSettings</a> or <a href="scanner.html#applyscansettings">Scanner.applyScanSettings</a> to take effect.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ScanSettings</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="scansettings.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="scansettings.html#disablesymbologies" class="tsd-kind-icon">disable<wbr>Symbologies</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#enablesymbologies" class="tsd-kind-icon">enable<wbr>Symbologies</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#getcodeduplicatefilter" class="tsd-kind-icon">get<wbr>Code<wbr>Duplicate<wbr>Filter</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#getmaxnumberofcodesperframe" class="tsd-kind-icon">get<wbr>Max<wbr>Number<wbr>OfCodes<wbr>Per<wbr>Frame</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#getproperty" class="tsd-kind-icon">get<wbr>Property</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#getsearcharea" class="tsd-kind-icon">get<wbr>Search<wbr>Area</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#getsymbologysettings" class="tsd-kind-icon">get<wbr>Symbology<wbr>Settings</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#isblurryrecognitionenabled" class="tsd-kind-icon">is<wbr>Blurry<wbr>Recognition<wbr>Enabled</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#isgpuaccelerationenabled" class="tsd-kind-icon">is<wbr>Gpu<wbr>Acceleration<wbr>Enabled</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#issymbologyenabled" class="tsd-kind-icon">is<wbr>Symbology<wbr>Enabled</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#setblurryrecognitionenabled" class="tsd-kind-icon">set<wbr>Blurry<wbr>Recognition<wbr>Enabled</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#setcodeduplicatefilter" class="tsd-kind-icon">set<wbr>Code<wbr>Duplicate<wbr>Filter</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#setgpuaccelerationenabled" class="tsd-kind-icon">set<wbr>Gpu<wbr>Acceleration<wbr>Enabled</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#setmaxnumberofcodesperframe" class="tsd-kind-icon">set<wbr>Max<wbr>Number<wbr>OfCodes<wbr>Per<wbr>Frame</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#setproperty" class="tsd-kind-icon">set<wbr>Property</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#setsearcharea" class="tsd-kind-icon">set<wbr>Search<wbr>Area</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="scansettings.html#tojsonstring" class="tsd-kind-icon">toJSONString</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>Scan<wbr>Settings<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:25</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create a ScanSettings instance.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> __namedParameters: <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> = {}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>blurry<wbr>Recognition<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="tsd-signature-symbol">Default = true</div>
Whether to enable/disable blurry recognition, to allow accurate scanning capabilities for out-of-focus (1D) codes.
If enabled, more advanced algorithms are executed (and more resources/time is spent) every frame in order
to successfully decode/scan difficult codes.
</div>
</li>
<li class="tsd-parameter">
<h5>code<wbr>Duplicate<wbr>Filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="tsd-signature-symbol">Default = 0</div>
The duplicate filter specifying how often a code can be scanned.
When the filter is set to -1, each unique code is only scanned once. When set to 0,
duplicate filtering is disabled. Otherwise the duplicate filter specifies an interval in milliseconds.
When the same code (data/symbology) is scanned within the specified interval it is filtered out as a duplicate.
</div>
</li>
<li class="tsd-parameter">
<h5>enabled<wbr>Symbologies<span class="tsd-signature-symbol">: </span><a href="../enums/barcode.symbology.html#aztec" class="tsd-signature-type">AZTEC</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#codabar" class="tsd-signature-type">CODABAR</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#code11" class="tsd-signature-type">CODE11</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#code128" class="tsd-signature-type">CODE128</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#code25" class="tsd-signature-type">CODE25</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#code32" class="tsd-signature-type">CODE32</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#code39" class="tsd-signature-type">CODE39</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#code93" class="tsd-signature-type">CODE93</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#data_matrix" class="tsd-signature-type">DATA_MATRIX</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#dotcode" class="tsd-signature-type">DOTCODE</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#ean13" class="tsd-signature-type">EAN13</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#ean8" class="tsd-signature-type">EAN8</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#five_digit_add_on" class="tsd-signature-type">FIVE_DIGIT_ADD_ON</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#gs1_databar" class="tsd-signature-type">GS1_DATABAR</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#gs1_databar_expanded" class="tsd-signature-type">GS1_DATABAR_EXPANDED</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#gs1_databar_limited" class="tsd-signature-type">GS1_DATABAR_LIMITED</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#interleaved_2_of_5" class="tsd-signature-type">INTERLEAVED_2_OF_5</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#kix" class="tsd-signature-type">KIX</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#lapa4sc" class="tsd-signature-type">LAPA4SC</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#maxicode" class="tsd-signature-type">MAXICODE</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#micro_pdf417" class="tsd-signature-type">MICRO_PDF417</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#micro_qr" class="tsd-signature-type">MICRO_QR</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#msi_plessey" class="tsd-signature-type">MSI_PLESSEY</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#pdf417" class="tsd-signature-type">PDF417</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#qr" class="tsd-signature-type">QR</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#rm4scc" class="tsd-signature-type">RM4SCC</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#two_digit_add_on" class="tsd-signature-type">TWO_DIGIT_ADD_ON</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#upca" class="tsd-signature-type">UPCA</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html#upce" class="tsd-signature-type">UPCE</a><span class="tsd-signature-symbol"> | </span><a href="../enums/barcode.symbology.html" class="tsd-signature-type">Symbology</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><a href="../enums/barcode.symbology.html" class="tsd-signature-type">Symbology</a><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<div class="tsd-signature-symbol">Default = []</div>
The single symbology or list/set of symbologies that should be initialized as enabled for recognition.
</div>
</li>
<li class="tsd-parameter">
<h5>gpu<wbr>Acceleration<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="tsd-signature-symbol">Default = true</div>
Whether to enable/disable GPU support via WebGL, to provide faster and more accurate barcode localization.
The GPU can and will be used only if the browser also supports the needed technologies
([WebGL](https://caniuse.com/#feat=webgl) and [OffscreenCanvas](https://caniuse.com/#feat=offscreencanvas)).
</div>
</li>
<li class="tsd-parameter">
<h5>max<wbr>Number<wbr>OfCodes<wbr>Per<wbr>Frame<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="tsd-signature-symbol">Default = 1</div>
The maximum number of barcodes to be recognized every frame.
</div>
</li>
<li class="tsd-parameter">
<h5>search<wbr>Area<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5>
<div class="tsd-comment tsd-typography">
<div class="tsd-signature-symbol">Default = { x: 0, y: 0, width: 1.0, height: 1.0 }</div>
The area of the image in which barcodes are searched.
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="scansettings.html" class="tsd-signature-type">ScanSettings</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="disablesymbologies" class="tsd-anchor"></a>
<h3>disable<wbr>Symbologies</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">disable<wbr>Symbologies<span class="tsd-signature-symbol">(</span>symbology<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SymbologyParameter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:174</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Disable recognition of a symbology or list/set of symbologies.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbology: <span class="tsd-signature-type">SymbologyParameter</span></h5>
<div class="tsd-comment tsd-typography">
<p>The single symbology or list/set of symbologies to disable.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></h4>
<p>The updated <a href="scansettings.html">ScanSettings</a> object.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="enablesymbologies" class="tsd-anchor"></a>
<h3>enable<wbr>Symbologies</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">enable<wbr>Symbologies<span class="tsd-signature-symbol">(</span>symbology<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SymbologyParameter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:164</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enable recognition of a symbology or list/set of symbologies.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbology: <span class="tsd-signature-type">SymbologyParameter</span></h5>
<div class="tsd-comment tsd-typography">
<p>The single symbology or list/set of symbologies to enable.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></h4>
<p>The updated <a href="scansettings.html">ScanSettings</a> object.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="getcodeduplicatefilter" class="tsd-anchor"></a>
<h3>get<wbr>Code<wbr>Duplicate<wbr>Filter</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Code<wbr>Duplicate<wbr>Filter<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:184</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>When the filter is set to -1, each unique code is only scanned once. When set to 0,
duplicate filtering is disabled. Otherwise the duplicate filter specifies an interval in milliseconds.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>The code duplicate filter value.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="getmaxnumberofcodesperframe" class="tsd-anchor"></a>
<h3>get<wbr>Max<wbr>Number<wbr>OfCodes<wbr>Per<wbr>Frame</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Max<wbr>Number<wbr>OfCodes<wbr>Per<wbr>Frame<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:206</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>The maximum number of barcodes to be recognized every frame.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="getproperty" class="tsd-anchor"></a>
<h3>get<wbr>Property</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Property<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:322</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a Scandit Engine library property.</p>
</div>
<p>This function is for internal use only and any functionality that can be accessed through it can and will vanish
without public notice from one version to the next. Do not call this function unless you specifically have to.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The property name.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>The property value. For properties not previously set, -1 is returned.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="getsearcharea" class="tsd-anchor"></a>
<h3>get<wbr>Search<wbr>Area</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Search<wbr>Area<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/searcharea.html" class="tsd-signature-type">SearchArea</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:225</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/searcharea.html" class="tsd-signature-type">SearchArea</a></h4>
<p>The area of the image in which barcodes are searched.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="getsymbologysettings" class="tsd-anchor"></a>
<h3>get<wbr>Symbology<wbr>Settings</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Symbology<wbr>Settings<span class="tsd-signature-symbol">(</span>symbology<span class="tsd-signature-symbol">: </span><a href="../enums/barcode.symbology.html" class="tsd-signature-type">Symbology</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="symbologysettings.html" class="tsd-signature-type">SymbologySettings</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:134</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the configuration object for a symbology (which can then be modified).</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbology: <a href="../enums/barcode.symbology.html" class="tsd-signature-type">Symbology</a></h5>
<div class="tsd-comment tsd-typography">
<p>The symbology for which to retrieve the configuration.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="symbologysettings.html" class="tsd-signature-type">SymbologySettings</a></h4>
<p>The symbology configuration object for the specified symbology.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="isblurryrecognitionenabled" class="tsd-anchor"></a>
<h3>is<wbr>Blurry<wbr>Recognition<wbr>Enabled</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">is<wbr>Blurry<wbr>Recognition<wbr>Enabled<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:293</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>Whether blurry recognition is configured to be enabled ot not.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="isgpuaccelerationenabled" class="tsd-anchor"></a>
<h3>is<wbr>Gpu<wbr>Acceleration<wbr>Enabled</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">is<wbr>Gpu<wbr>Acceleration<wbr>Enabled<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:270</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>Whether GPU acceleration is configured to be enabled ot not.</p>
<p>Note that this refers to the settings: depending on browser capabilities the actual GPU usage might be prevented.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="issymbologyenabled" class="tsd-anchor"></a>
<h3>is<wbr>Symbology<wbr>Enabled</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">is<wbr>Symbology<wbr>Enabled<span class="tsd-signature-symbol">(</span>symbology<span class="tsd-signature-symbol">: </span><a href="../enums/barcode.symbology.html" class="tsd-signature-type">Symbology</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:154</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the recognition enabled status for a symbology.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>symbology: <a href="../enums/barcode.symbology.html" class="tsd-signature-type">Symbology</a></h5>
<div class="tsd-comment tsd-typography">
<p>The symbology for which to retrieve the recognition enabled status.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>Whether the symbology enabled for recognition.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="setblurryrecognitionenabled" class="tsd-anchor"></a>
<h3>set<wbr>Blurry<wbr>Recognition<wbr>Enabled</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Blurry<wbr>Recognition<wbr>Enabled<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:307</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enable or disable blurry recognition.</p>
</div>
<p>Allow accurate scanning capabilities for out-of-focus (1D) codes.
If enabled, more advanced algorithms are executed (and more resources/time is spent) every frame in order
to successfully decode/scan difficult codes.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>Whether to enable or disable blurry recognition.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></h4>
<p>The updated <a href="scansettings.html">ScanSettings</a> object.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="setcodeduplicatefilter" class="tsd-anchor"></a>
<h3>set<wbr>Code<wbr>Duplicate<wbr>Filter</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Code<wbr>Duplicate<wbr>Filter<span class="tsd-signature-symbol">(</span>durationMilliseconds<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><a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:197</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set the code duplicate filter value.</p>
</div>
<p>When the filter is set to -1, each unique code is only scanned once. When set to 0,
duplicate filtering is disabled. Otherwise the duplicate filter specifies an interval in milliseconds.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>durationMilliseconds: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The new value (-1, 0, or positive integer).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></h4>
<p>The updated <a href="scansettings.html">ScanSettings</a> object.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="setgpuaccelerationenabled" class="tsd-anchor"></a>
<h3>set<wbr>Gpu<wbr>Acceleration<wbr>Enabled</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Gpu<wbr>Acceleration<wbr>Enabled<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:284</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enable or disable GPU acceleration.</p>
</div>
<p>Provide faster and more accurate barcode localization.
The GPU can and will be used only if the browser also supports the needed technologies
(<a href="https://caniuse.com/#feat=webgl">WebGL</a> and <a href="https://caniuse.com/#feat=offscreencanvas">OffscreenCanvas</a>).</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>Whether to enable or disable GPU acceleration.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></h4>
<p>The updated <a href="scansettings.html">ScanSettings</a> object.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="setmaxnumberofcodesperframe" class="tsd-anchor"></a>
<h3>set<wbr>Max<wbr>Number<wbr>OfCodes<wbr>Per<wbr>Frame</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Max<wbr>Number<wbr>OfCodes<wbr>Per<wbr>Frame<span class="tsd-signature-symbol">(</span>limit<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><a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:216</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set the maximum number of barcodes to be recognized every frame.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>limit: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The new value (non-zero positive integer).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></h4>
<p>The updated <a href="scansettings.html">ScanSettings</a> object.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="setproperty" class="tsd-anchor"></a>
<h3>set<wbr>Property</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Property<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<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><a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:340</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set a Scandit Engine library property.</p>
</div>
<p>This function is for internal use only and any functionality that can be accessed through it can and will vanish
without public notice from one version to the next. Do not call this function unless you specifically have to.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The property name.</p>
</div>
</li>
<li>
<h5>value: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The property value.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></h4>
<p>The updated <a href="scansettings.html">ScanSettings</a> object.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="setsearcharea" class="tsd-anchor"></a>
<h3>set<wbr>Search<wbr>Area</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Search<wbr>Area<span class="tsd-signature-symbol">(</span>searchArea<span class="tsd-signature-symbol">: </span><a href="../interfaces/searcharea.html" class="tsd-signature-type">SearchArea</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:235</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set the area of the image in which barcodes are searched.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>searchArea: <a href="../interfaces/searcharea.html" class="tsd-signature-type">SearchArea</a></h5>
<div class="tsd-comment tsd-typography">
<p>The new search area.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="scansettings.html" class="tsd-signature-type">ScanSettings</a></h4>
<p>The updated <a href="scansettings.html">ScanSettings</a> object.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="tojsonstring" class="tsd-anchor"></a>
<h3>toJSONString</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">toJSONString<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/scanSettings.ts:79</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The configuration object as a JSON string.</p>
</li>
</ul>
</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">
<li class=" tsd-kind-class">
<a href="barcodepicker.html" class="tsd-kind-icon">Barcode<wbr>Picker</a>
</li>
<li class=" tsd-kind-class">
<a href="parser.html" class="tsd-kind-icon">Parser</a>
</li>
<li class=" tsd-kind-class">
<a href="scanresult.html" class="tsd-kind-icon">Scan<wbr>Result</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="scansettings.html" class="tsd-kind-icon">Scan<wbr>Settings</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="scansettings.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#disablesymbologies" class="tsd-kind-icon">disable<wbr>Symbologies</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#enablesymbologies" class="tsd-kind-icon">enable<wbr>Symbologies</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#getcodeduplicatefilter" class="tsd-kind-icon">get<wbr>Code<wbr>Duplicate<wbr>Filter</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#getmaxnumberofcodesperframe" class="tsd-kind-icon">get<wbr>Max<wbr>Number<wbr>OfCodes<wbr>Per<wbr>Frame</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#getproperty" class="tsd-kind-icon">get<wbr>Property</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#getsearcharea" class="tsd-kind-icon">get<wbr>Search<wbr>Area</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#getsymbologysettings" class="tsd-kind-icon">get<wbr>Symbology<wbr>Settings</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#isblurryrecognitionenabled" class="tsd-kind-icon">is<wbr>Blurry<wbr>Recognition<wbr>Enabled</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#isgpuaccelerationenabled" class="tsd-kind-icon">is<wbr>Gpu<wbr>Acceleration<wbr>Enabled</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#issymbologyenabled" class="tsd-kind-icon">is<wbr>Symbology<wbr>Enabled</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#setblurryrecognitionenabled" class="tsd-kind-icon">set<wbr>Blurry<wbr>Recognition<wbr>Enabled</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#setcodeduplicatefilter" class="tsd-kind-icon">set<wbr>Code<wbr>Duplicate<wbr>Filter</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#setgpuaccelerationenabled" class="tsd-kind-icon">set<wbr>Gpu<wbr>Acceleration<wbr>Enabled</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#setmaxnumberofcodesperframe" class="tsd-kind-icon">set<wbr>Max<wbr>Number<wbr>OfCodes<wbr>Per<wbr>Frame</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#setproperty" class="tsd-kind-icon">set<wbr>Property</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#setsearcharea" class="tsd-kind-icon">set<wbr>Search<wbr>Area</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="scansettings.html#tojsonstring" class="tsd-kind-icon">toJSONString</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class">
<a href="scanner.html" class="tsd-kind-icon">Scanner</a>
</li>
<li class=" tsd-kind-class">
<a href="symbologysettings.html" class="tsd-kind-icon">Symbology<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/barcodeencodingrange.html" class="tsd-kind-icon">Barcode<wbr>Encoding<wbr>Range</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/parserfield.html" class="tsd-kind-icon">Parser<wbr>Field</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/parserresult.html" class="tsd-kind-icon">Parser<wbr>Result</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/point.html" class="tsd-kind-icon">Point</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/quadrilateral.html" class="tsd-kind-icon">Quadrilateral</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/searcharea.html" class="tsd-kind-icon">Search<wbr>Area</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../globals.html#resizeobserver" class="tsd-kind-icon">Resize<wbr>Observer</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#configure" class="tsd-kind-icon">configure</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<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-i