FieldInput

AMD: require(["esri/widgets/FeatureForm/FieldInput"], (FieldInput) => { /* code goes here */ });
ESM: import FieldInput from "@arcgis/core/widgets/FeatureForm/FieldInput.js";
Class: esri/widgets/FeatureForm/FieldInput
Inheritance: FieldInput Accessor
Since: ArcGIS Maps SDK for JavaScript 4.27

This is a read-only support class that represents a field's input. It helps provide a consistent API for the different types input 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 type of data displayed by the field input.

more details
FieldInput
String

The name of the class.

more details
Accessor
CodedValueDomain|RangeDomain

The input value's domain.

more details
FieldInput
Boolean

Indicates if the field is editable.

more details
FieldInput
String

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

more details
FieldInput
Field

The associated field.

more details
FieldInput
GroupInput

The group containing the field input.

more details
FieldInput
String

A hint for the field's value.

more details
FieldInput
Boolean

Indicates whether date information is included for date inputs.

more details
FieldInput
String

Indicates whether time information is included for date inputs.

more details
FieldInput
Boolean

Indicates whether timestamp information is included for date inputs.

more details
FieldInput
String

The type of editor used when working with string fields.

more details
FieldInput
String

The field's label.

more details
FieldInput
Number

Restricts the input length.

more details
FieldInput
Number

Restricts the input length.

more details
FieldInput
String

The associated field name.

more details
FieldInput
Boolean

Indicates whether the field is required.

more details
FieldInput
Boolean

Indicates if the field's value can be submitted without introducing data validation issues.

more details
FieldInput
String

The type of input.

more details
FieldInput
Boolean

Indicates if the field is updating.

more details
FieldInput
Boolean

Indicates if the input value is valid.

more details
FieldInput
Number|String|null

The field input's value.

more details
FieldInput
Boolean

Indicates if the field is visible.

more details
FieldInput

Property Details

dataType Stringreadonly

The type of data displayed by the field input. 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"

declaredClass Stringreadonly inherited

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

domain CodedValueDomain|RangeDomainreadonly

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

editable Booleanreadonly

Indicates if the field is editable.

error Stringreadonly

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

field Fieldreadonly

The associated field.

group GroupInputreadonly

The group containing the field input.

hint Stringreadonly

A hint for the field's value. This is a temporary placeholder inputs in either TextAreaInput or TextBoxInput.

includeDate Booleanreadonly

Indicates whether date information is included for date inputs.

Default Value:true
includeTime Stringreadonly

Indicates whether time information is included for date inputs.

Default Value:true
includeTimeOffset Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.28

Indicates whether timestamp information is included for date inputs.

Default Value:false
inputType 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
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

Indicates if the field's value can be submitted without introducing data validation issues.

type Stringreadonly

The type of input. This value will always be "field".

For FieldInput the type is always "field".

updating Booleanreadonly

Indicates if the field is updating. This is applicable if the field has a value defined for FieldElement or @link esri/form/elements/FieldElement#editableExpression}. The property returns true whenever one or both of these expressions are processing. If the field belongs to a form configured with preserveFieldValuesWhenHidden set to false, this will also be true when FieldElement is processing.

valid Booleanreadonly

Indicates if the input value is valid.

value Number|String|nullreadonly

The field input's value.

visible Booleanreadonly

Indicates if the field is visible.

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

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 }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
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

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

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.