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
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | The field's description. more details | more details | InputField | |
| CodedValueDomain|RangeDomain | The input value's domain. more details | more details | InputField | |
| Boolean | When true, the field can be edited. more details | more details | InputField | |
| String | The type of editor used when working with | more details | InputField | |
| String | If the input field's value is invalid, this property returns validation error code. more details | more details | InputField | |
| String | A user-friendly formatted error message based on the validation error code. more details | more details | InputField | |
| InputFieldGroup | The group this input field belongs to. more details | more details | InputField | |
| String | A hint for the field's value. more details | more details | InputField | |
| String | For date inputs, this enables the time input part. more details | more details | InputField | |
| String | The field's label. more details | more details | InputField | |
| Number | Restricts the input length. more details | more details | InputField | |
| Number | Restricts the input length. more details | more details | InputField | |
| String | The associated field name. more details | more details | InputField | |
| Boolean | Indicates whether the field is required. more details | more details | InputField | |
| String | The type of input field. more details | more details | InputField | |
| Boolean | When | more details | InputField | |
| Number|String|null | The input's value. more details | more details | InputField | |
| Boolean | When | more details | InputField |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className.
-
description Stringreadonly
-
The field's description.
-
-
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
stringfields. 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 InputFieldGroupreadonlySince: ArcGIS API for JavaScript 4.10
-
The group this input field belongs to.
-
hint Stringreadonly
-
A hint for the field's value. This property is rendered as a tooltip.
-
includeTime StringreadonlySince: ArcGIS API for JavaScript 4.17
-
For date inputs, this enables the time input part.
-
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.
-
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 blobfield type is an example of this.Possible Values:"number"|"text"|"date"|"unsupported"
-
valid Booleanreadonly
-
When
true, the input value is valid. Otherwise, it is invalid.
-
The input's value.
-
visible Booleanreadonly
-
When
true, the field is displayed. Otherwise, it is hidden.