scandit-sdk

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Extension | 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="../classes/symbologysettings.html">SymbologySettings</a> </li> <li> <a href="symbologysettings.extension.html">Extension</a> </li> </ul> <h1>Enumeration Extension</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>Symbology extensions for particular functionalities, only applicable to specific barcodes. See: <a href="https://docs.scandit.com/stable/c_api/symbologies.html">https://docs.scandit.com/stable/c_api/symbologies.html</a>.</p> </div> </div> </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>Enumeration members</h3> <ul class="tsd-index-list"> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="symbologysettings.extension.html#direct_part_marking_mode" class="tsd-kind-icon">DIRECT_<wbr>PART_<wbr>MARKING_<wbr>MODE</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="symbologysettings.extension.html#full_ascii" class="tsd-kind-icon">FULL_<wbr>ASCII</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="symbologysettings.extension.html#relaxed_sharp_quiet_zone_check" class="tsd-kind-icon">RELAXED_<wbr>SHARP_<wbr>QUIET_<wbr>ZONE_<wbr>CHECK</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="symbologysettings.extension.html#remove_leading_upca_zero" class="tsd-kind-icon">REMOVE_<wbr>LEADING_<wbr>UPCA_<wbr>ZERO</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="symbologysettings.extension.html#remove_leading_zero" class="tsd-kind-icon">REMOVE_<wbr>LEADING_<wbr>ZERO</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="symbologysettings.extension.html#return_as_upca" class="tsd-kind-icon">RETURN_<wbr>AS_<wbr>UPCA</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="symbologysettings.extension.html#strip_leading_fnc1" class="tsd-kind-icon">STRIP_<wbr>LEADING_<wbr>FNC1</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Enumeration members</h2> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="direct_part_marking_mode" class="tsd-anchor"></a> <h3>DIRECT_<wbr>PART_<wbr>MARKING_<wbr>MODE</h3> <div class="tsd-signature tsd-kind-icon">DIRECT_<wbr>PART_<wbr>MARKING_<wbr>MODE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "direct_part_marking_mode"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/symbologySettings.ts:298</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Improve scan performance when reading direct part marked (DPM) Data Matrix codes. Enabling this extension comes at the cost of increased frame processing times.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="full_ascii" class="tsd-anchor"></a> <h3>FULL_<wbr>ASCII</h3> <div class="tsd-signature tsd-kind-icon">FULL_<wbr>ASCII<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "full_ascii"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/symbologySettings.ts:302</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Interpret the Code 39 / Code 93 code data using two symbols per output character to encode all ASCII characters.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="relaxed_sharp_quiet_zone_check" class="tsd-anchor"></a> <h3>RELAXED_<wbr>SHARP_<wbr>QUIET_<wbr>ZONE_<wbr>CHECK</h3> <div class="tsd-signature tsd-kind-icon">RELAXED_<wbr>SHARP_<wbr>QUIET_<wbr>ZONE_<wbr>CHECK<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "relaxed_sharp_quiet_zone_check"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/symbologySettings.ts:307</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Enable scanning codes that have quiet zones (white area before and after the code) significantly smaller than what's allowed by the symbology specification.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="remove_leading_upca_zero" class="tsd-anchor"></a> <h3>REMOVE_<wbr>LEADING_<wbr>UPCA_<wbr>ZERO</h3> <div class="tsd-signature tsd-kind-icon">REMOVE_<wbr>LEADING_<wbr>UPCA_<wbr>ZERO<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "remove_leading_upca_zero"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/symbologySettings.ts:315</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Remove the leading zero digit from the result if the UPC-A representation extension "RETURN_AS_UPCA" is enabled.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="remove_leading_zero" class="tsd-anchor"></a> <h3>REMOVE_<wbr>LEADING_<wbr>ZERO</h3> <div class="tsd-signature tsd-kind-icon">REMOVE_<wbr>LEADING_<wbr>ZERO<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "remove_leading_zero"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/symbologySettings.ts:311</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Remove the leading zero digit from the result.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="return_as_upca" class="tsd-anchor"></a> <h3>RETURN_<wbr>AS_<wbr>UPCA</h3> <div class="tsd-signature tsd-kind-icon">RETURN_<wbr>AS_<wbr>UPCA<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "return_as_upca"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/symbologySettings.ts:319</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Transform the UPC-E result into its UPC-A representation.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="strip_leading_fnc1" class="tsd-anchor"></a> <h3>STRIP_<wbr>LEADING_<wbr>FNC1</h3> <div class="tsd-signature tsd-kind-icon">STRIP_<wbr>LEADING_<wbr>FNC1<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "strip_leading_fnc1"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/symbologySettings.ts:323</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Remove the leading FNC1 character that indicates a GS1 code.</p> </div> </div> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class"> <a href="../classes/barcodepicker.html" class="tsd-kind-icon">Barcode<wbr>Picker</a> </li> <li class=" tsd-kind-class"> <a href="../classes/parser.html" class="tsd-kind-icon">Parser</a> </li> <li class=" tsd-kind-class"> <a href="../classes/scanresult.html" class="tsd-kind-icon">Scan<wbr>Result</a> </li> <li class=" tsd-kind-class"> <a href="../classes/scansettings.html" class="tsd-kind-icon">Scan<wbr>Settings</a> </li> <li class=" tsd-kind-class"> <a href="../classes/scanner.html" class="tsd-kind-icon">Scanner</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="../classes/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="symbologysettings.checksum.html" class="tsd-kind-icon">Checksum</a> </li> <li class="current tsd-kind-enum tsd-parent-kind-class tsd-is-static"> <a href="symbologysettings.extension.html" class="tsd-kind-icon">Extension</a> <ul> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="symbologysettings.extension.html#direct_part_marking_mode" class="tsd-kind-icon">DIRECT_<wbr>PART_<wbr>MARKING_<wbr>MODE</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="symbologysettings.extension.html#full_ascii" class="tsd-kind-icon">FULL_<wbr>ASCII</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="symbologysettings.extension.html#relaxed_sharp_quiet_zone_check" class="tsd-kind-icon">RELAXED_<wbr>SHARP_<wbr>QUIET_<wbr>ZONE_<wbr>CHECK</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="symbologysettings.extension.html#remove_leading_upca_zero" class="tsd-kind-icon">REMOVE_<wbr>LEADING_<wbr>UPCA_<wbr>ZERO</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="symbologysettings.extension.html#remove_leading_zero" class="tsd-kind-icon">REMOVE_<wbr>LEADING_<wbr>ZERO</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="symbologysettings.extension.html#return_as_upca" class="tsd-kind-icon">RETURN_<wbr>AS_<wbr>UPCA</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="symbologysettings.extension.html#strip_leading_fnc1" class="tsd-kind-icon">STRIP_<wbr>LEADING_<wbr>FNC1</a> </li> </ul> </li> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="../classes/symbologysettings.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/symbologysettings.html#disablechecksums" class="tsd-kind-icon">disable<wbr>Checksums</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/symbologysettings.html#disableextensions" class="tsd-kind-icon">disable<wbr>Extensions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/symbologysettings.html#enablechecksums" class="tsd-kind-icon">enable<wbr>Checksums</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/symbologysettings.html#enableextensions" class="tsd-kind-icon">enable<wbr>Extensions</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/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="../classes/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="../classes/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="../classes/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="../classes/symbologysettings.html#isenabled" class="tsd-kind-icon">is<wbr>Enabled</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/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="../classes/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="../classes/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="../classes/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>