UNPKG

scandit-sdk

Version:

Scandit Barcode Scanner SDK for the Web

340 lines 16.3 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>DataFormat | 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/parser.html">Parser</a> </li> <li> <a href="parser.dataformat.html">DataFormat</a> </li> </ul> <h1>Enumeration DataFormat</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>Data format of a string to be parsed into a set of key-value mappings by the Scandit Parser Library.</p> </div> <p>See <a href="https://docs.scandit.com/parser/formats.html">https://docs.scandit.com/parser/formats.html</a> for more details.</p> </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="parser.dataformat.html#dlid" class="tsd-kind-icon">DLID</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="parser.dataformat.html#gs1_ai" class="tsd-kind-icon">GS1_<wbr>AI</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="parser.dataformat.html#hibc" class="tsd-kind-icon">HIBC</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="parser.dataformat.html#mrtd" class="tsd-kind-icon">MRTD</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="parser.dataformat.html#swissqr" class="tsd-kind-icon">SWISSQR</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="dlid" class="tsd-anchor"></a> <h3>DLID</h3> <div class="tsd-signature tsd-kind-icon">DLID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;3</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/parser.ts:106</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>AAMVA Driver License/Identification (DL/ID).</p> </div> <p>See: <a href="http://www.aamva.org">http://www.aamva.org</a>.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="gs1_ai" class="tsd-anchor"></a> <h3>GS1_<wbr>AI</h3> <div class="tsd-signature tsd-kind-icon">GS1_<wbr>AI<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;1</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/parser.ts:94</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>GS1 Application Identifier (AI).</p> </div> <p>See: <a href="http://www.gs1.org/docs/barcodes/GS1_General_Specifications.pdf">http://www.gs1.org/docs/barcodes/GS1_General_Specifications.pdf</a>.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="hibc" class="tsd-anchor"></a> <h3>HIBC</h3> <div class="tsd-signature tsd-kind-icon">HIBC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;2</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/parser.ts:100</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Health Industry Bar Code (HIBC).</p> </div> <p>See: <a href="http://www.hibcc.org">http://www.hibcc.org</a>.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="mrtd" class="tsd-anchor"></a> <h3>MRTD</h3> <div class="tsd-signature tsd-kind-icon">MRTD<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;4</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/parser.ts:112</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>ICAO Machine Readable Travel Document (MRTD).</p> </div> <p>See: <a href="https://www.icao.int">https://www.icao.int</a>.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum" > <a name="swissqr" class="tsd-anchor"></a> <h3>SWISSQR</h3> <div class="tsd-signature tsd-kind-icon">SWISSQR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;5</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/parser.ts:118</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Swiss QR ISO 20022.</p> </div> <p>See: <a href="https://www.paymentstandards.ch">https://www.paymentstandards.ch</a>.</p> </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> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="../classes/parser.html" class="tsd-kind-icon">Parser</a> <ul> <li class="current tsd-kind-enum tsd-parent-kind-class tsd-is-static"> <a href="parser.dataformat.html" class="tsd-kind-icon">Data<wbr>Format</a> <ul> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="parser.dataformat.html#dlid" class="tsd-kind-icon">DLID</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="parser.dataformat.html#gs1_ai" class="tsd-kind-icon">GS1_<wbr>AI</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="parser.dataformat.html#hibc" class="tsd-kind-icon">HIBC</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="parser.dataformat.html#mrtd" class="tsd-kind-icon">MRTD</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="parser.dataformat.html#swissqr" class="tsd-kind-icon">SWISSQR</a> </li> </ul> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/parser.html#parserawdata" class="tsd-kind-icon">parse<wbr>Raw<wbr>Data</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/parser.html#parsestring" class="tsd-kind-icon">parse<wbr>String</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/parser.html#setoptions" class="tsd-kind-icon">set<wbr>Options</a> </li> </ul> </li> </ul> <ul class="after-current"> <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> <li class=" tsd-kind-class"> <a href="../classes/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-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>