FieldOptions
require(["esri/widgets/FeatureForm/FieldOptions"], function(FieldOptions) { /* code goes here */ });esri/widgets/FeatureForm/FieldOptionsThe field options used when configuring fields for the FeatureForm widget. Field options can be overwritten only when set values are compatible with the fields' configuration specified in the service.
Constructors
- new FieldOptions(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
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 | FieldOptions | |
| CodedValueDomain | RangeDomain | The field's domain. more details | more details | FieldOptions | |
| Boolean | Indicates whether the field is editable. more details | more details | FieldOptions | |
| String | The type of editor to use for | more details | FieldOptions | |
| String | This property is rendered as a tooltip in the FeatureForm widget. more details | more details | FieldOptions | |
| String | The field's label. more details | more details | FieldOptions | |
| Number | Restricts the input length. more details | more details | FieldOptions | |
| Boolean | Indicates whether the field is required. more details | more details | FieldOptions | |
| Boolean | When | more details | FieldOptions |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- descriptionString
The field's description. The description is shown below the field.
The field's domain. This is used to constrain the allowable values of the layer.
This only applies to relevant field types. For example, RangeDomain only applies to
numericanddatefield types.
- editableBoolean
Indicates whether the field is editable.
This does not change the underlying service's field and whether it is editable.
- Default Value:true
- editorTypeString
The type of editor to use for
stringfield types. Possible values are in the table below.Value Description text-box An HTML textbox will be used to capture input. text-area An HTML textarea will be used to capture input. - Default Value:"text-box"
- hintString
This property is rendered as a tooltip in the FeatureForm widget. It displays a hint for the attribute field's value.
- labelString
The field's label. The label is shown above the field.
- maxLengthNumber
Restricts the input length.
This only applies to
numericandtextfield types.- Default Value:-1
- requiredBoolean
Indicates whether the field is required.
This cannot change the underlying service's field requirements.
- Default Value:false
- visibleBoolean
When
true, the field is displayed. Otherwise, it is hidden.- Default Value:true