InputField

Property Overview

Property Details

declaredClass Stringreadonly inherited

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

description Stringreadonly

The field's description.

domain CodedValueDomain|RangeDomainreadonly

The input value's domain. This is used to constrain the allowable values of the layer.

editable Booleanreadonly

When true, the field can be edited.

editorType Stringreadonly

The type of editor used when working with string fields. Possible values are in the table below.

Value	Description
text-box	An HTML textbox used to capture input.
text-area	An HTML textarea used to capture input.

Possible Values:"text-box"|"text-area"

Default Value:text-box

error Stringreadonly

If the input field's value is invalid, this property returns validation error code. Otherwise, it is null.

errorMessage Stringreadonly

A user-friendly formatted error message based on the validation error code.

group InputFieldGroupreadonly

Since: ArcGIS API for JavaScript 4.10

The group this input field belongs to.

hint Stringreadonly

A hint for the field's value. Set this as a temporary placeholder for text/number inputs in either TextAreaInput or TextBoxInput.

includeTime Stringreadonly

Since: ArcGIS API for JavaScript 4.17

For date inputs, this enables the time input part.

label Stringreadonly

The field's label.

maxLength Numberreadonly

Restricts the input length.

minLength Numberreadonly

Restricts the input length.

name Stringreadonly

The associated field name.

required Booleanreadonly

Indicates whether the field is required.

type Stringreadonly

The type of input field. Possible values are listed below.

Value	Description
number	Input represents a number.
text	Input represents text.
date	Input represents a date.
unsupported	The field represents an unsupported value. A blob field type is an example of this.

Possible Values:"number"|"text"|"date"|"unsupported"

valid Booleanreadonly

When true, the input value is valid. Otherwise, it is invalid.

value Number|String|nullreadonly

The input's value.

visible Booleanreadonly

When true, the field is displayed. Otherwise, it is hidden.