UNPKG

scandit-sdk

Version:

Scandit Barcode Scanner SDK for the Web

346 lines 16.6 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>CompositeFlag | 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="../modules/barcode.html">Barcode</a> </li> <li> <a href="barcode.compositeflag.html">CompositeFlag</a> </li> </ul> <h1>Enumeration CompositeFlag</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>Flags to hint that two codes form a composite code.</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="barcode.compositeflag.html#gs1_a" class="tsd-kind-icon">GS1_<wbr>A</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="barcode.compositeflag.html#gs1_b" class="tsd-kind-icon">GS1_<wbr>B</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="barcode.compositeflag.html#gs1_c" class="tsd-kind-icon">GS1_<wbr>C</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="barcode.compositeflag.html#linked" class="tsd-kind-icon">LINKED</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="barcode.compositeflag.html#none" class="tsd-kind-icon">NONE</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="barcode.compositeflag.html#unknown" class="tsd-kind-icon">UNKNOWN</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="gs1_a" class="tsd-anchor"></a> <h3>GS1_<wbr>A</h3> <div class="tsd-signature tsd-kind-icon">GS1_<wbr>A<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;4</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/barcode.ts:148</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Code is a GS1 Composite Code Type A (CC - A).This flag can be set by MicroPDF417 codes.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="gs1_b" class="tsd-anchor"></a> <h3>GS1_<wbr>B</h3> <div class="tsd-signature tsd-kind-icon">GS1_<wbr>B<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;8</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/barcode.ts:152</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Code is a GS1 Composite Code Type B (CC-B). This flag can be set by MicroPDF417 codes.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="gs1_c" class="tsd-anchor"></a> <h3>GS1_<wbr>C</h3> <div class="tsd-signature tsd-kind-icon">GS1_<wbr>C<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;16</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/barcode.ts:156</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Code is a GS1 Composite Code Type C (CC-C). This flag can be set by PDF417 codes.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="linked" class="tsd-anchor"></a> <h3>LINKED</h3> <div class="tsd-signature tsd-kind-icon">LINKED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;2</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/barcode.ts:144</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Code is the linear component of a composite code. This flag can be set by GS1 DataBar or GS1-128 (Code 128).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="none" class="tsd-anchor"></a> <h3>NONE</h3> <div class="tsd-signature tsd-kind-icon">NONE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;0</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/barcode.ts:135</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Code is not part of a composite code.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="unknown" class="tsd-anchor"></a> <h3>UNKNOWN</h3> <div class="tsd-signature tsd-kind-icon">UNKNOWN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;1</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/barcode.ts:140</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Code could be part of a composite code. This flag is set by linear (1D) symbologies that have no composite flag support but can be part of a composite code like the EAN/UPC symbology family.</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> <li class="current tsd-kind-module"> <a href="../modules/barcode.html">Barcode</a> </li> <li class=" tsd-kind-module"> <a href="../modules/browsercompatibility.html">Browser<wbr>Compatibility</a> </li> <li class=" tsd-kind-module"> <a href="../modules/browserhelper.html">Browser<wbr>Helper</a> </li> <li class=" tsd-kind-module"> <a href="../modules/camera.html">Camera</a> </li> <li class=" tsd-kind-module"> <a href="../modules/cameraaccess.html">Camera<wbr>Access</a> </li> <li class=" tsd-kind-module"> <a href="../modules/camerasettings.html">Camera<wbr>Settings</a> </li> <li class=" tsd-kind-module"> <a href="../modules/imagesettings.html">Image<wbr>Settings</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-enum tsd-parent-kind-module"> <a href="barcode.compositeflag.html" class="tsd-kind-icon">Composite<wbr>Flag</a> <ul> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="barcode.compositeflag.html#gs1_a" class="tsd-kind-icon">GS1_<wbr>A</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="barcode.compositeflag.html#gs1_b" class="tsd-kind-icon">GS1_<wbr>B</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="barcode.compositeflag.html#gs1_c" class="tsd-kind-icon">GS1_<wbr>C</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="barcode.compositeflag.html#linked" class="tsd-kind-icon">LINKED</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="barcode.compositeflag.html#none" class="tsd-kind-icon">NONE</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="barcode.compositeflag.html#unknown" class="tsd-kind-icon">UNKNOWN</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-enum tsd-parent-kind-module"> <a href="barcode.symbology.html" class="tsd-kind-icon">Symbology</a> </li> <li class=" tsd-kind-property tsd-parent-kind-module"> <a href="../modules/barcode.html#compositeflag-1" class="tsd-kind-icon">composite<wbr>Flag</a> </li> <li class=" tsd-kind-property tsd-parent-kind-module"> <a href="../modules/barcode.html#data" class="tsd-kind-icon">data</a> </li> <li class=" tsd-kind-property tsd-parent-kind-module"> <a href="../modules/barcode.html#encodingarray" class="tsd-kind-icon">encoding<wbr>Array</a> </li> <li class=" tsd-kind-property tsd-parent-kind-module"> <a href="../modules/barcode.html#isgs1datacarrier" class="tsd-kind-icon">is<wbr>Gs1<wbr>Data<wbr>Carrier</a> </li> <li class=" tsd-kind-property tsd-parent-kind-module"> <a href="../modules/barcode.html#location" class="tsd-kind-icon">location</a> </li> <li class=" tsd-kind-property tsd-parent-kind-module"> <a href="../modules/barcode.html#rawdata" class="tsd-kind-icon">raw<wbr>Data</a> </li> <li class=" tsd-kind-property tsd-parent-kind-module"> <a href="../modules/barcode.html#symbology-1" class="tsd-kind-icon">symbology</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>