• esri/form

FieldElement

AMD: require(["esri/form/elements/FieldElement"], (FieldElement) => { /* code goes here */ });
ESM: import FieldElement from "@arcgis/core/form/elements/FieldElement";
Class: esri/form/elements/FieldElement
Inheritance: FieldElement Element Accessor
Since: ArcGIS API for JavaScript 4.16

A FieldElement form element defines how a feature layer's field participates in the FeatureForm. This is the recommended approach to set field configurations within a feature form's or feature layer's formTemplate.

form template field elements

See also
Example
// Create the field element
const fieldElement1 = new FieldElement({
  fieldName: "inspector",
  label: "Inspector name"
});

const fieldElement2 = new FieldElement({
  fieldName: "inspdate",
  label: "Inspection date",
  description: "Date inspection was handled",
  input: { // autocastable to DateTimePickerInput
    type: "datetime-picker",
      includeTime: true,
      min: 1547678342000,
      max: 1610836742000
    }
});

const fieldElement3 = new FieldElement({
  fieldName: "placename",
  label: "Business name",
  editable: false
});

const fieldElement4 = new FieldElement({
  fieldName: "floodinsur",
  label: "Flood insurance",
  input: { // autocastable to RadioButtonsInput
    type: "radio-buttons",
    noValueOptionLabel: "No value",
    showNoValueOption: true
  }
});

// Next pass in any elements to the FormTemplate
const formTemplate = new FormTemplate({
  title: "Inspector report",
  description: "Enter all relevant information below",
  elements: [fieldElement1, fieldElement2, fieldElement3, fieldElement4] // Add all elements to the template
});

Constructors

new FieldElement(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
String

The element's description providing the purpose behind it.

more details
Element
CodedValueDomain|RangeDomain

The coded value domain or range domain of the field.

more details
FieldElement
Boolean

A Boolean determining whether users can edit this form element.

more details
FieldElement
String

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.

more details
FieldElement
String

The field name as defined by the feature layer.

more details
FieldElement
String

Contains a hint used to help editors while editing fields.

more details
FieldElement
TextBoxInput|TextAreaInput|DateTimePickerInput|BarcodeScannerInput|ComboBoxInput|RadioButtonsInput|SwitchInput

The input to use for the element.

more details
FieldElement
String

A string value containing the field alias.

more details
Element
String

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.

more details
FieldElement
String

Indicates the type of form element.

more details
FieldElement
String

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.

more details
FieldElement
String

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.

more details
Element

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

description String inherited

The element's description providing the purpose behind it.

The coded value domain or range domain of the field.

editable Boolean

A Boolean determining whether users can edit this form element. If not supplied, the editable state is derived from the editable property of referenced field in the service. Superseded by editableExpression if present.

This does not change the underlying service's field and whether it can be edited.

Default Value:true
editableExpression String
Since: ArcGIS API for JavaScript 4.23

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate. The expression must follow the specification defined in the Constraint Profile. Expressions may reference field values using the $feature global input and must return either true or false.

When this expression evaluates to true, it is possible to edit the field value, and vice-versa if false. If no expression is provided, the editable behavior is defined via the editable property. If the referenced field on the feature service is not editable, the editable expression is ignored and the element is not editable.

The referenced expression must be defined in the form template's expressionInfos. It cannot be set inline within the element object.

See also
fieldName String

The field name as defined by the feature layer. Set this property to indicate which field to edit.

hint String

Contains a hint used to help editors while editing fields. Set this as a temporary placeholder for text/number inputs in either TextAreaInput or TextBoxInput.

The input to use for the element. The client application is responsible for defining the default user interface.

A string value containing the field alias. This is not to Arcade expressions as the title is used instead.

requiredExpression String

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate. The expression must follow the specification defined in the Constraint Profile. Expressions may reference field values using the $feature global input and must return either true or false.

When this expression evaluates to true and the field value is required, the element must have a valid value in order for the feature to be created or edited. When the expression evaluates to false, the element is not required. If no expression is provided, the required behavior is defined via the required property.

If the referenced field is non-nullable, the requiredExpression is ignored and the element is always required.

The referenced expression must be defined in the form template's expressionInfos. It cannot be set inline within the element object.

See also
type Stringreadonly

Indicates the type of form element. FieldElement is of type, field.

For FieldElement the type is always "field".

Example
// Create an array of elements. If the element is autocasted, the type property must be set.
elements: [{
  // autocastable as FieldElement
  type: "field",
  fieldName: "lastname",
  label: "Last name"
 },
 {
  type: "field",
  fieldName: "firstname",
  label: "First name"
 }]
valueExpression String
Since: ArcGIS API for JavaScript 4.23

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate. The expression must follow the specification defined in the Form Calculation Profile. This expression references field values within an individual feature or in other layers and must return either a date, number, or string value.

Once the expression evaluates, the form's field value updates to the expressions' result.

It is required to set the view property when instantiating a FeatureForm widget and using expressions that use the $map variable.

The referenced expression must be defined in the form template's expressionInfos. It cannot be set inline within the element object.

See also
visibilityExpression String inherited

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate. The expression must follow the specification defined by the Constraint Profile. Expressions may reference field values using the $feature profile variable and must return either true or false.

When this expression evaluates to true, the element is displayed. When the expression evaluates to false the element is not displayed. If no expression is provided, the element is always displayed. Care must be taken when defining a visibility expression for a non-nullable field i.e. to make sure that such fields either have default values or are made visible to users so that they can provide a value before submitting the form.

The referenced expression must be defined in the form template's expressionInfos. It cannot be set inline within the element object.

See also
Example
// Expression created within ExpressionInfos and is referenced in element
const expression = new ExpressionInfo({
  name: "alwaysHidden",
  expression: "false"
});

// Reference an already-defined visibilityExpression set within the ExpressionInfos
const fieldElement = new FieldElement({
  type: "field",
  fieldName: "inspemail",
  label: "Email address",
  visibilityExpression: "alwaysHidden"
});

formTemplate.expressionInfos = [ expression ];
formTemplate.elements = [ fieldElement ];

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
FieldElement

Creates a deep clone of the FieldElement class.

more details
FieldElement
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
Element
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
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
Element

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

clone(){FieldElement}

Creates a deep clone of the FieldElement class.

Returns
Type Description
FieldElement A deep clone of the FieldElement instance.
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns
Type Description
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}inherited

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.