require(["esri/widgets/FeatureForm/FieldInput"], (FieldInput) => { /* code goes here */ });
import FieldInput from "@arcgis/core/widgets/FeatureForm/FieldInput.js";
esri/widgets/FeatureForm/FieldInput
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
Name | Type | Summary | Class |
---|---|---|---|
The type of data displayed by the field input. | FieldInput | ||
The name of the class. | Accessor | ||
The input's description. | FieldInput | ||
The input value's domain. | FieldInput | ||
Indicates if the field is editable. | FieldInput | ||
If the input field's value is invalid, this property returns a validation error code. | FieldInput | ||
The associated field. | FieldInput | ||
The group containing the field input. | FieldInput | ||
A hint for the field's value. | FieldInput | ||
Indicates whether date information is included for date inputs. | FieldInput | ||
Indicates whether time information is included for date inputs. | FieldInput | ||
Indicates whether timestamp information is included for date inputs. | FieldInput | ||
The type of editor used when working with | FieldInput | ||
The field's label. | FieldInput | ||
Restricts the input length. | FieldInput | ||
Restricts the input length. | FieldInput | ||
The associated field name. | FieldInput | ||
Indicates whether the field is required. | FieldInput | ||
Indicates if the field's value can be submitted without introducing data validation issues. | FieldInput | ||
The type of input. | FieldInput | ||
Indicates if the field is updating. | FieldInput | ||
Indicates if the input value is valid. | FieldInput | ||
The field input's value. | FieldInput | ||
Indicates if the field is visible. | FieldInput |
Property Details
-
dataType
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"
-
description
description Stringreadonly
-
The input's description.
-
domain
domain CodedValueDomain |RangeDomainreadonly
-
The input value's domain. This is used to constrain the allowable values of the layer.
-
editable
editable Booleanreadonly
-
Indicates if the field is editable.
-
error
error Stringreadonly
-
If the input field's value is invalid, this property returns a validation error code. Otherwise, it is
null
.
-
field
field Fieldreadonly
-
The associated field.
-
group
group GroupInputreadonly
-
The group containing the field input.
-
hint
hint Stringreadonly
-
A hint for the field's value. This is a temporary placeholder inputs in either TextAreaInput or TextBoxInput.
-
includeDate
includeDate Booleanreadonly
-
Indicates whether date information is included for date inputs.
- Default Value:true
-
includeTime
includeTime Stringreadonly
-
Indicates whether time information is included for date inputs.
- Default Value:true
-
includeTimeOffset
includeTimeOffset Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.28FieldInput since 4.27, includeTimeOffset added at 4.28. -
Indicates whether timestamp information is included for date inputs.
- Default Value:false
-
inputType
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
label Stringreadonly
-
The field's label.
-
maxLength
maxLength Numberreadonly
-
Restricts the input length.
-
minLength
minLength Numberreadonly
-
Restricts the input length.
-
name
name Stringreadonly
-
The associated field name.
-
required
required Booleanreadonly
-
Indicates whether the field is required.
-
submittable
submittable Booleanreadonly
-
Indicates if the field's value can be submitted without introducing data validation issues.
-
type
type Stringreadonly
-
The type of input.
For FieldInput the type is always "field".
-
updating
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
valid Booleanreadonly
-
Indicates if the input value is valid.
-
visible
visible Booleanreadonly
-
Indicates if the field is visible.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
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();
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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
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"); }
-
Inherited from Accessor
-
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");