BarcodeScannerInput

require(["esri/form/elements/inputs/BarcodeScannerInput"], function(BarcodeScannerInput) { /* code goes here */ });
Class: esri/form/elements/inputs/BarcodeScannerInput
Inheritance: BarcodeScannerInput Accessor
Since: ArcGIS API for JavaScript 4.19

The BarcodeScannerInput class defines the desired user interface for a barcode or QR code scanner. If this input type is used in an ArcGIS API for JavaScript web application, it will default to the TextBoxInput type as the API does not currently support bar code scanning.

See also:

Constructors

new BarcodeScannerInput(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
more detailsAccessor
Number

When set, defines the text input's maximum length.

more details
more detailsBarcodeScannerInput
Number

When set, defines the text input's minimum length.

more details
more detailsBarcodeScannerInput
String

The type of form element input.

more details
more detailsBarcodeScannerInput

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

maxLength Number

When set, defines the text input's maximum length.

minLength Number

When set, defines the text input's minimum length.

type Stringreadonly

The type of form element input.

For BarcodeScannerInput the type is always "barcode-scanner".

Method Overview

Name Return Type Summary Class
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
more detailsBarcodeScannerInput
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsBarcodeScannerInput

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.