scandit-sdk
Version:
Scandit Barcode Scanner SDK for the Web
359 lines (358 loc) • 16.5 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ScanResult | Scandit Barcode Scanner SDK for the Web</title>
<meta name="description" content="Documentation for Scandit Barcode Scanner SDK for the Web">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</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">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>
</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="../modules.html">Scandit Barcode Scanner SDK for the Web</a>
</li>
<li>
<a href="ScanResult.html">ScanResult</a>
</li>
</ul>
<h1>Class ScanResult</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 result of a scanning operation on an image.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ScanResult</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="ScanResult.html#barcodes" class="tsd-kind-icon">barcodes</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="ScanResult.html#imageData" class="tsd-kind-icon">image<wbr>Data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="ScanResult.html#imageSettings" class="tsd-kind-icon">image<wbr>Settings</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="ScanResult.html#texts" class="tsd-kind-icon">texts</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="ScanResult.html#rejectCode" class="tsd-kind-icon">reject<wbr>Code</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ScanResult.html#rejectText" class="tsd-kind-icon">reject<wbr>Text</a></li>
</ul>
</section>
</div>
</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="barcodes" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> barcodes</h3>
<div class="tsd-signature tsd-kind-icon">barcodes<span class="tsd-signature-symbol">:</span> <a href="../interfaces/Barcode.html" class="tsd-signature-type" data-tsd-kind="Interface">Barcode</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The list of barcodes found in the image (can be empty).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
<a name="imageData" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> image<wbr>Data</h3>
<div class="tsd-signature tsd-kind-icon">image<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The image data given as a byte array, formatted accordingly to the set settings (<a href="ScanResult.html#imageSettings">imageSettings</a>).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
<a name="imageSettings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> image<wbr>Settings</h3>
<div class="tsd-signature tsd-kind-icon">image<wbr>Settings<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ImageSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">ImageSettings</a></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The configuration object defining the properties of the processed image (<a href="ScanResult.html#imageData">imageData</a>).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
<a name="texts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> texts</h3>
<div class="tsd-signature tsd-kind-icon">texts<span class="tsd-signature-symbol">:</span> <a href="../interfaces/RecognizedText.html" class="tsd-signature-type" data-tsd-kind="Interface">RecognizedText</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The list of texts found in the image (can be empty).</p>
</div>
</div>
</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="rejectCode" class="tsd-anchor"></a>
<h3>reject<wbr>Code</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">reject<wbr>Code<span class="tsd-signature-symbol">(</span>barcode<span class="tsd-signature-symbol">: </span><a href="../interfaces/Barcode.html" class="tsd-signature-type" data-tsd-kind="Interface">Barcode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Prevent playing a sound, vibrating or flashing the GUI for a particular code.
If all codes and texts in the result are rejected (or no barcode/text is present), sound, vibration and GUI
flashing will be suppressed.</p>
</div>
<p>Rejected codes will still be part of the <a href="ScanResult.html#barcodes">ScanResult.barcodes</a> property like all other codes.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>barcode: <a href="../interfaces/Barcode.html" class="tsd-signature-type" data-tsd-kind="Interface">Barcode</a></h5>
<div class="tsd-comment tsd-typography">
<p>The barcode to be rejected.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
<a name="rejectText" class="tsd-anchor"></a>
<h3>reject<wbr>Text</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">reject<wbr>Text<span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><a href="../interfaces/RecognizedText.html" class="tsd-signature-type" data-tsd-kind="Interface">RecognizedText</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Prevent playing a sound, vibrating or flashing the GUI for a particular text.
If all codes and texts in the result are rejected (or no barcode/text is present), sound, vibration and GUI
flashing will be suppressed.</p>
</div>
<p>Rejected texts will still be part of the <a href="ScanResult.html#texts">ScanResult.texts</a> property like all other texts.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>text: <a href="../interfaces/RecognizedText.html" class="tsd-signature-type" data-tsd-kind="Interface">RecognizedText</a></h5>
<div class="tsd-comment tsd-typography">
<p>The text to be rejected.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</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>
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="ScanResult.html" class="tsd-kind-icon">Scan<wbr>Result</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="ScanResult.html#barcodes" class="tsd-kind-icon">barcodes</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="ScanResult.html#imageData" class="tsd-kind-icon">image<wbr>Data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="ScanResult.html#imageSettings" class="tsd-kind-icon">image<wbr>Settings</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="ScanResult.html#texts" class="tsd-kind-icon">texts</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ScanResult.html#rejectCode" class="tsd-kind-icon">reject<wbr>Code</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ScanResult.html#rejectText" class="tsd-kind-icon">reject<wbr>Text</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class">
<a href="ScanSettings.html" class="tsd-kind-icon">Scan<wbr>Settings</a>
</li>
<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-class">
<a href="TextRecognitionSettings.html" class="tsd-kind-icon">Text<wbr>Recognition<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/Barcode.html" class="tsd-kind-icon">Barcode</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/BrowserCompatibility.html" class="tsd-kind-icon">Browser<wbr>Compatibility</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/Camera.html" class="tsd-kind-icon">Camera</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/CameraSettings.html" class="tsd-kind-icon">Camera<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/ImageSettings.html" class="tsd-kind-icon">Image<wbr>Settings</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/RecognizedText.html" class="tsd-kind-icon">Recognized<wbr>Text</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-interface">
<a href="../interfaces/SingleImageModePlatformSettings.html" class="tsd-kind-icon">Single<wbr>Image<wbr>Mode<wbr>Platform<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/SingleImageModeSettings.html" class="tsd-kind-icon">Single<wbr>Image<wbr>Mode<wbr>Settings</a>
</li>
<li class=" tsd-kind-function">
<a href="../modules.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-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>
</ul>
<ul class="tsd-legend">
<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="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-23556890-7', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>