scandit-sdk

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>SymbologySettings | 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="symbologysettings.html">SymbologySettings</a> </li> </ul> <h1>Class SymbologySettings</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 symbology-specific configuration object.</p> </div> <p>See <a href="https://docs.scandit.com/stable/c_api/symbologies.html">https://docs.scandit.com/stable/c_api/symbologies.html</a> for more details.</p> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">SymbologySettings</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>Enumerations</h3> <ul class="tsd-index-list"> <li class="tsd-kind-enum tsd-parent-kind-class tsd-is-static"><a href="../enums/symbologysettings.checksum.html" class="tsd-kind-icon">Checksum</a></li> <li class="tsd-kind-enum tsd-parent-kind-class tsd-is-static"><a href="../enums/symbologysettings.extension.html" class="tsd-kind-icon">Extension</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="symbologysettings.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="symbologysettings.html#disablechecksums" class="tsd-kind-icon">disable<wbr>Checksums</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="symbologysettings.html#disableextensions" class="tsd-kind-icon">disable<wbr>Extensions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="symbologysettings.html#enablechecksums" class="tsd-kind-icon">enable<wbr>Checksums</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="symbologysettings.html#enableextensions" class="tsd-kind-icon">enable<wbr>Extensions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="symbologysettings.html#getactivesymbolcounts" class="tsd-kind-icon">get<wbr>Active<wbr>Symbol<wbr>Counts</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="symbologysettings.html#getenabledchecksums" class="tsd-kind-icon">get<wbr>Enabled<wbr>Checksums</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="symbologysettings.html#getenabledextensions" class="tsd-kind-icon">get<wbr>Enabled<wbr>Extensions</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="symbologysettings.html#iscolorinvertedenabled" class="tsd-kind-icon">is<wbr>Color<wbr>Inverted<wbr>Enabled</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="symbologysettings.html#isenabled" class="tsd-kind-icon">is<wbr>Enabled</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="symbologysettings.html#setactivesymbolcounts" class="tsd-kind-icon">set<wbr>Active<wbr>Symbol<wbr>Counts</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="symbologysettings.html#setactivesymbolcountsrange" class="tsd-kind-icon">set<wbr>Active<wbr>Symbol<wbr>Counts<wbr>Range</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="symbologysettings.html#setcolorinvertedenabled" class="tsd-kind-icon">set<wbr>Color<wbr>Inverted<wbr>Enabled</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="symbologysettings.html#setenabled" class="tsd-kind-icon">set<wbr>Enabled</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>Symbology<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="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/symbologySettings.ts:13</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Create a SymbologySettings 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>active<wbr>Symbol<wbr>Counts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <div class="tsd-signature-symbol">Default = []  (default symbology range)</div> The list of active symbol counts. </div> </li> <li class="tsd-parameter"> <h5>checksums<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</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/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</a><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <div class="tsd-signature-symbol">Default = undefined  (default symbology checksums)</div> The list/set of enabled checksums. </div> </li> <li class="tsd-parameter"> <h5>color<wbr>Inverted<wbr>Enabled<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 = false</div> Whether color inverted recognition is enabled. </div> </li> <li class="tsd-parameter"> <h5>enabled<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 = false</div> Whether the symbology is enabled for recognition. </div> </li> <li class="tsd-parameter"> <h5>extensions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/symbologysettings.extension.html" class="tsd-signature-type">Extension</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/symbologysettings.extension.html" class="tsd-signature-type">Extension</a><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <div class="tsd-signature-symbol">Default = undefined  (default symbology extensions)</div> The list/set of enabled extensions. </div> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="symbologysettings.html" class="tsd-signature-type">SymbologySettings</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="disablechecksums" class="tsd-anchor"></a> <h3>disable<wbr>Checksums</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">disable<wbr>Checksums<span class="tsd-signature-symbol">(</span>checksum<span class="tsd-signature-symbol">: </span><a href="../enums/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</a><span class="tsd-signature-symbol"> | </span><a href="../enums/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</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/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</a><span class="tsd-signature-symbol">></span><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/symbologySettings.ts:246</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Disable a checksum or list/set of checksums.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>checksum: <a href="../enums/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</a><span class="tsd-signature-symbol"> | </span><a href="../enums/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</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/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</a><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <p>The single checksum or list/set of checksums to disable.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="symbologysettings.html" class="tsd-signature-type">SymbologySettings</a></h4> <p>The updated <a href="symbologysettings.html">SymbologySettings</a> object.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > <a name="disableextensions" class="tsd-anchor"></a> <h3>disable<wbr>Extensions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">disable<wbr>Extensions<span class="tsd-signature-symbol">(</span>extension<span class="tsd-signature-symbol">: </span><a href="../enums/symbologysettings.extension.html" class="tsd-signature-type">Extension</a><span class="tsd-signature-symbol"> | </span><a href="../enums/symbologysettings.extension.html" class="tsd-signature-type">Extension</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/symbologysettings.extension.html" class="tsd-signature-type">Extension</a><span class="tsd-signature-symbol">></span><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/symbologySettings.ts:187</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Disable an extension or list/set of extensions.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>extension: <a href="../enums/symbologysettings.extension.html" class="tsd-signature-type">Extension</a><span class="tsd-signature-symbol"> | </span><a href="../enums/symbologysettings.extension.html" class="tsd-signature-type">Extension</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/symbologysettings.extension.html" class="tsd-signature-type">Extension</a><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <p>The single extension or list/set of extensions to disable.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="symbologysettings.html" class="tsd-signature-type">SymbologySettings</a></h4> <p>The updated <a href="symbologysettings.html">SymbologySettings</a> object.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > <a name="enablechecksums" class="tsd-anchor"></a> <h3>enable<wbr>Checksums</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">enable<wbr>Checksums<span class="tsd-signature-symbol">(</span>checksum<span class="tsd-signature-symbol">: </span><a href="../enums/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</a><span class="tsd-signature-symbol"> | </span><a href="../enums/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</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/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</a><span class="tsd-signature-symbol">></span><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/symbologySettings.ts:220</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Enable a checksum or list/set of checksums.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>checksum: <a href="../enums/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</a><span class="tsd-signature-symbol"> | </span><a href="../enums/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</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/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</a><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <p>The single checksum or list/set of checksums to enable.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="symbologysettings.html" class="tsd-signature-type">SymbologySettings</a></h4> <p>The updated <a href="symbologysettings.html">SymbologySettings</a> object.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > <a name="enableextensions" class="tsd-anchor"></a> <h3>enable<wbr>Extensions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">enable<wbr>Extensions<span class="tsd-signature-symbol">(</span>extension<span class="tsd-signature-symbol">: </span><a href="../enums/symbologysettings.extension.html" class="tsd-signature-type">Extension</a><span class="tsd-signature-symbol"> | </span><a href="../enums/symbologysettings.extension.html" class="tsd-signature-type">Extension</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/symbologysettings.extension.html" class="tsd-signature-type">Extension</a><span class="tsd-signature-symbol">></span><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/symbologySettings.ts:161</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Enable an extension or list/set of extensions</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>extension: <a href="../enums/symbologysettings.extension.html" class="tsd-signature-type">Extension</a><span class="tsd-signature-symbol"> | </span><a href="../enums/symbologysettings.extension.html" class="tsd-signature-type">Extension</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/symbologysettings.extension.html" class="tsd-signature-type">Extension</a><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <p>The single extension or list/set of extensions to enable.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="symbologysettings.html" class="tsd-signature-type">SymbologySettings</a></h4> <p>The updated <a href="symbologysettings.html">SymbologySettings</a> object.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > <a name="getactivesymbolcounts" class="tsd-anchor"></a> <h3>get<wbr>Active<wbr>Symbol<wbr>Counts</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Active<wbr>Symbol<wbr>Counts<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><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in lib/symbologySettings.ts:113</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the currently set custom list of active symbol counts. If never set, an empty array is returned but the Scandit Engine library will use the default list for the symbology.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4> <p>The list of active symbol counts.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > <a name="getenabledchecksums" class="tsd-anchor"></a> <h3>get<wbr>Enabled<wbr>Checksums</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Enabled<wbr>Checksums<span class="tsd-signature-symbol">(</span><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/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in lib/symbologySettings.ts:210</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the currently set custom set of checksums. If never set, an empty set is returned but the Scandit Engine library will use the default checksum set for the symbology.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><a href="../enums/symbologysettings.checksum.html" class="tsd-signature-type">Checksum</a><span class="tsd-signature-symbol">></span></h4> <p>The set of enabled checksums.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > <a name="getenabledextensions" class="tsd-anchor"></a> <h3>get<wbr>Enabled<wbr>Extensions</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Enabled<wbr>Extensions<span class="tsd-signature-symbol">(</span><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/symbologysettings.extension.html" class="tsd-signature-type">Extension</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in lib/symbologySettings.ts:151</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the currently set custom set of extensions. If never set, an empty set is returned but the Scandit Engine library will use the default extension set for the symbology.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><a href="../enums/symbologysettings.extension.html" class="tsd-signature-type">Extension</a><span class="tsd-signature-symbol">></span></h4> <p>The set of enabled extensions.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > <a name="iscolorinvertedenabled" class="tsd-anchor"></a> <h3>is<wbr>Color<wbr>Inverted<wbr>Enabled</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">is<wbr>Color<wbr>Inverted<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/symbologySettings.ts:90</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 color inverted recognition is enabled.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > <a name="isenabled" class="tsd-anchor"></a> <h3>is<wbr>Enabled</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">is<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/symbologySettings.ts:71</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 the symbology enabled for recognition.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > <a name="setactivesymbolcounts" class="tsd-anchor"></a> <h3>set<wbr>Active<wbr>Symbol<wbr>Counts</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Active<wbr>Symbol<wbr>Counts<span class="tsd-signature-symbol">(</span>activeSymbolCounts<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-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/symbologySettings.ts:123</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set the list of active symbol counts.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>activeSymbolCounts: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>The list of active symbol counts.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="symbologysettings.html" class="tsd-signature-type">SymbologySettings</a></h4> <p>The updated <a href="symbologysettings.html">SymbologySettings</a> object.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > <a name="setactivesymbolcountsrange" class="tsd-anchor"></a> <h3>set<wbr>Active<wbr>Symbol<wbr>Counts<wbr>Range</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Active<wbr>Symbol<wbr>Counts<wbr>Range<span class="tsd-signature-symbol">(</span>minCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, maxCount<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="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/symbologySettings.ts:136</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set the (inclusive) range of active symbol counts.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>minCount: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The minimum accepted number of symbols.</p> </div> </li> <li> <h5>maxCount: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The maximum accepted number of symbols.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="symbologysettings.html" class="tsd-signature-type">SymbologySettings</a></h4> <p>The updated <a href="symbologysettings.html">SymbologySettings</a> object.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > <a name="setcolorinvertedenabled" class="tsd-anchor"></a> <h3>set<wbr>Color<wbr>Inverted<wbr>Enabled</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Color<wbr>Inverted<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="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/symbologySettings.ts:100</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Enable or disable recognition of inverted-color symbology (in addition to normal colors).</p> </div> </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 color inverted recognition is enabled.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="symbologysettings.html" class="tsd-signature-type">SymbologySettings</a></h4> <p>The updated <a href="symbologysettings.html">SymbologySettings</a> object.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > <a name="setenabled" class="tsd-anchor"></a> <h3>set<wbr>Enabled</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<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="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/symbologySettings.ts:81</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Enable or disable recognition of the symbology.</p> </div> </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 the symbology is enabled for recognition.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="symbologysettings.html" class="tsd-signature-type">SymbologySettings</a></h4> <p>The updated <a href="symbologysettings.html">SymbologySettings</a> object.</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> <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> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="symbologysettings.html" class="tsd-kind-icon">Symbology<wbr>Settings</a> <ul> <li class=" tsd-kind-enum tsd-parent-kind-class tsd-is-static"> <a href="../enums/symbologysettings.checksum.html" class="tsd-kind-icon">Checksum</a> </li> <li class=" tsd-kind-enum tsd-parent-kind-class tsd-is-static"> <a href="../enums/symbologysettings.extension.html" class="tsd-kind-icon">Extension</a> </li> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="symbologysettings.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#disablechecksums" class="tsd-kind-icon">disable<wbr>Checksums</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#disableextensions" class="tsd-kind-icon">disable<wbr>Extensions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#enablechecksums" class="tsd-kind-icon">enable<wbr>Checksums</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#enableextensions" class="tsd-kind-icon">enable<wbr>Extensions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#getactivesymbolcounts" class="tsd-kind-icon">get<wbr>Active<wbr>Symbol<wbr>Counts</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#getenabledchecksums" class="tsd-kind-icon">get<wbr>Enabled<wbr>Checksums</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#getenabledextensions" class="tsd-kind-icon">get<wbr>Enabled<wbr>Extensions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#iscolorinvertedenabled" class="tsd-kind-icon">is<wbr>Color<wbr>Inverted<wbr>Enabled</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#isenabled" class="tsd-kind-icon">is<wbr>Enabled</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#setactivesymbolcounts" class="tsd-kind-icon">set<wbr>Active<wbr>Symbol<wbr>Counts</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#setactivesymbolcountsrange" class="tsd-kind-icon">set<wbr>Active<wbr>Symbol<wbr>Counts<wbr>Range</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#setcolorinvertedenabled" class="tsd-kind-icon">set<wbr>Color<wbr>Inverted<wbr>Enabled</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="symbologysettings.html#setenabled" class="tsd-kind-icon">set<wbr>Enabled</a> </li> </ul> </li> </ul> <ul class="after-current"> <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-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <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> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</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-call-signature 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>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>