InputField

AMD: require(["esri/widgets/FeatureForm/InputField"], (InputField) => { /* code goes here */ });
ESM: import InputField from "@arcgis/core/widgets/FeatureForm/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.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
String

The field's description.

more details
InputField
CodedValueDomain|RangeDomain

The input value's domain.

more details
InputField
Boolean

When true, the field can be edited.

more details
InputField
String

The type of editor used when working with string fields.

more details
InputField
String

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

more details
InputField
String

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

more details
InputField
InputFieldGroup

The group this input field belongs to.

more details
InputField
String

A hint for the field's value.

more details
InputField
String

For date inputs, this enables the time input part.

more details
InputField
String

The field's label.

more details
InputField
Number

Restricts the input length.

more details
InputField
Number

Restricts the input length.

more details
InputField
String

The associated field name.

more details
InputField
Boolean

Indicates whether the field is required.

more details
InputField
Boolean

When true, this value can be submitted without introducing data validation issues.

more details
InputField
String

The type of input field.

more details
InputField
Boolean

If this InputField has a value defined for valueExpression or editableExpression, this property will be true whenever one or both of these expressions is currently being executed; otherwise, it will be false.

more details
InputField
Boolean

When true, the input value is valid.

more details
InputField
Number|String|null

The input's value.

more details
InputField
Boolean

When true, the field is displayed.

more details
InputField

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.

Default Value:{true}
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.

submittable Booleanreadonly

When true, this value can be submitted without introducing data validation issues.

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"

updating Booleanreadonly

If this InputField has a value defined for valueExpression or editableExpression, this property will be true whenever one or both of these expressions is currently being executed; otherwise, it will be false.

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.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.