Property Overview

Property Details

declaredClassStringreadonly inherited

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

descriptionStringreadonly

The field's description.

domainCodedValueDomain|RangeDomainreadonly

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

editableBooleanreadonly

When true, the field can be edited.

editorTypeStringreadonly

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.

Default Value:text-box

errorStringreadonly

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

errorMessageStringreadonly

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

groupInputFieldGroupreadonly

Since: ArcGIS API for JavaScript 4.10

The group this input field belongs to.

hintStringreadonly

A hint for the field's value. This property is rendered as a tooltip.

labelStringreadonly

The field's label.

maxLengthNumberreadonly

Restricts the input length.

nameStringreadonly

The associated field name.

requiredBooleanreadonly

Indicates whether the field is required.

typeStringreadonly

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.

validBooleanreadonly

When true, the input value is invalid. Otherwise, it is valid.

valueNumber|String|nullreadonly

The input's value.

visibleBooleanreadonly

When true, the field is displayed. Otherwise, it is hidden.