FieldInput

Property Overview

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

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