Skip To ContentArcGIS for DevelopersSign In Dashboard

InputField

Class: esri/widgets/FeatureForm/InputField
Inheritance: InputField Accessor
Since: ArcGIS API for JavaScript 4.9

This is a read-only support class that represents an input field. It helps provide a consistent API for the different types of input fields used by the FeatureForm widget. The values are computed internally by the FeatureFormViewModel.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

The field's description.

more details
more detailsInputField
CodedValueDomain|RangeDomain

The input value's domain.

more details
more detailsInputField
Boolean

When true, the field can be edited.

more details
more detailsInputField
String

The type of editor used when working with string fields.

more details
more detailsInputField
String

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

more details
more detailsInputField
String

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

more details
more detailsInputField
InputFieldGroup

The group this input field belongs to.

more details
more detailsInputField
String

A hint for the field's value.

more details
more detailsInputField
String

The field's label.

more details
more detailsInputField
Number

Restricts the input length.

more details
more detailsInputField
String

The associated field name.

more details
more detailsInputField
Boolean

Indicates whether the field is required.

more details
more detailsInputField
String

The type of input field.

more details
more detailsInputField
Boolean

When true, the input value is valid.

more details
more detailsInputField
Number|String|null

The input's value.

more details
more detailsInputField
Boolean

When true, the field is displayed.

more details
more detailsInputField

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.

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.

ValueDescription
text-boxAn HTML textbox used to capture input.
text-areaAn HTML textarea used to capture input.
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. This property is rendered as a tooltip.

label Stringreadonly

The field's label.

maxLength 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.

ValueDescription
numberInput represents a number.
textInput represents text.
dateInput represents a date.
unsupportedThe field represents an unsupported value. A blob field type is an example of this.
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.

API Reference search results

NameTypeModule
Loading...