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 | Accessor | |
String | The field's description. more details | InputField | |
CodedValueDomain|RangeDomain | The input value's domain. more details | InputField | |
Boolean | When true, the field can be edited. more details | InputField | |
String | The type of editor used when working with | InputField | |
String | If the input field's value is invalid, this property returns validation error code. more details | InputField | |
String | A user-friendly formatted error message based on the validation error code. more details | InputField | |
InputFieldGroup | The group this input field belongs to. more details | InputField | |
String | A hint for the field's value. more details | InputField | |
String | For date inputs, this enables the time input part. more details | InputField | |
String | The field's label. more details | InputField | |
Number | Restricts the input length. more details | InputField | |
Number | Restricts the input length. more details | InputField | |
String | The associated field name. more details | InputField | |
Boolean | Indicates whether the field is required. more details | InputField | |
Boolean | When true, this value can be submitted without introducing data validation issues. more details | InputField | |
String | The type of input field. more details | InputField | |
Boolean | If this | InputField | |
Boolean | When | InputField | |
Number|String|null | The input's value. more details | InputField | |
Boolean | When | 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
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
-
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 Maps SDK for JavaScript 4.10
-
The group this input field belongs to.
-
hint Stringreadonly
-
A hint for the field's value. Set this as a temporary placeholder for text/number inputs in either TextAreaInput or TextBoxInput.
-
includeTime StringreadonlySince: ArcGIS Maps SDK for JavaScript 4.17
-
For date inputs, this enables the time input part.
- Default Value:{true}
-
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
-
When true, this value can be submitted without introducing data validation issues.
-
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 blob
field type is an example of this.Possible Values:"number"|"text"|"date"|"unsupported"
-
updating Booleanreadonly
-
If this
InputField
has a value defined forvalueExpression
oreditableExpression
, this property will be true whenever one or both of these expressions is currently being executed; otherwise, it will be false.
-
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.
Method Overview
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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");