import FieldInput from "@arcgis/core/widgets/FeatureForm/FieldInput.js";const FieldInput = await $arcgis.import("@arcgis/core/widgets/FeatureForm/FieldInput.js");- Inheritance:
- FieldInput→
EditableInput<FieldElement | null | undefined>→ InputBase→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.27
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.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
dataType readonly | | |
declaredClass readonly inherited | ||
domain readonly | DomainUnion | null | undefined | |
editable readonly | | |
editType inherited | ||
error readonly | | |
field readonly | | |
group readonly | GroupInput | null | undefined | |
hint readonly | | |
includeDate readonly | | |
includeTime readonly | | |
includeTimeOffset readonly | | |
inputType readonly | | |
label readonly | | |
maxLength readonly | | |
minLength readonly | | |
name readonly | | |
| | ||
submittable readonly | | |
type readonly | "field" | |
updating readonly | | |
valid readonly | | |
| | ||
visible readonly | |
dataType
- Type
- FieldInputDataTypes
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. |
domain
- Type
- DomainUnion | null | undefined
The input value's domain. This is used to constrain the allowable values of the layer.
editType
- Type
- EditType
The value that will be set for the Arcade variable $editcontext.editType
in the Arcade context used to evaluate form expressions.
Accepted values are "INSERT", "UPDATE", "DELETE", and "NA".
For FieldInputs with value expressions, this property is also used in
determining whether or not the value expressions should be applied. Per the
Web Map Specification,
value expressions are ignored if the associated layer field is not
editable. Determining whether the layer field is editable must consider
whether the specific type of edit being attempted is allowed. For example,
if a layer has the supportsAdd capability but does not have the
supportsUpdate capability, then the value expression will be applied if
editType is INSERT but ignored if editType is UPDATE.
For the purposes of determining whether or not the layer allows the current
edit type, a value of "NA" is always considered allowed.
- Default value
- "NA"
hint
A hint for the field's value. This is a temporary placeholder inputs in either TextAreaInput or TextBoxInput.
includeDate
- Type
- boolean
Indicates whether date information is included for date inputs.
- Default value
- true
includeTime
- Type
- boolean
Indicates whether time information is included for date inputs.
- Default value
- true
includeTimeOffset
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.28
Indicates whether timestamp information is included for date inputs.
- Default value
- false
submittable
- Type
- boolean
Indicates if the field's value can be submitted without introducing data validation issues.
updating
- Type
- boolean
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.