Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Cordova

Example code

For barcode scanner usage examples, you can either use one of the sample apps included in the plugin archive, or paste one of the samples below into your www/index.html file.

Build the sample apps

In order to build the simple or extended sample apps you must import one of them upon creation of your project as follows:

phonegap create helloworld --copy-from <path-to-repository>/samples/simple/www/


phonegap create helloworld --copy-from <path-to-repository>/samples/extended/www/

Note that you will still need to add the platform and plugin as described in here. You will also need to replace the app key in the samples with your application key. For the extended sample, the application key is in www/index.js.

Simple Fullscreen

This shows the simplest way of using the plugin. The scanner is opened full screen and is closed as soon as a barcode is scanned, returning the result to a function specified by you.

<!DOCTYPE html>
<meta charset="utf-8" />
<meta name="format-detection" content="telephone=no" />
<meta name="msapplication-tap-highlight" content="no" />
<meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1,
minimum-scale=1, width=device-width, height=device-height" />
<title>Scandit Barcode Scanner</title>
<body style='background:black'>
<script type="text/javascript" src="cordova.js"></script>
<script type="text/javascript">
// On Windows, the alert function doesn't exist, so we add it.
window.alert = window.alert !== undefined ? window.alert : function (message) {
var alertBox = new Windows.UI.Popups.MessageDialog(message);
function success(session) {
alert("Scanned " + session.newlyRecognizedCodes[0].symbology
+ " code: " + session.newlyRecognizedCodes[0].data);
function failure(error) {
alert("Failed: " + error);
function scan() {
Scandit.License.setAppKey("-- ENTER YOUR APP KEY HERE --");
var settings = new Scandit.ScanSettings();
settings.setSymbologyEnabled(Scandit.Barcode.Symbology.UPC12, true);
settings.setSymbologyEnabled(Scandit.Barcode.Symbology.EAN8, true);
settings.setSymbologyEnabled(Scandit.Barcode.Symbology.CODE39, true);
// Some 1d barcode symbologies allow you to encode variable-length data. By default, the
// Scandit BarcodeScanner SDK only scans barcodes in a certain length range. If your
// application requires scanning of one of these symbologies, and the length is falling
// outside the default range, you may need to adjust the "active symbol counts" for this
// symbology. This is shown in the following few lines of code.
var symSettings = settings.getSymbologySettings(Scandit.Barcode.Symbology.CODE39);
symSettings.activeSymbolCounts = [
7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20
// For details on defaults and how to calculate the symbol counts for each symbology, take
// a look at
var picker = new Scandit.BarcodePicker(settings);, null, failure);
<div align="center" valign="center">
<input type="button" value="scan" onclick="scan()" style="margin-top: 230px;
width: 100px; height: 30px; font-size: 1em"/>

Continuous Scaled/Cropped

For an example of how to display the picker in a scaled/cropped configuration, take a look at the extended sample which is part of the SDK archive.