FieldInput | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The type of data displayed by the field input.	FieldInput
String	The name of the class.	Accessor
String	The input's description.	FieldInput
CodedValueDomain\|RangeDomain	The input value's domain.	FieldInput
Boolean	Indicates if the field is editable.	FieldInput
String	If the input field's value is invalid, this property returns a validation error code.	FieldInput
Field	The associated field.	FieldInput
GroupInput	The group containing the field input.	FieldInput
String	A hint for the field's value.	FieldInput
Boolean	Indicates whether date information is included for date inputs.	FieldInput
String	Indicates whether time information is included for date inputs.	FieldInput
Boolean	Indicates whether timestamp information is included for date inputs.	FieldInput
String	The type of editor used when working with `string` fields.	FieldInput
String	The field's label.	FieldInput
Number	Restricts the input length.	FieldInput
Number	Restricts the input length.	FieldInput
String	The associated field name.	FieldInput
Boolean	Indicates whether the field is required.	FieldInput
Boolean	Indicates if the field's value can be submitted without introducing data validation issues.	FieldInput
String	The type of input.	FieldInput
Boolean	Indicates if the field is updating.	FieldInput
Boolean	Indicates if the input value is valid.	FieldInput
Number\|String\|null	The field input's value.	FieldInput
Boolean	Indicates if the field is visible.	FieldInput

Property Details

dataType Property 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 Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

description Property description Stringreadonly

The input's description.

domain Property domain CodedValueDomain |RangeDomainreadonly

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

editable Property editable Booleanreadonly

Indicates if the field is editable.

error Property error Stringreadonly

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

field Property field Fieldreadonly

The associated field.

group Property group GroupInputreadonly

The group containing the field input.

hint Property hint Stringreadonly

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

includeDate Property includeDate Booleanreadonly

Indicates whether date information is included for date inputs.

Default Value:true

includeTime Property includeTime Stringreadonly

Indicates whether time information is included for date inputs.

Default Value:true

includeTimeOffset Property includeTimeOffset Booleanreadonly Since: ArcGIS Maps SDK for JavaScript 4.28 FieldInput since 4.27, includeTimeOffset added at 4.28.

Indicates whether timestamp information is included for date inputs.

Default Value:false

inputType Property 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 Property label Stringreadonly

The field's label.

maxLength Property maxLength Numberreadonly

Restricts the input length.

minLength Property minLength Numberreadonly

Restricts the input length.

name Property name Stringreadonly

The associated field name.

required Property required Booleanreadonly

Indicates whether the field is required.

submittable Property submittable Booleanreadonly

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

type Property type Stringreadonly

The type of input.

For FieldInput the type is always "field".

updating Property updating Booleanreadonly

Indicates if the field is updating. This is applicable if the field has a value defined for FieldElement.valueExpression or 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.visibilityExpression is processing.

valid Property valid Booleanreadonly

Indicates if the input value is valid.

value Property value Number |String |nullreadonly

The field input's value.

visible Property visible Booleanreadonly

Indicates if the field is visible.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

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 Inherited Method removeHandles(groupKey) Inherited from Accessor

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